google-cloud-data_catalog-v1 0.7.3 → 0.8.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +989 -432
- data/lib/google/cloud/data_catalog/v1/data_catalog.rb +2 -2
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +394 -133
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +1 -1
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +198 -61
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +4 -3
- data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/bigquery_pb.rb +48 -0
- data/lib/google/cloud/datacatalog/v1/data_source_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +46 -2
- data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +180 -143
- data/lib/google/cloud/datacatalog/v1/gcs_fileset_spec_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/policytagmanager_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +16 -15
- data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +7 -2
- data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +29 -15
- data/lib/google/cloud/datacatalog/v1/schema_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/search_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/table_spec_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/tags_pb.rb +5 -2
- data/lib/google/cloud/datacatalog/v1/timestamps_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/usage_pb.rb +31 -0
- data/proto_docs/google/cloud/datacatalog/v1/bigquery.rb +87 -0
- data/proto_docs/google/cloud/datacatalog/v1/common.rb +1 -2
- data/proto_docs/google/cloud/datacatalog/v1/data_source.rb +6 -5
- data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +370 -246
- data/proto_docs/google/cloud/datacatalog/v1/gcs_fileset_spec.rb +16 -15
- data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +87 -71
- data/proto_docs/google/cloud/datacatalog/v1/policytagmanagerserialization.rb +34 -19
- data/proto_docs/google/cloud/datacatalog/v1/schema.rb +3 -3
- data/proto_docs/google/cloud/datacatalog/v1/search.rb +43 -29
- data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +23 -16
- data/proto_docs/google/cloud/datacatalog/v1/tags.rb +96 -51
- data/proto_docs/google/cloud/datacatalog/v1/timestamps.rb +12 -5
- data/proto_docs/google/cloud/datacatalog/v1/usage.rb +79 -0
- metadata +8 -4
@@ -27,8 +27,8 @@ module Google
|
|
27
27
|
##
|
28
28
|
# Client for the DataCatalog service.
|
29
29
|
#
|
30
|
-
# Data Catalog API service allows
|
31
|
-
#
|
30
|
+
# Data Catalog API service allows you to discover, understand, and manage
|
31
|
+
# your data.
|
32
32
|
#
|
33
33
|
class Client
|
34
34
|
include Paths
|
@@ -42,13 +42,12 @@ module Google
|
|
42
42
|
# See {::Google::Cloud::DataCatalog::V1::DataCatalog::Client::Configuration}
|
43
43
|
# for a description of the configuration fields.
|
44
44
|
#
|
45
|
-
#
|
45
|
+
# @example
|
46
46
|
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
# end
|
47
|
+
# # Modify the configuration for all DataCatalog clients
|
48
|
+
# ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
|
49
|
+
# config.timeout = 10.0
|
50
|
+
# end
|
52
51
|
#
|
53
52
|
# @yield [config] Configure the Client client.
|
54
53
|
# @yieldparam config [Client::Configuration]
|
@@ -137,19 +136,15 @@ module Google
|
|
137
136
|
##
|
138
137
|
# Create a new DataCatalog client object.
|
139
138
|
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
# To create a new DataCatalog client with the default
|
143
|
-
# configuration:
|
144
|
-
#
|
145
|
-
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
139
|
+
# @example
|
146
140
|
#
|
147
|
-
#
|
148
|
-
#
|
141
|
+
# # Create a client using the default configuration
|
142
|
+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
149
143
|
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
144
|
+
# # Create a client using a custom configuration
|
145
|
+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
|
146
|
+
# config.timeout = 10.0
|
147
|
+
# end
|
153
148
|
#
|
154
149
|
# @yield [config] Configure the DataCatalog client.
|
155
150
|
# @yieldparam config [Client::Configuration]
|
@@ -169,10 +164,9 @@ module Google
|
|
169
164
|
|
170
165
|
# Create credentials
|
171
166
|
credentials = @config.credentials
|
172
|
-
# Use self-signed JWT if the
|
167
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
173
168
|
# but only if the default endpoint does not have a region prefix.
|
174
|
-
enable_self_signed_jwt = @config.
|
175
|
-
@config.endpoint == Client.configure.endpoint &&
|
169
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
176
170
|
!@config.endpoint.split(".").first.include?("-")
|
177
171
|
credentials ||= Credentials.default scope: @config.scope,
|
178
172
|
enable_self_signed_jwt: enable_self_signed_jwt
|
@@ -194,22 +188,21 @@ module Google
|
|
194
188
|
# Service calls
|
195
189
|
|
196
190
|
##
|
197
|
-
# Searches Data Catalog for multiple resources like entries
|
191
|
+
# Searches Data Catalog for multiple resources like entries and tags that
|
198
192
|
# match a query.
|
199
193
|
#
|
200
|
-
# This is a
|
201
|
-
# (https://cloud.google.com/apis/design/custom_methods)
|
202
|
-
#
|
203
|
-
#
|
194
|
+
# This is a [Custom Method]
|
195
|
+
# (https://cloud.google.com/apis/design/custom_methods) that doesn't return
|
196
|
+
# all information on a resource, only its ID and high level fields. To get
|
197
|
+
# more information, you can subsequently call specific get methods.
|
204
198
|
#
|
205
|
-
# Note
|
206
|
-
#
|
207
|
-
# result pages.
|
208
|
-
#
|
199
|
+
# Note: Data Catalog search queries don't guarantee full recall. Results
|
200
|
+
# that match your query might not be returned, even in subsequent
|
201
|
+
# result pages. Additionally, returned (and not returned) results can vary
|
202
|
+
# if you repeat search queries.
|
209
203
|
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
# for more information.
|
204
|
+
# For more information, see [Data Catalog search syntax]
|
205
|
+
# (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
|
213
206
|
#
|
214
207
|
# @overload search_catalog(request, options = nil)
|
215
208
|
# Pass arguments to `search_catalog` via a request object, either of type
|
@@ -227,43 +220,47 @@ module Google
|
|
227
220
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
228
221
|
#
|
229
222
|
# @param scope [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, ::Hash]
|
230
|
-
# Required. The scope of this search request.
|
231
|
-
#
|
232
|
-
# `
|
233
|
-
#
|
223
|
+
# Required. The scope of this search request.
|
224
|
+
#
|
225
|
+
# The `scope` is invalid if `include_org_ids`, `include_project_ids` are
|
226
|
+
# empty AND `include_gcp_public_datasets` is set to `false`. In this case,
|
227
|
+
# the request returns an error.
|
234
228
|
# @param query [::String]
|
235
|
-
# Optional. The query string
|
236
|
-
#
|
229
|
+
# Optional. The query string with a minimum of 3 characters and specific syntax.
|
230
|
+
# For more information, see
|
231
|
+
# [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
|
237
232
|
#
|
238
|
-
#
|
233
|
+
# An empty query string returns all data assets (in the specified scope)
|
234
|
+
# that you have access to.
|
239
235
|
#
|
240
|
-
#
|
241
|
-
# * column:x
|
242
|
-
# * description:y
|
236
|
+
# A query string can be a simple `xyz` or qualified by predicates:
|
243
237
|
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
# for more information.
|
238
|
+
# * `name:x`
|
239
|
+
# * `column:y`
|
240
|
+
# * `description:z`
|
248
241
|
# @param page_size [::Integer]
|
249
|
-
# Number of results in
|
250
|
-
#
|
242
|
+
# Number of results to return in a single search page.
|
243
|
+
#
|
244
|
+
# Can't be negative or 0, defaults to 10 in this case.
|
245
|
+
# The maximum number is 1000. If exceeded, throws an "invalid argument"
|
246
|
+
# exception.
|
251
247
|
# @param page_token [::String]
|
252
|
-
# Optional. Pagination token
|
253
|
-
#
|
254
|
-
#
|
248
|
+
# Optional. Pagination token that, if specified, returns the next page of search
|
249
|
+
# results. If empty, returns the first page.
|
250
|
+
#
|
251
|
+
# This token is returned in the {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}
|
252
|
+
# field of the response to a previous
|
255
253
|
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
|
256
|
-
# call
|
257
|
-
# the first page is returned.
|
254
|
+
# call.
|
258
255
|
# @param order_by [::String]
|
259
|
-
# Specifies the
|
260
|
-
#
|
256
|
+
# Specifies the order of results.
|
257
|
+
#
|
258
|
+
# Currently supported case-sensitive values are:
|
261
259
|
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
# specified
|
260
|
+
# * `relevance` that can only be descending
|
261
|
+
# * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
|
265
262
|
#
|
266
|
-
# If
|
263
|
+
# If this parameter is omitted, it defaults to the descending `relevance`.
|
267
264
|
#
|
268
265
|
# @yield [response, operation] Access the result along with the RPC operation
|
269
266
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
|
@@ -273,6 +270,27 @@ module Google
|
|
273
270
|
#
|
274
271
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
275
272
|
#
|
273
|
+
# @example Basic example
|
274
|
+
# require "google/cloud/data_catalog/v1"
|
275
|
+
#
|
276
|
+
# # Create a client object. The client can be reused for multiple calls.
|
277
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
278
|
+
#
|
279
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
280
|
+
# request = Google::Cloud::DataCatalog::V1::SearchCatalogRequest.new
|
281
|
+
#
|
282
|
+
# # Call the search_catalog method.
|
283
|
+
# result = client.search_catalog request
|
284
|
+
#
|
285
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
286
|
+
# # iterate over all elements by calling #each, and the enumerable
|
287
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
288
|
+
# # methods are also available for managing paging directly.
|
289
|
+
# result.each do |response|
|
290
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::V1::SearchCatalogResult.
|
291
|
+
# p response
|
292
|
+
# end
|
293
|
+
#
|
276
294
|
def search_catalog request, options = nil
|
277
295
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
278
296
|
|
@@ -293,7 +311,9 @@ module Google
|
|
293
311
|
options.apply_defaults timeout: @config.rpcs.search_catalog.timeout,
|
294
312
|
metadata: metadata,
|
295
313
|
retry_policy: @config.rpcs.search_catalog.retry_policy
|
296
|
-
|
314
|
+
|
315
|
+
options.apply_defaults timeout: @config.timeout,
|
316
|
+
metadata: @config.metadata,
|
297
317
|
retry_policy: @config.retry_policy
|
298
318
|
|
299
319
|
@data_catalog_stub.call_rpc :search_catalog, request, options: options do |response, operation|
|
@@ -306,25 +326,33 @@ module Google
|
|
306
326
|
end
|
307
327
|
|
308
328
|
##
|
309
|
-
# Creates an
|
329
|
+
# Creates an entry group.
|
330
|
+
#
|
331
|
+
# An entry group contains logically related entries together with [Cloud
|
332
|
+
# Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
|
333
|
+
# These policies specify users who can create, edit, and view entries
|
334
|
+
# within entry groups.
|
335
|
+
#
|
336
|
+
# Data Catalog automatically creates entry groups with names that start with
|
337
|
+
# the `@` symbol for the following resources:
|
310
338
|
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
339
|
+
# * BigQuery entries (`@bigquery`)
|
340
|
+
# * Pub/Sub topics (`@pubsub`)
|
341
|
+
# * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
|
314
342
|
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
343
|
+
# You can create your own entry groups for Cloud Storage fileset entries
|
344
|
+
# and custom entries together with the corresponding IAM policies.
|
345
|
+
# User-created entry groups can't contain the `@` symbol, it is reserved
|
346
|
+
# for automatically created groups.
|
347
|
+
#
|
348
|
+
# Entry groups, like entries, can be searched.
|
320
349
|
#
|
321
350
|
# A maximum of 10,000 entry groups may be created per organization across all
|
322
351
|
# locations.
|
323
352
|
#
|
324
|
-
#
|
325
|
-
# the `parent` parameter
|
326
|
-
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project)
|
327
|
-
# more information).
|
353
|
+
# You must enable the Data Catalog API in the project identified by
|
354
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
355
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
328
356
|
#
|
329
357
|
# @overload create_entry_group(request, options = nil)
|
330
358
|
# Pass arguments to `create_entry_group` via a request object, either of type
|
@@ -342,9 +370,7 @@ module Google
|
|
342
370
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
343
371
|
#
|
344
372
|
# @param parent [::String]
|
345
|
-
# Required. The
|
346
|
-
#
|
347
|
-
# `projects/{project_id}/locations/{location}`
|
373
|
+
# Required. The names of the project and location that the new entry group belongs to.
|
348
374
|
#
|
349
375
|
# Note: The entry group itself and its child resources might not be
|
350
376
|
# stored in the location specified in its name.
|
@@ -355,7 +381,7 @@ module Google
|
|
355
381
|
# underscores (_), and must start with a letter or underscore.
|
356
382
|
# The maximum size is 64 bytes when encoded in UTF-8.
|
357
383
|
# @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
|
358
|
-
# The entry group to create. Defaults to
|
384
|
+
# The entry group to create. Defaults to empty.
|
359
385
|
#
|
360
386
|
# @yield [response, operation] Access the result along with the RPC operation
|
361
387
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
@@ -365,6 +391,21 @@ module Google
|
|
365
391
|
#
|
366
392
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
367
393
|
#
|
394
|
+
# @example Basic example
|
395
|
+
# require "google/cloud/data_catalog/v1"
|
396
|
+
#
|
397
|
+
# # Create a client object. The client can be reused for multiple calls.
|
398
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
399
|
+
#
|
400
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
401
|
+
# request = Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest.new
|
402
|
+
#
|
403
|
+
# # Call the create_entry_group method.
|
404
|
+
# result = client.create_entry_group request
|
405
|
+
#
|
406
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
|
407
|
+
# p result
|
408
|
+
#
|
368
409
|
def create_entry_group request, options = nil
|
369
410
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
370
411
|
|
@@ -382,16 +423,20 @@ module Google
|
|
382
423
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
383
424
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
384
425
|
|
385
|
-
header_params = {
|
386
|
-
|
387
|
-
|
426
|
+
header_params = {}
|
427
|
+
if request.parent
|
428
|
+
header_params["parent"] = request.parent
|
429
|
+
end
|
430
|
+
|
388
431
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
389
432
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
390
433
|
|
391
434
|
options.apply_defaults timeout: @config.rpcs.create_entry_group.timeout,
|
392
435
|
metadata: metadata,
|
393
436
|
retry_policy: @config.rpcs.create_entry_group.retry_policy
|
394
|
-
|
437
|
+
|
438
|
+
options.apply_defaults timeout: @config.timeout,
|
439
|
+
metadata: @config.metadata,
|
395
440
|
retry_policy: @config.retry_policy
|
396
441
|
|
397
442
|
@data_catalog_stub.call_rpc :create_entry_group, request, options: options do |response, operation|
|
@@ -403,7 +448,7 @@ module Google
|
|
403
448
|
end
|
404
449
|
|
405
450
|
##
|
406
|
-
# Gets an
|
451
|
+
# Gets an entry group.
|
407
452
|
#
|
408
453
|
# @overload get_entry_group(request, options = nil)
|
409
454
|
# Pass arguments to `get_entry_group` via a request object, either of type
|
@@ -421,10 +466,9 @@ module Google
|
|
421
466
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
422
467
|
#
|
423
468
|
# @param name [::String]
|
424
|
-
# Required. The name of the entry group
|
425
|
-
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
469
|
+
# Required. The name of the entry group to get.
|
426
470
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
427
|
-
# The fields to return. If
|
471
|
+
# The fields to return. If empty or omitted, all fields are returned.
|
428
472
|
#
|
429
473
|
# @yield [response, operation] Access the result along with the RPC operation
|
430
474
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
@@ -434,6 +478,21 @@ module Google
|
|
434
478
|
#
|
435
479
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
436
480
|
#
|
481
|
+
# @example Basic example
|
482
|
+
# require "google/cloud/data_catalog/v1"
|
483
|
+
#
|
484
|
+
# # Create a client object. The client can be reused for multiple calls.
|
485
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
486
|
+
#
|
487
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
488
|
+
# request = Google::Cloud::DataCatalog::V1::GetEntryGroupRequest.new
|
489
|
+
#
|
490
|
+
# # Call the get_entry_group method.
|
491
|
+
# result = client.get_entry_group request
|
492
|
+
#
|
493
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
|
494
|
+
# p result
|
495
|
+
#
|
437
496
|
def get_entry_group request, options = nil
|
438
497
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
439
498
|
|
@@ -451,16 +510,20 @@ module Google
|
|
451
510
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
452
511
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
453
512
|
|
454
|
-
header_params = {
|
455
|
-
|
456
|
-
|
513
|
+
header_params = {}
|
514
|
+
if request.name
|
515
|
+
header_params["name"] = request.name
|
516
|
+
end
|
517
|
+
|
457
518
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
458
519
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
459
520
|
|
460
521
|
options.apply_defaults timeout: @config.rpcs.get_entry_group.timeout,
|
461
522
|
metadata: metadata,
|
462
523
|
retry_policy: @config.rpcs.get_entry_group.retry_policy
|
463
|
-
|
524
|
+
|
525
|
+
options.apply_defaults timeout: @config.timeout,
|
526
|
+
metadata: @config.metadata,
|
464
527
|
retry_policy: @config.retry_policy
|
465
528
|
|
466
529
|
@data_catalog_stub.call_rpc :get_entry_group, request, options: options do |response, operation|
|
@@ -472,11 +535,12 @@ module Google
|
|
472
535
|
end
|
473
536
|
|
474
537
|
##
|
475
|
-
# Updates an
|
476
|
-
#
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
538
|
+
# Updates an entry group.
|
539
|
+
#
|
540
|
+
# You must enable the Data Catalog API in the project identified by
|
541
|
+
# the `entry_group.name` parameter. For more information, see [Data Catalog
|
542
|
+
# resource
|
543
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
480
544
|
#
|
481
545
|
# @overload update_entry_group(request, options = nil)
|
482
546
|
# Pass arguments to `update_entry_group` via a request object, either of type
|
@@ -494,7 +558,7 @@ module Google
|
|
494
558
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
495
559
|
#
|
496
560
|
# @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
|
497
|
-
# Required.
|
561
|
+
# Required. Updates for the entry group. The `name` field must be set.
|
498
562
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
499
563
|
# Names of fields whose values to overwrite on an entry group.
|
500
564
|
#
|
@@ -510,6 +574,21 @@ module Google
|
|
510
574
|
#
|
511
575
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
512
576
|
#
|
577
|
+
# @example Basic example
|
578
|
+
# require "google/cloud/data_catalog/v1"
|
579
|
+
#
|
580
|
+
# # Create a client object. The client can be reused for multiple calls.
|
581
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
582
|
+
#
|
583
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
584
|
+
# request = Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest.new
|
585
|
+
#
|
586
|
+
# # Call the update_entry_group method.
|
587
|
+
# result = client.update_entry_group request
|
588
|
+
#
|
589
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
|
590
|
+
# p result
|
591
|
+
#
|
513
592
|
def update_entry_group request, options = nil
|
514
593
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
515
594
|
|
@@ -527,16 +606,20 @@ module Google
|
|
527
606
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
528
607
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
529
608
|
|
530
|
-
header_params = {
|
531
|
-
|
532
|
-
|
609
|
+
header_params = {}
|
610
|
+
if request.entry_group&.name
|
611
|
+
header_params["entry_group.name"] = request.entry_group.name
|
612
|
+
end
|
613
|
+
|
533
614
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
534
615
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
535
616
|
|
536
617
|
options.apply_defaults timeout: @config.rpcs.update_entry_group.timeout,
|
537
618
|
metadata: metadata,
|
538
619
|
retry_policy: @config.rpcs.update_entry_group.retry_policy
|
539
|
-
|
620
|
+
|
621
|
+
options.apply_defaults timeout: @config.timeout,
|
622
|
+
metadata: @config.metadata,
|
540
623
|
retry_policy: @config.retry_policy
|
541
624
|
|
542
625
|
@data_catalog_stub.call_rpc :update_entry_group, request, options: options do |response, operation|
|
@@ -548,11 +631,12 @@ module Google
|
|
548
631
|
end
|
549
632
|
|
550
633
|
##
|
551
|
-
# Deletes an
|
552
|
-
#
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
634
|
+
# Deletes an entry group.
|
635
|
+
#
|
636
|
+
# You must enable the Data Catalog API in the project
|
637
|
+
# identified by the `name` parameter. For more information, see [Data Catalog
|
638
|
+
# resource
|
639
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
556
640
|
#
|
557
641
|
# @overload delete_entry_group(request, options = nil)
|
558
642
|
# Pass arguments to `delete_entry_group` via a request object, either of type
|
@@ -570,8 +654,7 @@ module Google
|
|
570
654
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
571
655
|
#
|
572
656
|
# @param name [::String]
|
573
|
-
# Required. The name of the entry group
|
574
|
-
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
657
|
+
# Required. The name of the entry group to delete.
|
575
658
|
# @param force [::Boolean]
|
576
659
|
# Optional. If true, deletes all entries in the entry group.
|
577
660
|
#
|
@@ -583,6 +666,21 @@ module Google
|
|
583
666
|
#
|
584
667
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
585
668
|
#
|
669
|
+
# @example Basic example
|
670
|
+
# require "google/cloud/data_catalog/v1"
|
671
|
+
#
|
672
|
+
# # Create a client object. The client can be reused for multiple calls.
|
673
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
674
|
+
#
|
675
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
676
|
+
# request = Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest.new
|
677
|
+
#
|
678
|
+
# # Call the delete_entry_group method.
|
679
|
+
# result = client.delete_entry_group request
|
680
|
+
#
|
681
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
682
|
+
# p result
|
683
|
+
#
|
586
684
|
def delete_entry_group request, options = nil
|
587
685
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
588
686
|
|
@@ -600,16 +698,20 @@ module Google
|
|
600
698
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
601
699
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
602
700
|
|
603
|
-
header_params = {
|
604
|
-
|
605
|
-
|
701
|
+
header_params = {}
|
702
|
+
if request.name
|
703
|
+
header_params["name"] = request.name
|
704
|
+
end
|
705
|
+
|
606
706
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
607
707
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
608
708
|
|
609
709
|
options.apply_defaults timeout: @config.rpcs.delete_entry_group.timeout,
|
610
710
|
metadata: metadata,
|
611
711
|
retry_policy: @config.rpcs.delete_entry_group.retry_policy
|
612
|
-
|
712
|
+
|
713
|
+
options.apply_defaults timeout: @config.timeout,
|
714
|
+
metadata: @config.metadata,
|
613
715
|
retry_policy: @config.retry_policy
|
614
716
|
|
615
717
|
@data_catalog_stub.call_rpc :delete_entry_group, request, options: options do |response, operation|
|
@@ -639,16 +741,17 @@ module Google
|
|
639
741
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
640
742
|
#
|
641
743
|
# @param parent [::String]
|
642
|
-
# Required. The name of the location that contains the entry groups
|
643
|
-
# provided in URL format. Example:
|
744
|
+
# Required. The name of the location that contains the entry groups to list.
|
644
745
|
#
|
645
|
-
#
|
746
|
+
# Can be provided as a URL.
|
646
747
|
# @param page_size [::Integer]
|
647
|
-
# Optional. The maximum number of items to return.
|
648
|
-
#
|
748
|
+
# Optional. The maximum number of items to return.
|
749
|
+
#
|
750
|
+
# Default is 10. Maximum limit is 1000.
|
751
|
+
# Throws an invalid argument if `page_size` is greater than 1000.
|
649
752
|
# @param page_token [::String]
|
650
|
-
# Optional.
|
651
|
-
#
|
753
|
+
# Optional. Pagination token that specifies the next page to return.
|
754
|
+
# If empty, returns the first page.
|
652
755
|
#
|
653
756
|
# @yield [response, operation] Access the result along with the RPC operation
|
654
757
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
|
@@ -658,6 +761,27 @@ module Google
|
|
658
761
|
#
|
659
762
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
660
763
|
#
|
764
|
+
# @example Basic example
|
765
|
+
# require "google/cloud/data_catalog/v1"
|
766
|
+
#
|
767
|
+
# # Create a client object. The client can be reused for multiple calls.
|
768
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
769
|
+
#
|
770
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
771
|
+
# request = Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest.new
|
772
|
+
#
|
773
|
+
# # Call the list_entry_groups method.
|
774
|
+
# result = client.list_entry_groups request
|
775
|
+
#
|
776
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
777
|
+
# # iterate over all elements by calling #each, and the enumerable
|
778
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
779
|
+
# # methods are also available for managing paging directly.
|
780
|
+
# result.each do |response|
|
781
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::V1::EntryGroup.
|
782
|
+
# p response
|
783
|
+
# end
|
784
|
+
#
|
661
785
|
def list_entry_groups request, options = nil
|
662
786
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
663
787
|
|
@@ -675,16 +799,20 @@ module Google
|
|
675
799
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
676
800
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
677
801
|
|
678
|
-
header_params = {
|
679
|
-
|
680
|
-
|
802
|
+
header_params = {}
|
803
|
+
if request.parent
|
804
|
+
header_params["parent"] = request.parent
|
805
|
+
end
|
806
|
+
|
681
807
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
682
808
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
683
809
|
|
684
810
|
options.apply_defaults timeout: @config.rpcs.list_entry_groups.timeout,
|
685
811
|
metadata: metadata,
|
686
812
|
retry_policy: @config.rpcs.list_entry_groups.retry_policy
|
687
|
-
|
813
|
+
|
814
|
+
options.apply_defaults timeout: @config.timeout,
|
815
|
+
metadata: @config.metadata,
|
688
816
|
retry_policy: @config.retry_policy
|
689
817
|
|
690
818
|
@data_catalog_stub.call_rpc :list_entry_groups, request, options: options do |response, operation|
|
@@ -697,15 +825,17 @@ module Google
|
|
697
825
|
end
|
698
826
|
|
699
827
|
##
|
700
|
-
# Creates an entry.
|
701
|
-
# or with a user-specified type can be created.
|
828
|
+
# Creates an entry.
|
702
829
|
#
|
703
|
-
#
|
704
|
-
#
|
705
|
-
#
|
706
|
-
# more information).
|
830
|
+
# You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
|
831
|
+
# or custom types. Data Catalog automatically creates entries with other
|
832
|
+
# types during metadata ingestion from integrated systems.
|
707
833
|
#
|
708
|
-
#
|
834
|
+
# You must enable the Data Catalog API in the project identified by
|
835
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
836
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
837
|
+
#
|
838
|
+
# An entry group can have a maximum of 100,000 entries.
|
709
839
|
#
|
710
840
|
# @overload create_entry(request, options = nil)
|
711
841
|
# Pass arguments to `create_entry` via a request object, either of type
|
@@ -723,9 +853,7 @@ module Google
|
|
723
853
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
724
854
|
#
|
725
855
|
# @param parent [::String]
|
726
|
-
# Required. The name of the entry group this entry belongs to.
|
727
|
-
#
|
728
|
-
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`
|
856
|
+
# Required. The name of the entry group this entry belongs to.
|
729
857
|
#
|
730
858
|
# Note: The entry itself and its child resources might not be stored in
|
731
859
|
# the location specified in its name.
|
@@ -746,6 +874,21 @@ module Google
|
|
746
874
|
#
|
747
875
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
748
876
|
#
|
877
|
+
# @example Basic example
|
878
|
+
# require "google/cloud/data_catalog/v1"
|
879
|
+
#
|
880
|
+
# # Create a client object. The client can be reused for multiple calls.
|
881
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
882
|
+
#
|
883
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
884
|
+
# request = Google::Cloud::DataCatalog::V1::CreateEntryRequest.new
|
885
|
+
#
|
886
|
+
# # Call the create_entry method.
|
887
|
+
# result = client.create_entry request
|
888
|
+
#
|
889
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
|
890
|
+
# p result
|
891
|
+
#
|
749
892
|
def create_entry request, options = nil
|
750
893
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
751
894
|
|
@@ -763,16 +906,20 @@ module Google
|
|
763
906
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
764
907
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
765
908
|
|
766
|
-
header_params = {
|
767
|
-
|
768
|
-
|
909
|
+
header_params = {}
|
910
|
+
if request.parent
|
911
|
+
header_params["parent"] = request.parent
|
912
|
+
end
|
913
|
+
|
769
914
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
770
915
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
771
916
|
|
772
917
|
options.apply_defaults timeout: @config.rpcs.create_entry.timeout,
|
773
918
|
metadata: metadata,
|
774
919
|
retry_policy: @config.rpcs.create_entry.retry_policy
|
775
|
-
|
920
|
+
|
921
|
+
options.apply_defaults timeout: @config.timeout,
|
922
|
+
metadata: @config.metadata,
|
776
923
|
retry_policy: @config.retry_policy
|
777
924
|
|
778
925
|
@data_catalog_stub.call_rpc :create_entry, request, options: options do |response, operation|
|
@@ -785,10 +932,11 @@ module Google
|
|
785
932
|
|
786
933
|
##
|
787
934
|
# Updates an existing entry.
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
935
|
+
#
|
936
|
+
# You must enable the Data Catalog API in the project identified by
|
937
|
+
# the `entry.name` parameter. For more information, see [Data Catalog
|
938
|
+
# resource
|
939
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
792
940
|
#
|
793
941
|
# @overload update_entry(request, options = nil)
|
794
942
|
# Pass arguments to `update_entry` via a request object, either of type
|
@@ -806,7 +954,7 @@ module Google
|
|
806
954
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
807
955
|
#
|
808
956
|
# @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
|
809
|
-
# Required.
|
957
|
+
# Required. Updates for the entry. The `name` field must be set.
|
810
958
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
811
959
|
# Names of fields whose values to overwrite on an entry.
|
812
960
|
#
|
@@ -814,24 +962,29 @@ module Google
|
|
814
962
|
# are overwritten. If such fields are non-required and omitted in the
|
815
963
|
# request body, their values are emptied.
|
816
964
|
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
821
|
-
# *
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
# *
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
965
|
+
# You can modify only the fields listed below.
|
966
|
+
#
|
967
|
+
# For entries with type `DATA_STREAM`:
|
968
|
+
#
|
969
|
+
# * `schema`
|
970
|
+
#
|
971
|
+
# For entries with type `FILESET`:
|
972
|
+
#
|
973
|
+
# * `schema`
|
974
|
+
# * `display_name`
|
975
|
+
# * `description`
|
976
|
+
# * `gcs_fileset_spec`
|
977
|
+
# * `gcs_fileset_spec.file_patterns`
|
978
|
+
#
|
979
|
+
# For entries with `user_specified_type`:
|
980
|
+
#
|
981
|
+
# * `schema`
|
982
|
+
# * `display_name`
|
983
|
+
# * `description`
|
984
|
+
# * `user_specified_type`
|
985
|
+
# * `user_specified_system`
|
986
|
+
# * `linked_resource`
|
987
|
+
# * `source_system_timestamps`
|
835
988
|
#
|
836
989
|
# @yield [response, operation] Access the result along with the RPC operation
|
837
990
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
|
@@ -841,6 +994,21 @@ module Google
|
|
841
994
|
#
|
842
995
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
843
996
|
#
|
997
|
+
# @example Basic example
|
998
|
+
# require "google/cloud/data_catalog/v1"
|
999
|
+
#
|
1000
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1001
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1002
|
+
#
|
1003
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1004
|
+
# request = Google::Cloud::DataCatalog::V1::UpdateEntryRequest.new
|
1005
|
+
#
|
1006
|
+
# # Call the update_entry method.
|
1007
|
+
# result = client.update_entry request
|
1008
|
+
#
|
1009
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
|
1010
|
+
# p result
|
1011
|
+
#
|
844
1012
|
def update_entry request, options = nil
|
845
1013
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
846
1014
|
|
@@ -858,16 +1026,20 @@ module Google
|
|
858
1026
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
859
1027
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
860
1028
|
|
861
|
-
header_params = {
|
862
|
-
|
863
|
-
|
1029
|
+
header_params = {}
|
1030
|
+
if request.entry&.name
|
1031
|
+
header_params["entry.name"] = request.entry.name
|
1032
|
+
end
|
1033
|
+
|
864
1034
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
865
1035
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
866
1036
|
|
867
1037
|
options.apply_defaults timeout: @config.rpcs.update_entry.timeout,
|
868
1038
|
metadata: metadata,
|
869
1039
|
retry_policy: @config.rpcs.update_entry.retry_policy
|
870
|
-
|
1040
|
+
|
1041
|
+
options.apply_defaults timeout: @config.timeout,
|
1042
|
+
metadata: @config.metadata,
|
871
1043
|
retry_policy: @config.retry_policy
|
872
1044
|
|
873
1045
|
@data_catalog_stub.call_rpc :update_entry, request, options: options do |response, operation|
|
@@ -879,13 +1051,16 @@ module Google
|
|
879
1051
|
end
|
880
1052
|
|
881
1053
|
##
|
882
|
-
# Deletes an existing entry.
|
1054
|
+
# Deletes an existing entry.
|
1055
|
+
#
|
1056
|
+
# You can delete only the entries created by the
|
883
1057
|
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}
|
884
|
-
# method
|
885
|
-
#
|
886
|
-
#
|
887
|
-
#
|
888
|
-
#
|
1058
|
+
# method.
|
1059
|
+
#
|
1060
|
+
# You must enable the Data Catalog API in the project identified by
|
1061
|
+
# the `name` parameter. For more information, see [Data Catalog
|
1062
|
+
# resource
|
1063
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
889
1064
|
#
|
890
1065
|
# @overload delete_entry(request, options = nil)
|
891
1066
|
# Pass arguments to `delete_entry` via a request object, either of type
|
@@ -903,9 +1078,7 @@ module Google
|
|
903
1078
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
904
1079
|
#
|
905
1080
|
# @param name [::String]
|
906
|
-
# Required. The name of the entry.
|
907
|
-
#
|
908
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
1081
|
+
# Required. The name of the entry to delete.
|
909
1082
|
#
|
910
1083
|
# @yield [response, operation] Access the result along with the RPC operation
|
911
1084
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -915,6 +1088,21 @@ module Google
|
|
915
1088
|
#
|
916
1089
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
917
1090
|
#
|
1091
|
+
# @example Basic example
|
1092
|
+
# require "google/cloud/data_catalog/v1"
|
1093
|
+
#
|
1094
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1095
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1096
|
+
#
|
1097
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1098
|
+
# request = Google::Cloud::DataCatalog::V1::DeleteEntryRequest.new
|
1099
|
+
#
|
1100
|
+
# # Call the delete_entry method.
|
1101
|
+
# result = client.delete_entry request
|
1102
|
+
#
|
1103
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1104
|
+
# p result
|
1105
|
+
#
|
918
1106
|
def delete_entry request, options = nil
|
919
1107
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
920
1108
|
|
@@ -932,16 +1120,20 @@ module Google
|
|
932
1120
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
933
1121
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
934
1122
|
|
935
|
-
header_params = {
|
936
|
-
|
937
|
-
|
1123
|
+
header_params = {}
|
1124
|
+
if request.name
|
1125
|
+
header_params["name"] = request.name
|
1126
|
+
end
|
1127
|
+
|
938
1128
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
939
1129
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
940
1130
|
|
941
1131
|
options.apply_defaults timeout: @config.rpcs.delete_entry.timeout,
|
942
1132
|
metadata: metadata,
|
943
1133
|
retry_policy: @config.rpcs.delete_entry.retry_policy
|
944
|
-
|
1134
|
+
|
1135
|
+
options.apply_defaults timeout: @config.timeout,
|
1136
|
+
metadata: @config.metadata,
|
945
1137
|
retry_policy: @config.retry_policy
|
946
1138
|
|
947
1139
|
@data_catalog_stub.call_rpc :delete_entry, request, options: options do |response, operation|
|
@@ -971,9 +1163,7 @@ module Google
|
|
971
1163
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
972
1164
|
#
|
973
1165
|
# @param name [::String]
|
974
|
-
# Required. The name of the entry.
|
975
|
-
#
|
976
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
1166
|
+
# Required. The name of the entry to get.
|
977
1167
|
#
|
978
1168
|
# @yield [response, operation] Access the result along with the RPC operation
|
979
1169
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
|
@@ -983,6 +1173,21 @@ module Google
|
|
983
1173
|
#
|
984
1174
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
985
1175
|
#
|
1176
|
+
# @example Basic example
|
1177
|
+
# require "google/cloud/data_catalog/v1"
|
1178
|
+
#
|
1179
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1180
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1181
|
+
#
|
1182
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1183
|
+
# request = Google::Cloud::DataCatalog::V1::GetEntryRequest.new
|
1184
|
+
#
|
1185
|
+
# # Call the get_entry method.
|
1186
|
+
# result = client.get_entry request
|
1187
|
+
#
|
1188
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
|
1189
|
+
# p result
|
1190
|
+
#
|
986
1191
|
def get_entry request, options = nil
|
987
1192
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
988
1193
|
|
@@ -1000,16 +1205,20 @@ module Google
|
|
1000
1205
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1001
1206
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1002
1207
|
|
1003
|
-
header_params = {
|
1004
|
-
|
1005
|
-
|
1208
|
+
header_params = {}
|
1209
|
+
if request.name
|
1210
|
+
header_params["name"] = request.name
|
1211
|
+
end
|
1212
|
+
|
1006
1213
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1007
1214
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1008
1215
|
|
1009
1216
|
options.apply_defaults timeout: @config.rpcs.get_entry.timeout,
|
1010
1217
|
metadata: metadata,
|
1011
1218
|
retry_policy: @config.rpcs.get_entry.retry_policy
|
1012
|
-
|
1219
|
+
|
1220
|
+
options.apply_defaults timeout: @config.timeout,
|
1221
|
+
metadata: @config.metadata,
|
1013
1222
|
retry_policy: @config.retry_policy
|
1014
1223
|
|
1015
1224
|
@data_catalog_stub.call_rpc :get_entry, request, options: options do |response, operation|
|
@@ -1021,9 +1230,9 @@ module Google
|
|
1021
1230
|
end
|
1022
1231
|
|
1023
1232
|
##
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
#
|
1233
|
+
# Gets an entry by its target resource name.
|
1234
|
+
#
|
1235
|
+
# The resource name comes from the source Google Cloud Platform service.
|
1027
1236
|
#
|
1028
1237
|
# @overload lookup_entry(request, options = nil)
|
1029
1238
|
# Pass arguments to `lookup_entry` via a request object, either of type
|
@@ -1042,27 +1251,27 @@ module Google
|
|
1042
1251
|
#
|
1043
1252
|
# @param linked_resource [::String]
|
1044
1253
|
# The full name of the Google Cloud Platform resource the Data Catalog
|
1045
|
-
# entry represents.
|
1046
|
-
# https://cloud.google.com/apis/design/resource_names#full_resource_name.
|
1047
|
-
# Full names are case-sensitive.
|
1254
|
+
# entry represents. For more information, see [Full Resource Name]
|
1255
|
+
# (https://cloud.google.com/apis/design/resource_names#full_resource_name).
|
1048
1256
|
#
|
1049
|
-
#
|
1257
|
+
# Full names are case-sensitive. For example:
|
1050
1258
|
#
|
1051
|
-
# *
|
1052
|
-
# *
|
1259
|
+
# * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
|
1260
|
+
# * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
|
1053
1261
|
# @param sql_resource [::String]
|
1054
1262
|
# The SQL name of the entry. SQL names are case-sensitive.
|
1055
1263
|
#
|
1056
1264
|
# Examples:
|
1057
1265
|
#
|
1058
|
-
#
|
1059
|
-
#
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
#
|
1266
|
+
# * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
|
1267
|
+
# * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
|
1268
|
+
# * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
|
1269
|
+
# * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
|
1270
|
+
# * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
|
1063
1271
|
#
|
1064
|
-
# `*
|
1065
|
-
#
|
1272
|
+
# Identifiers (`*_ID`) should comply with the
|
1273
|
+
# [Lexical structure in Standard SQL]
|
1274
|
+
# (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
|
1066
1275
|
# @param fully_qualified_name [::String]
|
1067
1276
|
# Fully qualified name (FQN) of the resource.
|
1068
1277
|
#
|
@@ -1078,7 +1287,7 @@ module Google
|
|
1078
1287
|
#
|
1079
1288
|
# Example for a DPMS table:
|
1080
1289
|
#
|
1081
|
-
# `dataproc_metastore:
|
1290
|
+
# `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
|
1082
1291
|
#
|
1083
1292
|
# @yield [response, operation] Access the result along with the RPC operation
|
1084
1293
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
|
@@ -1088,6 +1297,21 @@ module Google
|
|
1088
1297
|
#
|
1089
1298
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1090
1299
|
#
|
1300
|
+
# @example Basic example
|
1301
|
+
# require "google/cloud/data_catalog/v1"
|
1302
|
+
#
|
1303
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1304
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1305
|
+
#
|
1306
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1307
|
+
# request = Google::Cloud::DataCatalog::V1::LookupEntryRequest.new
|
1308
|
+
#
|
1309
|
+
# # Call the lookup_entry method.
|
1310
|
+
# result = client.lookup_entry request
|
1311
|
+
#
|
1312
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
|
1313
|
+
# p result
|
1314
|
+
#
|
1091
1315
|
def lookup_entry request, options = nil
|
1092
1316
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1093
1317
|
|
@@ -1108,7 +1332,9 @@ module Google
|
|
1108
1332
|
options.apply_defaults timeout: @config.rpcs.lookup_entry.timeout,
|
1109
1333
|
metadata: metadata,
|
1110
1334
|
retry_policy: @config.rpcs.lookup_entry.retry_policy
|
1111
|
-
|
1335
|
+
|
1336
|
+
options.apply_defaults timeout: @config.timeout,
|
1337
|
+
metadata: @config.metadata,
|
1112
1338
|
retry_policy: @config.retry_policy
|
1113
1339
|
|
1114
1340
|
@data_catalog_stub.call_rpc :lookup_entry, request, options: options do |response, operation|
|
@@ -1138,21 +1364,21 @@ module Google
|
|
1138
1364
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1139
1365
|
#
|
1140
1366
|
# @param parent [::String]
|
1141
|
-
# Required. The name of the entry group that contains the entries
|
1142
|
-
# be provided in URL format. Example:
|
1367
|
+
# Required. The name of the entry group that contains the entries to list.
|
1143
1368
|
#
|
1144
|
-
#
|
1369
|
+
# Can be provided in URL format.
|
1145
1370
|
# @param page_size [::Integer]
|
1146
|
-
# The maximum number of items to return. Default is 10.
|
1147
|
-
# Throws an invalid argument
|
1371
|
+
# The maximum number of items to return. Default is 10. Maximum limit is
|
1372
|
+
# 1000. Throws an invalid argument if `page_size` is more than 1000.
|
1148
1373
|
# @param page_token [::String]
|
1149
|
-
#
|
1150
|
-
# returned.
|
1374
|
+
# Pagination token that specifies the next page to return. If empty, the
|
1375
|
+
# first page is returned.
|
1151
1376
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1152
|
-
# The fields to return for each
|
1377
|
+
# The fields to return for each entry. If empty or omitted, all
|
1153
1378
|
# fields are returned.
|
1154
|
-
#
|
1155
|
-
#
|
1379
|
+
#
|
1380
|
+
# For example, to return a list of entries with only the `name` field,
|
1381
|
+
# set `read_mask` to only one path with the `name` value.
|
1156
1382
|
#
|
1157
1383
|
# @yield [response, operation] Access the result along with the RPC operation
|
1158
1384
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>]
|
@@ -1162,6 +1388,27 @@ module Google
|
|
1162
1388
|
#
|
1163
1389
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1164
1390
|
#
|
1391
|
+
# @example Basic example
|
1392
|
+
# require "google/cloud/data_catalog/v1"
|
1393
|
+
#
|
1394
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1395
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1396
|
+
#
|
1397
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1398
|
+
# request = Google::Cloud::DataCatalog::V1::ListEntriesRequest.new
|
1399
|
+
#
|
1400
|
+
# # Call the list_entries method.
|
1401
|
+
# result = client.list_entries request
|
1402
|
+
#
|
1403
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
1404
|
+
# # iterate over all elements by calling #each, and the enumerable
|
1405
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
1406
|
+
# # methods are also available for managing paging directly.
|
1407
|
+
# result.each do |response|
|
1408
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::V1::Entry.
|
1409
|
+
# p response
|
1410
|
+
# end
|
1411
|
+
#
|
1165
1412
|
def list_entries request, options = nil
|
1166
1413
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1167
1414
|
|
@@ -1179,16 +1426,20 @@ module Google
|
|
1179
1426
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1180
1427
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1181
1428
|
|
1182
|
-
header_params = {
|
1183
|
-
|
1184
|
-
|
1429
|
+
header_params = {}
|
1430
|
+
if request.parent
|
1431
|
+
header_params["parent"] = request.parent
|
1432
|
+
end
|
1433
|
+
|
1185
1434
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1186
1435
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1187
1436
|
|
1188
1437
|
options.apply_defaults timeout: @config.rpcs.list_entries.timeout,
|
1189
1438
|
metadata: metadata,
|
1190
1439
|
retry_policy: @config.rpcs.list_entries.retry_policy
|
1191
|
-
|
1440
|
+
|
1441
|
+
options.apply_defaults timeout: @config.timeout,
|
1442
|
+
metadata: @config.metadata,
|
1192
1443
|
retry_policy: @config.retry_policy
|
1193
1444
|
|
1194
1445
|
@data_catalog_stub.call_rpc :list_entries, request, options: options do |response, operation|
|
@@ -1201,11 +1452,12 @@ module Google
|
|
1201
1452
|
end
|
1202
1453
|
|
1203
1454
|
##
|
1204
|
-
# Creates a tag template.
|
1205
|
-
#
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1455
|
+
# Creates a tag template.
|
1456
|
+
#
|
1457
|
+
# You must enable the Data Catalog API in the project identified by the
|
1458
|
+
# `parent` parameter.
|
1459
|
+
# For more information, see [Data Catalog resource project]
|
1460
|
+
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1209
1461
|
#
|
1210
1462
|
# @overload create_tag_template(request, options = nil)
|
1211
1463
|
# Pass arguments to `create_tag_template` via a request object, either of type
|
@@ -1225,10 +1477,6 @@ module Google
|
|
1225
1477
|
# @param parent [::String]
|
1226
1478
|
# Required. The name of the project and the template location
|
1227
1479
|
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
1228
|
-
#
|
1229
|
-
# Example:
|
1230
|
-
#
|
1231
|
-
# * projects/\\{project_id}/locations/us-central1
|
1232
1480
|
# @param tag_template_id [::String]
|
1233
1481
|
# Required. The ID of the tag template to create.
|
1234
1482
|
#
|
@@ -1246,6 +1494,21 @@ module Google
|
|
1246
1494
|
#
|
1247
1495
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1248
1496
|
#
|
1497
|
+
# @example Basic example
|
1498
|
+
# require "google/cloud/data_catalog/v1"
|
1499
|
+
#
|
1500
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1501
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1502
|
+
#
|
1503
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1504
|
+
# request = Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest.new
|
1505
|
+
#
|
1506
|
+
# # Call the create_tag_template method.
|
1507
|
+
# result = client.create_tag_template request
|
1508
|
+
#
|
1509
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
|
1510
|
+
# p result
|
1511
|
+
#
|
1249
1512
|
def create_tag_template request, options = nil
|
1250
1513
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1251
1514
|
|
@@ -1263,16 +1526,20 @@ module Google
|
|
1263
1526
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1264
1527
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1265
1528
|
|
1266
|
-
header_params = {
|
1267
|
-
|
1268
|
-
|
1529
|
+
header_params = {}
|
1530
|
+
if request.parent
|
1531
|
+
header_params["parent"] = request.parent
|
1532
|
+
end
|
1533
|
+
|
1269
1534
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1270
1535
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1271
1536
|
|
1272
1537
|
options.apply_defaults timeout: @config.rpcs.create_tag_template.timeout,
|
1273
1538
|
metadata: metadata,
|
1274
1539
|
retry_policy: @config.rpcs.create_tag_template.retry_policy
|
1275
|
-
|
1540
|
+
|
1541
|
+
options.apply_defaults timeout: @config.timeout,
|
1542
|
+
metadata: @config.metadata,
|
1276
1543
|
retry_policy: @config.retry_policy
|
1277
1544
|
|
1278
1545
|
@data_catalog_stub.call_rpc :create_tag_template, request, options: options do |response, operation|
|
@@ -1302,9 +1569,7 @@ module Google
|
|
1302
1569
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1303
1570
|
#
|
1304
1571
|
# @param name [::String]
|
1305
|
-
# Required. The name of the tag template.
|
1306
|
-
#
|
1307
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
1572
|
+
# Required. The name of the tag template to get.
|
1308
1573
|
#
|
1309
1574
|
# @yield [response, operation] Access the result along with the RPC operation
|
1310
1575
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
@@ -1314,6 +1579,21 @@ module Google
|
|
1314
1579
|
#
|
1315
1580
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1316
1581
|
#
|
1582
|
+
# @example Basic example
|
1583
|
+
# require "google/cloud/data_catalog/v1"
|
1584
|
+
#
|
1585
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1586
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1587
|
+
#
|
1588
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1589
|
+
# request = Google::Cloud::DataCatalog::V1::GetTagTemplateRequest.new
|
1590
|
+
#
|
1591
|
+
# # Call the get_tag_template method.
|
1592
|
+
# result = client.get_tag_template request
|
1593
|
+
#
|
1594
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
|
1595
|
+
# p result
|
1596
|
+
#
|
1317
1597
|
def get_tag_template request, options = nil
|
1318
1598
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1319
1599
|
|
@@ -1331,16 +1611,20 @@ module Google
|
|
1331
1611
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1332
1612
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1333
1613
|
|
1334
|
-
header_params = {
|
1335
|
-
|
1336
|
-
|
1614
|
+
header_params = {}
|
1615
|
+
if request.name
|
1616
|
+
header_params["name"] = request.name
|
1617
|
+
end
|
1618
|
+
|
1337
1619
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1338
1620
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1339
1621
|
|
1340
1622
|
options.apply_defaults timeout: @config.rpcs.get_tag_template.timeout,
|
1341
1623
|
metadata: metadata,
|
1342
1624
|
retry_policy: @config.rpcs.get_tag_template.retry_policy
|
1343
|
-
|
1625
|
+
|
1626
|
+
options.apply_defaults timeout: @config.timeout,
|
1627
|
+
metadata: @config.metadata,
|
1344
1628
|
retry_policy: @config.retry_policy
|
1345
1629
|
|
1346
1630
|
@data_catalog_stub.call_rpc :get_tag_template, request, options: options do |response, operation|
|
@@ -1352,13 +1636,15 @@ module Google
|
|
1352
1636
|
end
|
1353
1637
|
|
1354
1638
|
##
|
1355
|
-
# Updates a tag template.
|
1356
|
-
#
|
1357
|
-
#
|
1358
|
-
#
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
# more information
|
1639
|
+
# Updates a tag template.
|
1640
|
+
#
|
1641
|
+
# You can't update template fields with this method. These fields are
|
1642
|
+
# separate resources with their own create, update, and delete methods.
|
1643
|
+
#
|
1644
|
+
# You must enable the Data Catalog API in the project identified by
|
1645
|
+
# the `tag_template.name` parameter. For more information, see [Data Catalog
|
1646
|
+
# resource
|
1647
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1362
1648
|
#
|
1363
1649
|
# @overload update_tag_template(request, options = nil)
|
1364
1650
|
# Pass arguments to `update_tag_template` via a request object, either of type
|
@@ -1376,12 +1662,12 @@ module Google
|
|
1376
1662
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1377
1663
|
#
|
1378
1664
|
# @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
|
1379
|
-
# Required. The template to update. The
|
1665
|
+
# Required. The template to update. The `name` field must be set.
|
1380
1666
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1381
1667
|
# Names of fields whose values to overwrite on a tag template. Currently,
|
1382
1668
|
# only `display_name` can be overwritten.
|
1383
1669
|
#
|
1384
|
-
#
|
1670
|
+
# If this parameter is absent or empty, all modifiable fields
|
1385
1671
|
# are overwritten. If such fields are non-required and omitted in the
|
1386
1672
|
# request body, their values are emptied.
|
1387
1673
|
#
|
@@ -1393,6 +1679,21 @@ module Google
|
|
1393
1679
|
#
|
1394
1680
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1395
1681
|
#
|
1682
|
+
# @example Basic example
|
1683
|
+
# require "google/cloud/data_catalog/v1"
|
1684
|
+
#
|
1685
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1686
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1687
|
+
#
|
1688
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1689
|
+
# request = Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest.new
|
1690
|
+
#
|
1691
|
+
# # Call the update_tag_template method.
|
1692
|
+
# result = client.update_tag_template request
|
1693
|
+
#
|
1694
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
|
1695
|
+
# p result
|
1696
|
+
#
|
1396
1697
|
def update_tag_template request, options = nil
|
1397
1698
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1398
1699
|
|
@@ -1410,16 +1711,20 @@ module Google
|
|
1410
1711
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1411
1712
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1412
1713
|
|
1413
|
-
header_params = {
|
1414
|
-
|
1415
|
-
|
1714
|
+
header_params = {}
|
1715
|
+
if request.tag_template&.name
|
1716
|
+
header_params["tag_template.name"] = request.tag_template.name
|
1717
|
+
end
|
1718
|
+
|
1416
1719
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1417
1720
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1418
1721
|
|
1419
1722
|
options.apply_defaults timeout: @config.rpcs.update_tag_template.timeout,
|
1420
1723
|
metadata: metadata,
|
1421
1724
|
retry_policy: @config.rpcs.update_tag_template.retry_policy
|
1422
|
-
|
1725
|
+
|
1726
|
+
options.apply_defaults timeout: @config.timeout,
|
1727
|
+
metadata: @config.metadata,
|
1423
1728
|
retry_policy: @config.retry_policy
|
1424
1729
|
|
1425
1730
|
@data_catalog_stub.call_rpc :update_tag_template, request, options: options do |response, operation|
|
@@ -1431,11 +1736,11 @@ module Google
|
|
1431
1736
|
end
|
1432
1737
|
|
1433
1738
|
##
|
1434
|
-
# Deletes a tag template and all tags
|
1435
|
-
#
|
1436
|
-
#
|
1437
|
-
#
|
1438
|
-
#
|
1739
|
+
# Deletes a tag template and all tags that use it.
|
1740
|
+
#
|
1741
|
+
# You must enable the Data Catalog API in the project identified by
|
1742
|
+
# the `name` parameter. For more information, see [Data Catalog resource
|
1743
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1439
1744
|
#
|
1440
1745
|
# @overload delete_tag_template(request, options = nil)
|
1441
1746
|
# Pass arguments to `delete_tag_template` via a request object, either of type
|
@@ -1453,13 +1758,11 @@ module Google
|
|
1453
1758
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1454
1759
|
#
|
1455
1760
|
# @param name [::String]
|
1456
|
-
# Required. The name of the tag template to delete.
|
1457
|
-
#
|
1458
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
1761
|
+
# Required. The name of the tag template to delete.
|
1459
1762
|
# @param force [::Boolean]
|
1460
|
-
# Required.
|
1461
|
-
#
|
1462
|
-
# `
|
1763
|
+
# Required. If true, deletes all tags that use this template.
|
1764
|
+
#
|
1765
|
+
# Currently, `true` is the only supported value.
|
1463
1766
|
#
|
1464
1767
|
# @yield [response, operation] Access the result along with the RPC operation
|
1465
1768
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1469,6 +1772,21 @@ module Google
|
|
1469
1772
|
#
|
1470
1773
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1471
1774
|
#
|
1775
|
+
# @example Basic example
|
1776
|
+
# require "google/cloud/data_catalog/v1"
|
1777
|
+
#
|
1778
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1779
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1780
|
+
#
|
1781
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1782
|
+
# request = Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest.new
|
1783
|
+
#
|
1784
|
+
# # Call the delete_tag_template method.
|
1785
|
+
# result = client.delete_tag_template request
|
1786
|
+
#
|
1787
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1788
|
+
# p result
|
1789
|
+
#
|
1472
1790
|
def delete_tag_template request, options = nil
|
1473
1791
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1474
1792
|
|
@@ -1486,16 +1804,20 @@ module Google
|
|
1486
1804
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1487
1805
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1488
1806
|
|
1489
|
-
header_params = {
|
1490
|
-
|
1491
|
-
|
1807
|
+
header_params = {}
|
1808
|
+
if request.name
|
1809
|
+
header_params["name"] = request.name
|
1810
|
+
end
|
1811
|
+
|
1492
1812
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1493
1813
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1494
1814
|
|
1495
1815
|
options.apply_defaults timeout: @config.rpcs.delete_tag_template.timeout,
|
1496
1816
|
metadata: metadata,
|
1497
1817
|
retry_policy: @config.rpcs.delete_tag_template.retry_policy
|
1498
|
-
|
1818
|
+
|
1819
|
+
options.apply_defaults timeout: @config.timeout,
|
1820
|
+
metadata: @config.metadata,
|
1499
1821
|
retry_policy: @config.retry_policy
|
1500
1822
|
|
1501
1823
|
@data_catalog_stub.call_rpc :delete_tag_template, request, options: options do |response, operation|
|
@@ -1507,11 +1829,11 @@ module Google
|
|
1507
1829
|
end
|
1508
1830
|
|
1509
1831
|
##
|
1510
|
-
# Creates a field in a tag template.
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
#
|
1514
|
-
#
|
1832
|
+
# Creates a field in a tag template.
|
1833
|
+
#
|
1834
|
+
# You must enable the Data Catalog API in the project identified by
|
1835
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
1836
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1515
1837
|
#
|
1516
1838
|
# @overload create_tag_template_field(request, options = nil)
|
1517
1839
|
# Pass arguments to `create_tag_template_field` via a request object, either of type
|
@@ -1531,10 +1853,6 @@ module Google
|
|
1531
1853
|
# @param parent [::String]
|
1532
1854
|
# Required. The name of the project and the template location
|
1533
1855
|
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
1534
|
-
#
|
1535
|
-
# Example:
|
1536
|
-
#
|
1537
|
-
# * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
|
1538
1856
|
# @param tag_template_field_id [::String]
|
1539
1857
|
# Required. The ID of the tag template field to create.
|
1540
1858
|
#
|
@@ -1555,6 +1873,21 @@ module Google
|
|
1555
1873
|
#
|
1556
1874
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1557
1875
|
#
|
1876
|
+
# @example Basic example
|
1877
|
+
# require "google/cloud/data_catalog/v1"
|
1878
|
+
#
|
1879
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1880
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1881
|
+
#
|
1882
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1883
|
+
# request = Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest.new
|
1884
|
+
#
|
1885
|
+
# # Call the create_tag_template_field method.
|
1886
|
+
# result = client.create_tag_template_field request
|
1887
|
+
#
|
1888
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
|
1889
|
+
# p result
|
1890
|
+
#
|
1558
1891
|
def create_tag_template_field request, options = nil
|
1559
1892
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1560
1893
|
|
@@ -1572,16 +1905,20 @@ module Google
|
|
1572
1905
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1573
1906
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1574
1907
|
|
1575
|
-
header_params = {
|
1576
|
-
|
1577
|
-
|
1908
|
+
header_params = {}
|
1909
|
+
if request.parent
|
1910
|
+
header_params["parent"] = request.parent
|
1911
|
+
end
|
1912
|
+
|
1578
1913
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1579
1914
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1580
1915
|
|
1581
1916
|
options.apply_defaults timeout: @config.rpcs.create_tag_template_field.timeout,
|
1582
1917
|
metadata: metadata,
|
1583
1918
|
retry_policy: @config.rpcs.create_tag_template_field.retry_policy
|
1584
|
-
|
1919
|
+
|
1920
|
+
options.apply_defaults timeout: @config.timeout,
|
1921
|
+
metadata: @config.metadata,
|
1585
1922
|
retry_policy: @config.retry_policy
|
1586
1923
|
|
1587
1924
|
@data_catalog_stub.call_rpc :create_tag_template_field, request, options: options do |response, operation|
|
@@ -1593,11 +1930,14 @@ module Google
|
|
1593
1930
|
end
|
1594
1931
|
|
1595
1932
|
##
|
1596
|
-
# Updates a field in a tag template.
|
1597
|
-
#
|
1598
|
-
#
|
1599
|
-
#
|
1600
|
-
#
|
1933
|
+
# Updates a field in a tag template.
|
1934
|
+
#
|
1935
|
+
# You can't update the field type with this method.
|
1936
|
+
#
|
1937
|
+
# You must enable the Data Catalog API in the project
|
1938
|
+
# identified by the `name` parameter. For more information, see [Data Catalog
|
1939
|
+
# resource
|
1940
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1601
1941
|
#
|
1602
1942
|
# @overload update_tag_template_field(request, options = nil)
|
1603
1943
|
# Pass arguments to `update_tag_template_field` via a request object, either of type
|
@@ -1615,18 +1955,16 @@ module Google
|
|
1615
1955
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1616
1956
|
#
|
1617
1957
|
# @param name [::String]
|
1618
|
-
# Required. The name of the tag template field.
|
1619
|
-
#
|
1620
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
1958
|
+
# Required. The name of the tag template field.
|
1621
1959
|
# @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
|
1622
1960
|
# Required. The template to update.
|
1623
1961
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1624
1962
|
# Optional. Names of fields whose values to overwrite on an individual field of a tag
|
1625
1963
|
# template. The following fields are modifiable:
|
1626
1964
|
#
|
1627
|
-
#
|
1628
|
-
#
|
1629
|
-
#
|
1965
|
+
# * `display_name`
|
1966
|
+
# * `type.enum_type`
|
1967
|
+
# * `is_required`
|
1630
1968
|
#
|
1631
1969
|
# If this parameter is absent or empty, all modifiable fields
|
1632
1970
|
# are overwritten. If such fields are non-required and omitted in the request
|
@@ -1646,6 +1984,21 @@ module Google
|
|
1646
1984
|
#
|
1647
1985
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1648
1986
|
#
|
1987
|
+
# @example Basic example
|
1988
|
+
# require "google/cloud/data_catalog/v1"
|
1989
|
+
#
|
1990
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1991
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
1992
|
+
#
|
1993
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1994
|
+
# request = Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest.new
|
1995
|
+
#
|
1996
|
+
# # Call the update_tag_template_field method.
|
1997
|
+
# result = client.update_tag_template_field request
|
1998
|
+
#
|
1999
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
|
2000
|
+
# p result
|
2001
|
+
#
|
1649
2002
|
def update_tag_template_field request, options = nil
|
1650
2003
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1651
2004
|
|
@@ -1663,16 +2016,20 @@ module Google
|
|
1663
2016
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1664
2017
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1665
2018
|
|
1666
|
-
header_params = {
|
1667
|
-
|
1668
|
-
|
2019
|
+
header_params = {}
|
2020
|
+
if request.name
|
2021
|
+
header_params["name"] = request.name
|
2022
|
+
end
|
2023
|
+
|
1669
2024
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1670
2025
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1671
2026
|
|
1672
2027
|
options.apply_defaults timeout: @config.rpcs.update_tag_template_field.timeout,
|
1673
2028
|
metadata: metadata,
|
1674
2029
|
retry_policy: @config.rpcs.update_tag_template_field.retry_policy
|
1675
|
-
|
2030
|
+
|
2031
|
+
options.apply_defaults timeout: @config.timeout,
|
2032
|
+
metadata: @config.metadata,
|
1676
2033
|
retry_policy: @config.retry_policy
|
1677
2034
|
|
1678
2035
|
@data_catalog_stub.call_rpc :update_tag_template_field, request, options: options do |response, operation|
|
@@ -1684,11 +2041,11 @@ module Google
|
|
1684
2041
|
end
|
1685
2042
|
|
1686
2043
|
##
|
1687
|
-
# Renames a field in a tag template.
|
1688
|
-
#
|
1689
|
-
#
|
1690
|
-
#
|
1691
|
-
#
|
2044
|
+
# Renames a field in a tag template.
|
2045
|
+
#
|
2046
|
+
# You must enable the Data Catalog API in the project identified by the
|
2047
|
+
# `name` parameter. For more information, see [Data Catalog resource project]
|
2048
|
+
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1692
2049
|
#
|
1693
2050
|
# @overload rename_tag_template_field(request, options = nil)
|
1694
2051
|
# Pass arguments to `rename_tag_template_field` via a request object, either of type
|
@@ -1706,9 +2063,7 @@ module Google
|
|
1706
2063
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1707
2064
|
#
|
1708
2065
|
# @param name [::String]
|
1709
|
-
# Required. The name of the tag template.
|
1710
|
-
#
|
1711
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
2066
|
+
# Required. The name of the tag template.
|
1712
2067
|
# @param new_tag_template_field_id [::String]
|
1713
2068
|
# Required. The new ID of this tag template field. For example, `my_new_field`.
|
1714
2069
|
#
|
@@ -1720,6 +2075,21 @@ module Google
|
|
1720
2075
|
#
|
1721
2076
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1722
2077
|
#
|
2078
|
+
# @example Basic example
|
2079
|
+
# require "google/cloud/data_catalog/v1"
|
2080
|
+
#
|
2081
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2082
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2083
|
+
#
|
2084
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2085
|
+
# request = Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest.new
|
2086
|
+
#
|
2087
|
+
# # Call the rename_tag_template_field method.
|
2088
|
+
# result = client.rename_tag_template_field request
|
2089
|
+
#
|
2090
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
|
2091
|
+
# p result
|
2092
|
+
#
|
1723
2093
|
def rename_tag_template_field request, options = nil
|
1724
2094
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1725
2095
|
|
@@ -1737,16 +2107,20 @@ module Google
|
|
1737
2107
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1738
2108
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1739
2109
|
|
1740
|
-
header_params = {
|
1741
|
-
|
1742
|
-
|
2110
|
+
header_params = {}
|
2111
|
+
if request.name
|
2112
|
+
header_params["name"] = request.name
|
2113
|
+
end
|
2114
|
+
|
1743
2115
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1744
2116
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1745
2117
|
|
1746
2118
|
options.apply_defaults timeout: @config.rpcs.rename_tag_template_field.timeout,
|
1747
2119
|
metadata: metadata,
|
1748
2120
|
retry_policy: @config.rpcs.rename_tag_template_field.retry_policy
|
1749
|
-
|
2121
|
+
|
2122
|
+
options.apply_defaults timeout: @config.timeout,
|
2123
|
+
metadata: @config.metadata,
|
1750
2124
|
retry_policy: @config.retry_policy
|
1751
2125
|
|
1752
2126
|
@data_catalog_stub.call_rpc :rename_tag_template_field, request, options: options do |response, operation|
|
@@ -1758,8 +2132,9 @@ module Google
|
|
1758
2132
|
end
|
1759
2133
|
|
1760
2134
|
##
|
1761
|
-
# Renames an enum value in a tag template.
|
1762
|
-
#
|
2135
|
+
# Renames an enum value in a tag template.
|
2136
|
+
#
|
2137
|
+
# Within a single enum field, enum values must be unique.
|
1763
2138
|
#
|
1764
2139
|
# @overload rename_tag_template_field_enum_value(request, options = nil)
|
1765
2140
|
# Pass arguments to `rename_tag_template_field_enum_value` via a request object, either of type
|
@@ -1777,9 +2152,7 @@ module Google
|
|
1777
2152
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1778
2153
|
#
|
1779
2154
|
# @param name [::String]
|
1780
|
-
# Required. The name of the enum field value.
|
1781
|
-
#
|
1782
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}/enumValues/\\{enum_value_display_name}
|
2155
|
+
# Required. The name of the enum field value.
|
1783
2156
|
# @param new_enum_value_display_name [::String]
|
1784
2157
|
# Required. The new display name of the enum value. For example, `my_new_enum_value`.
|
1785
2158
|
#
|
@@ -1791,6 +2164,21 @@ module Google
|
|
1791
2164
|
#
|
1792
2165
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1793
2166
|
#
|
2167
|
+
# @example Basic example
|
2168
|
+
# require "google/cloud/data_catalog/v1"
|
2169
|
+
#
|
2170
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2171
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2172
|
+
#
|
2173
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2174
|
+
# request = Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest.new
|
2175
|
+
#
|
2176
|
+
# # Call the rename_tag_template_field_enum_value method.
|
2177
|
+
# result = client.rename_tag_template_field_enum_value request
|
2178
|
+
#
|
2179
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
|
2180
|
+
# p result
|
2181
|
+
#
|
1794
2182
|
def rename_tag_template_field_enum_value request, options = nil
|
1795
2183
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1796
2184
|
|
@@ -1808,16 +2196,20 @@ module Google
|
|
1808
2196
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1809
2197
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1810
2198
|
|
1811
|
-
header_params = {
|
1812
|
-
|
1813
|
-
|
2199
|
+
header_params = {}
|
2200
|
+
if request.name
|
2201
|
+
header_params["name"] = request.name
|
2202
|
+
end
|
2203
|
+
|
1814
2204
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1815
2205
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1816
2206
|
|
1817
2207
|
options.apply_defaults timeout: @config.rpcs.rename_tag_template_field_enum_value.timeout,
|
1818
2208
|
metadata: metadata,
|
1819
2209
|
retry_policy: @config.rpcs.rename_tag_template_field_enum_value.retry_policy
|
1820
|
-
|
2210
|
+
|
2211
|
+
options.apply_defaults timeout: @config.timeout,
|
2212
|
+
metadata: @config.metadata,
|
1821
2213
|
retry_policy: @config.retry_policy
|
1822
2214
|
|
1823
2215
|
@data_catalog_stub.call_rpc :rename_tag_template_field_enum_value, request, options: options do |response, operation|
|
@@ -1829,11 +2221,12 @@ module Google
|
|
1829
2221
|
end
|
1830
2222
|
|
1831
2223
|
##
|
1832
|
-
# Deletes a field in a tag template and all uses of
|
1833
|
-
#
|
1834
|
-
#
|
1835
|
-
#
|
1836
|
-
# more information
|
2224
|
+
# Deletes a field in a tag template and all uses of this field from the tags
|
2225
|
+
# based on this template.
|
2226
|
+
#
|
2227
|
+
# You must enable the Data Catalog API in the project identified by
|
2228
|
+
# the `name` parameter. For more information, see [Data Catalog resource
|
2229
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1837
2230
|
#
|
1838
2231
|
# @overload delete_tag_template_field(request, options = nil)
|
1839
2232
|
# Pass arguments to `delete_tag_template_field` via a request object, either of type
|
@@ -1851,13 +2244,11 @@ module Google
|
|
1851
2244
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1852
2245
|
#
|
1853
2246
|
# @param name [::String]
|
1854
|
-
# Required. The name of the tag template field to delete.
|
1855
|
-
#
|
1856
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
2247
|
+
# Required. The name of the tag template field to delete.
|
1857
2248
|
# @param force [::Boolean]
|
1858
|
-
# Required.
|
1859
|
-
#
|
1860
|
-
# `
|
2249
|
+
# Required. If true, deletes this field from any tags that use it.
|
2250
|
+
#
|
2251
|
+
# Currently, `true` is the only supported value.
|
1861
2252
|
#
|
1862
2253
|
# @yield [response, operation] Access the result along with the RPC operation
|
1863
2254
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1867,6 +2258,21 @@ module Google
|
|
1867
2258
|
#
|
1868
2259
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1869
2260
|
#
|
2261
|
+
# @example Basic example
|
2262
|
+
# require "google/cloud/data_catalog/v1"
|
2263
|
+
#
|
2264
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2265
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2266
|
+
#
|
2267
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2268
|
+
# request = Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest.new
|
2269
|
+
#
|
2270
|
+
# # Call the delete_tag_template_field method.
|
2271
|
+
# result = client.delete_tag_template_field request
|
2272
|
+
#
|
2273
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
2274
|
+
# p result
|
2275
|
+
#
|
1870
2276
|
def delete_tag_template_field request, options = nil
|
1871
2277
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1872
2278
|
|
@@ -1884,16 +2290,20 @@ module Google
|
|
1884
2290
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1885
2291
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1886
2292
|
|
1887
|
-
header_params = {
|
1888
|
-
|
1889
|
-
|
2293
|
+
header_params = {}
|
2294
|
+
if request.name
|
2295
|
+
header_params["name"] = request.name
|
2296
|
+
end
|
2297
|
+
|
1890
2298
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1891
2299
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1892
2300
|
|
1893
2301
|
options.apply_defaults timeout: @config.rpcs.delete_tag_template_field.timeout,
|
1894
2302
|
metadata: metadata,
|
1895
2303
|
retry_policy: @config.rpcs.delete_tag_template_field.retry_policy
|
1896
|
-
|
2304
|
+
|
2305
|
+
options.apply_defaults timeout: @config.timeout,
|
2306
|
+
metadata: @config.metadata,
|
1897
2307
|
retry_policy: @config.retry_policy
|
1898
2308
|
|
1899
2309
|
@data_catalog_stub.call_rpc :delete_tag_template_field, request, options: options do |response, operation|
|
@@ -1905,13 +2315,18 @@ module Google
|
|
1905
2315
|
end
|
1906
2316
|
|
1907
2317
|
##
|
1908
|
-
# Creates a tag
|
1909
|
-
#
|
1910
|
-
#
|
1911
|
-
#
|
1912
|
-
#
|
1913
|
-
#
|
1914
|
-
#
|
2318
|
+
# Creates a tag and assigns it to:
|
2319
|
+
#
|
2320
|
+
# * An {::Google::Cloud::DataCatalog::V1::Entry Entry} if the method name is
|
2321
|
+
# ``projects.locations.entryGroups.entries.tags.create``.
|
2322
|
+
# * Or {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}if the method
|
2323
|
+
# name is ``projects.locations.entryGroups.tags.create``.
|
2324
|
+
#
|
2325
|
+
# Note: The project identified by the `parent` parameter for the [tag]
|
2326
|
+
# (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
|
2327
|
+
# and the [tag template]
|
2328
|
+
# (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
|
2329
|
+
# used to create the tag must be in the same organization.
|
1915
2330
|
#
|
1916
2331
|
# @overload create_tag(request, options = nil)
|
1917
2332
|
# Pass arguments to `create_tag` via a request object, either of type
|
@@ -1929,10 +2344,10 @@ module Google
|
|
1929
2344
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1930
2345
|
#
|
1931
2346
|
# @param parent [::String]
|
1932
|
-
# Required. The name of the resource to attach this tag to.
|
1933
|
-
# entries. An entry can have up to 1000 attached tags. Example:
|
2347
|
+
# Required. The name of the resource to attach this tag to.
|
1934
2348
|
#
|
1935
|
-
#
|
2349
|
+
# Tags can be attached to entries or entry groups. An entry can have up to
|
2350
|
+
# 1000 attached tags.
|
1936
2351
|
#
|
1937
2352
|
# Note: The tag and its child resources might not be stored in
|
1938
2353
|
# the location specified in its name.
|
@@ -1947,6 +2362,21 @@ module Google
|
|
1947
2362
|
#
|
1948
2363
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1949
2364
|
#
|
2365
|
+
# @example Basic example
|
2366
|
+
# require "google/cloud/data_catalog/v1"
|
2367
|
+
#
|
2368
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2369
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2370
|
+
#
|
2371
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2372
|
+
# request = Google::Cloud::DataCatalog::V1::CreateTagRequest.new
|
2373
|
+
#
|
2374
|
+
# # Call the create_tag method.
|
2375
|
+
# result = client.create_tag request
|
2376
|
+
#
|
2377
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::Tag.
|
2378
|
+
# p result
|
2379
|
+
#
|
1950
2380
|
def create_tag request, options = nil
|
1951
2381
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1952
2382
|
|
@@ -1964,16 +2394,20 @@ module Google
|
|
1964
2394
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
1965
2395
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1966
2396
|
|
1967
|
-
header_params = {
|
1968
|
-
|
1969
|
-
|
2397
|
+
header_params = {}
|
2398
|
+
if request.parent
|
2399
|
+
header_params["parent"] = request.parent
|
2400
|
+
end
|
2401
|
+
|
1970
2402
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1971
2403
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
1972
2404
|
|
1973
2405
|
options.apply_defaults timeout: @config.rpcs.create_tag.timeout,
|
1974
2406
|
metadata: metadata,
|
1975
2407
|
retry_policy: @config.rpcs.create_tag.retry_policy
|
1976
|
-
|
2408
|
+
|
2409
|
+
options.apply_defaults timeout: @config.timeout,
|
2410
|
+
metadata: @config.metadata,
|
1977
2411
|
retry_policy: @config.retry_policy
|
1978
2412
|
|
1979
2413
|
@data_catalog_stub.call_rpc :create_tag, request, options: options do |response, operation|
|
@@ -2020,6 +2454,21 @@ module Google
|
|
2020
2454
|
#
|
2021
2455
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2022
2456
|
#
|
2457
|
+
# @example Basic example
|
2458
|
+
# require "google/cloud/data_catalog/v1"
|
2459
|
+
#
|
2460
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2461
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2462
|
+
#
|
2463
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2464
|
+
# request = Google::Cloud::DataCatalog::V1::UpdateTagRequest.new
|
2465
|
+
#
|
2466
|
+
# # Call the update_tag method.
|
2467
|
+
# result = client.update_tag request
|
2468
|
+
#
|
2469
|
+
# # The returned object is of type Google::Cloud::DataCatalog::V1::Tag.
|
2470
|
+
# p result
|
2471
|
+
#
|
2023
2472
|
def update_tag request, options = nil
|
2024
2473
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
2025
2474
|
|
@@ -2037,16 +2486,20 @@ module Google
|
|
2037
2486
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
2038
2487
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2039
2488
|
|
2040
|
-
header_params = {
|
2041
|
-
|
2042
|
-
|
2489
|
+
header_params = {}
|
2490
|
+
if request.tag&.name
|
2491
|
+
header_params["tag.name"] = request.tag.name
|
2492
|
+
end
|
2493
|
+
|
2043
2494
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2044
2495
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
2045
2496
|
|
2046
2497
|
options.apply_defaults timeout: @config.rpcs.update_tag.timeout,
|
2047
2498
|
metadata: metadata,
|
2048
2499
|
retry_policy: @config.rpcs.update_tag.retry_policy
|
2049
|
-
|
2500
|
+
|
2501
|
+
options.apply_defaults timeout: @config.timeout,
|
2502
|
+
metadata: @config.metadata,
|
2050
2503
|
retry_policy: @config.retry_policy
|
2051
2504
|
|
2052
2505
|
@data_catalog_stub.call_rpc :update_tag, request, options: options do |response, operation|
|
@@ -2076,9 +2529,7 @@ module Google
|
|
2076
2529
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2077
2530
|
#
|
2078
2531
|
# @param name [::String]
|
2079
|
-
# Required. The name of the tag to delete.
|
2080
|
-
#
|
2081
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
|
2532
|
+
# Required. The name of the tag to delete.
|
2082
2533
|
#
|
2083
2534
|
# @yield [response, operation] Access the result along with the RPC operation
|
2084
2535
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -2088,6 +2539,21 @@ module Google
|
|
2088
2539
|
#
|
2089
2540
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2090
2541
|
#
|
2542
|
+
# @example Basic example
|
2543
|
+
# require "google/cloud/data_catalog/v1"
|
2544
|
+
#
|
2545
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2546
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2547
|
+
#
|
2548
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2549
|
+
# request = Google::Cloud::DataCatalog::V1::DeleteTagRequest.new
|
2550
|
+
#
|
2551
|
+
# # Call the delete_tag method.
|
2552
|
+
# result = client.delete_tag request
|
2553
|
+
#
|
2554
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
2555
|
+
# p result
|
2556
|
+
#
|
2091
2557
|
def delete_tag request, options = nil
|
2092
2558
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
2093
2559
|
|
@@ -2105,16 +2571,20 @@ module Google
|
|
2105
2571
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
2106
2572
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2107
2573
|
|
2108
|
-
header_params = {
|
2109
|
-
|
2110
|
-
|
2574
|
+
header_params = {}
|
2575
|
+
if request.name
|
2576
|
+
header_params["name"] = request.name
|
2577
|
+
end
|
2578
|
+
|
2111
2579
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2112
2580
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
2113
2581
|
|
2114
2582
|
options.apply_defaults timeout: @config.rpcs.delete_tag.timeout,
|
2115
2583
|
metadata: metadata,
|
2116
2584
|
retry_policy: @config.rpcs.delete_tag.retry_policy
|
2117
|
-
|
2585
|
+
|
2586
|
+
options.apply_defaults timeout: @config.timeout,
|
2587
|
+
metadata: @config.metadata,
|
2118
2588
|
retry_policy: @config.retry_policy
|
2119
2589
|
|
2120
2590
|
@data_catalog_stub.call_rpc :delete_tag, request, options: options do |response, operation|
|
@@ -2126,7 +2596,7 @@ module Google
|
|
2126
2596
|
end
|
2127
2597
|
|
2128
2598
|
##
|
2129
|
-
# Lists
|
2599
|
+
# Lists tags assigned to an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
|
2130
2600
|
#
|
2131
2601
|
# @overload list_tags(request, options = nil)
|
2132
2602
|
# Pass arguments to `list_tags` via a request object, either of type
|
@@ -2144,19 +2614,16 @@ module Google
|
|
2144
2614
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2145
2615
|
#
|
2146
2616
|
# @param parent [::String]
|
2147
|
-
# Required. The name of the Data Catalog resource to list the tags of.
|
2148
|
-
# could be an {::Google::Cloud::DataCatalog::V1::Entry Entry} or an
|
2149
|
-
# {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
|
2150
|
-
#
|
2151
|
-
# Examples:
|
2617
|
+
# Required. The name of the Data Catalog resource to list the tags of.
|
2152
2618
|
#
|
2153
|
-
#
|
2154
|
-
#
|
2619
|
+
# The resource can be an {::Google::Cloud::DataCatalog::V1::Entry Entry}
|
2620
|
+
# or an {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}
|
2621
|
+
# (without `/entries/{entries}` at the end).
|
2155
2622
|
# @param page_size [::Integer]
|
2156
|
-
# The maximum number of tags to return. Default is 10.
|
2623
|
+
# The maximum number of tags to return. Default is 10. Maximum limit is 1000.
|
2157
2624
|
# @param page_token [::String]
|
2158
|
-
#
|
2159
|
-
# returned.
|
2625
|
+
# Pagination token that specifies the next page to return. If empty, the
|
2626
|
+
# first page is returned.
|
2160
2627
|
#
|
2161
2628
|
# @yield [response, operation] Access the result along with the RPC operation
|
2162
2629
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>]
|
@@ -2166,6 +2633,27 @@ module Google
|
|
2166
2633
|
#
|
2167
2634
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2168
2635
|
#
|
2636
|
+
# @example Basic example
|
2637
|
+
# require "google/cloud/data_catalog/v1"
|
2638
|
+
#
|
2639
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2640
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2641
|
+
#
|
2642
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2643
|
+
# request = Google::Cloud::DataCatalog::V1::ListTagsRequest.new
|
2644
|
+
#
|
2645
|
+
# # Call the list_tags method.
|
2646
|
+
# result = client.list_tags request
|
2647
|
+
#
|
2648
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
2649
|
+
# # iterate over all elements by calling #each, and the enumerable
|
2650
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
2651
|
+
# # methods are also available for managing paging directly.
|
2652
|
+
# result.each do |response|
|
2653
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::V1::Tag.
|
2654
|
+
# p response
|
2655
|
+
# end
|
2656
|
+
#
|
2169
2657
|
def list_tags request, options = nil
|
2170
2658
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
2171
2659
|
|
@@ -2183,16 +2671,20 @@ module Google
|
|
2183
2671
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
2184
2672
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2185
2673
|
|
2186
|
-
header_params = {
|
2187
|
-
|
2188
|
-
|
2674
|
+
header_params = {}
|
2675
|
+
if request.parent
|
2676
|
+
header_params["parent"] = request.parent
|
2677
|
+
end
|
2678
|
+
|
2189
2679
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2190
2680
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
2191
2681
|
|
2192
2682
|
options.apply_defaults timeout: @config.rpcs.list_tags.timeout,
|
2193
2683
|
metadata: metadata,
|
2194
2684
|
retry_policy: @config.rpcs.list_tags.retry_policy
|
2195
|
-
|
2685
|
+
|
2686
|
+
options.apply_defaults timeout: @config.timeout,
|
2687
|
+
metadata: @config.metadata,
|
2196
2688
|
retry_policy: @config.retry_policy
|
2197
2689
|
|
2198
2690
|
@data_catalog_stub.call_rpc :list_tags, request, options: options do |response, operation|
|
@@ -2205,20 +2697,23 @@ module Google
|
|
2205
2697
|
end
|
2206
2698
|
|
2207
2699
|
##
|
2208
|
-
# Sets
|
2700
|
+
# Sets an access control policy for a resource. Replaces any existing
|
2209
2701
|
# policy.
|
2702
|
+
#
|
2210
2703
|
# Supported resources are:
|
2211
|
-
#
|
2212
|
-
#
|
2213
|
-
#
|
2214
|
-
#
|
2215
|
-
#
|
2216
|
-
#
|
2217
|
-
#
|
2218
|
-
#
|
2219
|
-
#
|
2220
|
-
#
|
2221
|
-
#
|
2704
|
+
#
|
2705
|
+
# - Tag templates
|
2706
|
+
# - Entry groups
|
2707
|
+
#
|
2708
|
+
# Note: This method sets policies only within Data Catalog and can't be
|
2709
|
+
# used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
|
2710
|
+
# external Google Cloud Platform resources synced with the Data Catalog.
|
2711
|
+
#
|
2712
|
+
# To call this method, you must have the following Google IAM permissions:
|
2713
|
+
#
|
2714
|
+
# - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
|
2715
|
+
# templates.
|
2716
|
+
# - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
|
2222
2717
|
#
|
2223
2718
|
# @overload set_iam_policy(request, options = nil)
|
2224
2719
|
# Pass arguments to `set_iam_policy` via a request object, either of type
|
@@ -2252,6 +2747,21 @@ module Google
|
|
2252
2747
|
#
|
2253
2748
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2254
2749
|
#
|
2750
|
+
# @example Basic example
|
2751
|
+
# require "google/cloud/data_catalog/v1"
|
2752
|
+
#
|
2753
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2754
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2755
|
+
#
|
2756
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2757
|
+
# request = Google::Iam::V1::SetIamPolicyRequest.new
|
2758
|
+
#
|
2759
|
+
# # Call the set_iam_policy method.
|
2760
|
+
# result = client.set_iam_policy request
|
2761
|
+
#
|
2762
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
2763
|
+
# p result
|
2764
|
+
#
|
2255
2765
|
def set_iam_policy request, options = nil
|
2256
2766
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
2257
2767
|
|
@@ -2269,16 +2779,20 @@ module Google
|
|
2269
2779
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
2270
2780
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2271
2781
|
|
2272
|
-
header_params = {
|
2273
|
-
|
2274
|
-
|
2782
|
+
header_params = {}
|
2783
|
+
if request.resource
|
2784
|
+
header_params["resource"] = request.resource
|
2785
|
+
end
|
2786
|
+
|
2275
2787
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2276
2788
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
2277
2789
|
|
2278
2790
|
options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
|
2279
2791
|
metadata: metadata,
|
2280
2792
|
retry_policy: @config.rpcs.set_iam_policy.retry_policy
|
2281
|
-
|
2793
|
+
|
2794
|
+
options.apply_defaults timeout: @config.timeout,
|
2795
|
+
metadata: @config.metadata,
|
2282
2796
|
retry_policy: @config.retry_policy
|
2283
2797
|
|
2284
2798
|
@data_catalog_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
|
@@ -2290,22 +2804,27 @@ module Google
|
|
2290
2804
|
end
|
2291
2805
|
|
2292
2806
|
##
|
2293
|
-
# Gets the access control policy for a resource.
|
2294
|
-
#
|
2295
|
-
#
|
2807
|
+
# Gets the access control policy for a resource.
|
2808
|
+
#
|
2809
|
+
# May return:
|
2810
|
+
#
|
2811
|
+
# * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
|
2812
|
+
# permission to view it.
|
2813
|
+
# * An empty policy if the resource exists but doesn't have a set policy.
|
2296
2814
|
#
|
2297
2815
|
# Supported resources are:
|
2298
|
-
#
|
2299
|
-
#
|
2300
|
-
#
|
2301
|
-
#
|
2302
|
-
#
|
2303
|
-
#
|
2304
|
-
#
|
2305
|
-
#
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
#
|
2816
|
+
#
|
2817
|
+
# - Tag templates
|
2818
|
+
# - Entry groups
|
2819
|
+
#
|
2820
|
+
# Note: This method doesn't get policies from Google Cloud Platform
|
2821
|
+
# resources ingested into Data Catalog.
|
2822
|
+
#
|
2823
|
+
# To call this method, you must have the following Google IAM permissions:
|
2824
|
+
#
|
2825
|
+
# - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
|
2826
|
+
# templates.
|
2827
|
+
# - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
|
2309
2828
|
#
|
2310
2829
|
# @overload get_iam_policy(request, options = nil)
|
2311
2830
|
# Pass arguments to `get_iam_policy` via a request object, either of type
|
@@ -2337,6 +2856,21 @@ module Google
|
|
2337
2856
|
#
|
2338
2857
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2339
2858
|
#
|
2859
|
+
# @example Basic example
|
2860
|
+
# require "google/cloud/data_catalog/v1"
|
2861
|
+
#
|
2862
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2863
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2864
|
+
#
|
2865
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2866
|
+
# request = Google::Iam::V1::GetIamPolicyRequest.new
|
2867
|
+
#
|
2868
|
+
# # Call the get_iam_policy method.
|
2869
|
+
# result = client.get_iam_policy request
|
2870
|
+
#
|
2871
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
2872
|
+
# p result
|
2873
|
+
#
|
2340
2874
|
def get_iam_policy request, options = nil
|
2341
2875
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
2342
2876
|
|
@@ -2354,16 +2888,20 @@ module Google
|
|
2354
2888
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
2355
2889
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2356
2890
|
|
2357
|
-
header_params = {
|
2358
|
-
|
2359
|
-
|
2891
|
+
header_params = {}
|
2892
|
+
if request.resource
|
2893
|
+
header_params["resource"] = request.resource
|
2894
|
+
end
|
2895
|
+
|
2360
2896
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2361
2897
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
2362
2898
|
|
2363
2899
|
options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
|
2364
2900
|
metadata: metadata,
|
2365
2901
|
retry_policy: @config.rpcs.get_iam_policy.retry_policy
|
2366
|
-
|
2902
|
+
|
2903
|
+
options.apply_defaults timeout: @config.timeout,
|
2904
|
+
metadata: @config.metadata,
|
2367
2905
|
retry_policy: @config.retry_policy
|
2368
2906
|
|
2369
2907
|
@data_catalog_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
|
@@ -2375,19 +2913,20 @@ module Google
|
|
2375
2913
|
end
|
2376
2914
|
|
2377
2915
|
##
|
2378
|
-
#
|
2379
|
-
#
|
2380
|
-
#
|
2916
|
+
# Gets your permissions on a resource.
|
2917
|
+
#
|
2918
|
+
# Returns an empty set of permissions if the resource doesn't exist.
|
2381
2919
|
#
|
2382
2920
|
# Supported resources are:
|
2383
|
-
# - Tag templates.
|
2384
|
-
# - Entries.
|
2385
|
-
# - Entry groups.
|
2386
|
-
# Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
|
2387
|
-
# and any external Google Cloud Platform resources synced to Data Catalog.
|
2388
2921
|
#
|
2389
|
-
#
|
2390
|
-
#
|
2922
|
+
# - Tag templates
|
2923
|
+
# - Entry groups
|
2924
|
+
#
|
2925
|
+
# Note: This method gets policies only within Data Catalog and can't be
|
2926
|
+
# used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
|
2927
|
+
# external Google Cloud Platform resources ingested into Data Catalog.
|
2928
|
+
#
|
2929
|
+
# No Google IAM permissions are required to call this method.
|
2391
2930
|
#
|
2392
2931
|
# @overload test_iam_permissions(request, options = nil)
|
2393
2932
|
# Pass arguments to `test_iam_permissions` via a request object, either of type
|
@@ -2421,6 +2960,21 @@ module Google
|
|
2421
2960
|
#
|
2422
2961
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2423
2962
|
#
|
2963
|
+
# @example Basic example
|
2964
|
+
# require "google/cloud/data_catalog/v1"
|
2965
|
+
#
|
2966
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2967
|
+
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
|
2968
|
+
#
|
2969
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2970
|
+
# request = Google::Iam::V1::TestIamPermissionsRequest.new
|
2971
|
+
#
|
2972
|
+
# # Call the test_iam_permissions method.
|
2973
|
+
# result = client.test_iam_permissions request
|
2974
|
+
#
|
2975
|
+
# # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
|
2976
|
+
# p result
|
2977
|
+
#
|
2424
2978
|
def test_iam_permissions request, options = nil
|
2425
2979
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
2426
2980
|
|
@@ -2438,16 +2992,20 @@ module Google
|
|
2438
2992
|
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
|
2439
2993
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2440
2994
|
|
2441
|
-
header_params = {
|
2442
|
-
|
2443
|
-
|
2995
|
+
header_params = {}
|
2996
|
+
if request.resource
|
2997
|
+
header_params["resource"] = request.resource
|
2998
|
+
end
|
2999
|
+
|
2444
3000
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2445
3001
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
2446
3002
|
|
2447
3003
|
options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
|
2448
3004
|
metadata: metadata,
|
2449
3005
|
retry_policy: @config.rpcs.test_iam_permissions.retry_policy
|
2450
|
-
|
3006
|
+
|
3007
|
+
options.apply_defaults timeout: @config.timeout,
|
3008
|
+
metadata: @config.metadata,
|
2451
3009
|
retry_policy: @config.retry_policy
|
2452
3010
|
|
2453
3011
|
@data_catalog_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
|
@@ -2471,22 +3029,21 @@ module Google
|
|
2471
3029
|
# Configuration can be applied globally to all clients, or to a single client
|
2472
3030
|
# on construction.
|
2473
3031
|
#
|
2474
|
-
#
|
2475
|
-
#
|
2476
|
-
#
|
2477
|
-
# to 20 seconds,
|
2478
|
-
#
|
2479
|
-
#
|
2480
|
-
#
|
2481
|
-
#
|
2482
|
-
#
|
2483
|
-
#
|
2484
|
-
#
|
2485
|
-
#
|
2486
|
-
#
|
2487
|
-
#
|
2488
|
-
#
|
2489
|
-
# end
|
3032
|
+
# @example
|
3033
|
+
#
|
3034
|
+
# # Modify the global config, setting the timeout for
|
3035
|
+
# # search_catalog to 20 seconds,
|
3036
|
+
# # and all remaining timeouts to 10 seconds.
|
3037
|
+
# ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
|
3038
|
+
# config.timeout = 10.0
|
3039
|
+
# config.rpcs.search_catalog.timeout = 20.0
|
3040
|
+
# end
|
3041
|
+
#
|
3042
|
+
# # Apply the above configuration only to a new client.
|
3043
|
+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
|
3044
|
+
# config.timeout = 10.0
|
3045
|
+
# config.rpcs.search_catalog.timeout = 20.0
|
3046
|
+
# end
|
2490
3047
|
#
|
2491
3048
|
# @!attribute [rw] endpoint
|
2492
3049
|
# The hostname or hostname:port of the service endpoint.
|