google-cloud-data_catalog-v1 0.7.1 → 0.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -1
  4. data/lib/google/cloud/data_catalog/v1/data_catalog.rb +2 -2
  5. data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +424 -387
  6. data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +1 -1
  7. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +123 -95
  8. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +4 -3
  9. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +142 -56
  10. data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
  11. data/lib/google/cloud/datacatalog/v1/bigquery_pb.rb +48 -0
  12. data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +44 -0
  13. data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +179 -142
  14. data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +15 -14
  15. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +5 -0
  16. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +28 -14
  17. data/lib/google/cloud/datacatalog/v1/tags_pb.rb +3 -0
  18. data/lib/google/cloud/datacatalog/v1/usage_pb.rb +31 -0
  19. data/proto_docs/google/api/field_behavior.rb +7 -1
  20. data/proto_docs/google/cloud/datacatalog/v1/bigquery.rb +87 -0
  21. data/proto_docs/google/cloud/datacatalog/v1/common.rb +1 -2
  22. data/proto_docs/google/cloud/datacatalog/v1/data_source.rb +6 -5
  23. data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +370 -246
  24. data/proto_docs/google/cloud/datacatalog/v1/gcs_fileset_spec.rb +16 -15
  25. data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +87 -71
  26. data/proto_docs/google/cloud/datacatalog/v1/policytagmanagerserialization.rb +34 -19
  27. data/proto_docs/google/cloud/datacatalog/v1/schema.rb +3 -3
  28. data/proto_docs/google/cloud/datacatalog/v1/search.rb +43 -29
  29. data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +23 -16
  30. data/proto_docs/google/cloud/datacatalog/v1/tags.rb +96 -51
  31. data/proto_docs/google/cloud/datacatalog/v1/timestamps.rb +12 -5
  32. data/proto_docs/google/cloud/datacatalog/v1/usage.rb +79 -0
  33. data/proto_docs/google/type/expr.rb +35 -12
  34. metadata +19 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ccfce301132791496c6c88a8d4db10326a8c977c581f4b24c698743175d07c6c
4
- data.tar.gz: 43209d12556e78f830eca8cd8f2f59a2edcf26fd7e4833787d37e86bc1d87287
3
+ metadata.gz: 2e66f2b0c171f550be083e9c80ea37e49d2f28ea6c73e86061f7ff5491a27ba9
4
+ data.tar.gz: 8735ad84c57303a81e6c12a24e51f303d62a4920b872bc301d9e3d0dfe2a4308
5
5
  SHA512:
6
- metadata.gz: 82c70e9051dae8b13e67d26764905b2628d4375010c8a82cc9dc0033b04c4fbc819613dda23a475ad3178db5514f742f405437467090726faea37425c624d2ca
7
- data.tar.gz: 37833251c835ab6a661e6a18e2e65f9809d1b6d3fbe70c11d1eb313e10e475f381598723949046dd63a91e4a22c0ad7d95438a3c6c5e6f1a679a8a8f01985b7f
6
+ metadata.gz: dfae23655cd8eb017f18b070a9f1f309bbee5d0903178612b305fda1df811a2d86fc07e9502846139ef6eb52d381e1afd581f3f1ac4e005bd1f7f05278cca0de
7
+ data.tar.gz: 9e49af68b78769cd2a27705e613cc60e360f58028641953506f24dbe9293de707010535713dfc36e2c998e0adab7793ae1319ae1a286c50c9420b29dea2cbded
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-data_catalog-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::DataCatalog::V1::DataCatalog::Credentials}):
68
68
 
69
- 1. `DATA_CATALOG_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `DATA_CATALOG_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `DATA_CATALOG_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `DATA_CATALOG_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/data_catalog/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/data_catalog/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/data_catalog/v1"
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/data_catalog/v1"
34
34
 
35
35
  client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest.new # (request fields as keyword arguments...)
37
37
  response = client.search_catalog request
38
38
  ```
39
39
 
@@ -31,8 +31,8 @@ module Google
31
31
  module DataCatalog
32
32
  module V1
33
33
  ##
34
- # Data Catalog API service allows clients to discover, understand, and manage
35
- # their data.
34
+ # Data Catalog API service allows you to discover, understand, and manage
35
+ # your data.
36
36
  #
37
37
  # To load this service and instantiate a client:
38
38
  #
@@ -27,8 +27,8 @@ module Google
27
27
  ##
28
28
  # Client for the DataCatalog service.
29
29
  #
30
- # Data Catalog API service allows clients to discover, understand, and manage
31
- # their data.
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
- # ## Example
45
+ # @example
46
46
  #
47
- # To modify the configuration for all DataCatalog clients:
48
- #
49
- # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
50
- # config.timeout = 10.0
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]
@@ -70,66 +69,42 @@ module Google
70
69
 
71
70
  default_config.rpcs.search_catalog.timeout = 60.0
72
71
  default_config.rpcs.search_catalog.retry_policy = {
73
- initial_delay: 0.1,
74
- max_delay: 60.0,
75
- multiplier: 1.3,
76
- retry_codes: [14]
72
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
77
73
  }
78
74
 
79
75
  default_config.rpcs.get_entry_group.timeout = 60.0
80
76
  default_config.rpcs.get_entry_group.retry_policy = {
81
- initial_delay: 0.1,
82
- max_delay: 60.0,
83
- multiplier: 1.3,
84
- retry_codes: [14]
77
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
85
78
  }
86
79
 
87
80
  default_config.rpcs.list_entry_groups.timeout = 60.0
88
81
  default_config.rpcs.list_entry_groups.retry_policy = {
89
- initial_delay: 0.1,
90
- max_delay: 60.0,
91
- multiplier: 1.3,
92
- retry_codes: [14]
82
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
93
83
  }
94
84
 
95
85
  default_config.rpcs.get_entry.timeout = 60.0
96
86
  default_config.rpcs.get_entry.retry_policy = {
97
- initial_delay: 0.1,
98
- max_delay: 60.0,
99
- multiplier: 1.3,
100
- retry_codes: [14]
87
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
101
88
  }
102
89
 
103
90
  default_config.rpcs.lookup_entry.timeout = 60.0
104
91
  default_config.rpcs.lookup_entry.retry_policy = {
105
- initial_delay: 0.1,
106
- max_delay: 60.0,
107
- multiplier: 1.3,
108
- retry_codes: [14]
92
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
109
93
  }
110
94
 
111
95
  default_config.rpcs.list_entries.timeout = 60.0
112
96
  default_config.rpcs.list_entries.retry_policy = {
113
- initial_delay: 0.1,
114
- max_delay: 60.0,
115
- multiplier: 1.3,
116
- retry_codes: [14]
97
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
117
98
  }
118
99
 
119
100
  default_config.rpcs.list_tags.timeout = 60.0
120
101
  default_config.rpcs.list_tags.retry_policy = {
121
- initial_delay: 0.1,
122
- max_delay: 60.0,
123
- multiplier: 1.3,
124
- retry_codes: [14]
102
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
125
103
  }
126
104
 
127
105
  default_config.rpcs.get_iam_policy.timeout = 60.0
128
106
  default_config.rpcs.get_iam_policy.retry_policy = {
129
- initial_delay: 0.1,
130
- max_delay: 60.0,
131
- multiplier: 1.3,
132
- retry_codes: [14]
107
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
133
108
  }
134
109
 
135
110
  default_config
@@ -161,19 +136,15 @@ module Google
161
136
  ##
162
137
  # Create a new DataCatalog client object.
163
138
  #
164
- # ## Examples
165
- #
166
- # To create a new DataCatalog client with the default
167
- # configuration:
139
+ # @example
168
140
  #
169
- # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
141
+ # # Create a client using the default configuration
142
+ # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
170
143
  #
171
- # To create a new DataCatalog client with a custom
172
- # configuration:
173
- #
174
- # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
175
- # config.timeout = 10.0
176
- # end
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
177
148
  #
178
149
  # @yield [config] Configure the DataCatalog client.
179
150
  # @yieldparam config [Client::Configuration]
@@ -193,14 +164,13 @@ module Google
193
164
 
194
165
  # Create credentials
195
166
  credentials = @config.credentials
196
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
167
+ # Use self-signed JWT if the endpoint is unchanged from default,
197
168
  # but only if the default endpoint does not have a region prefix.
198
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
199
- @config.endpoint == Client.configure.endpoint &&
169
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
200
170
  !@config.endpoint.split(".").first.include?("-")
201
171
  credentials ||= Credentials.default scope: @config.scope,
202
172
  enable_self_signed_jwt: enable_self_signed_jwt
203
- if credentials.is_a?(String) || credentials.is_a?(Hash)
173
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
204
174
  credentials = Credentials.new credentials, scope: @config.scope
205
175
  end
206
176
  @quota_project_id = @config.quota_project
@@ -218,22 +188,21 @@ module Google
218
188
  # Service calls
219
189
 
220
190
  ##
221
- # Searches Data Catalog for multiple resources like entries, tags that
191
+ # Searches Data Catalog for multiple resources like entries and tags that
222
192
  # match a query.
223
193
  #
224
- # This is a custom method
225
- # (https://cloud.google.com/apis/design/custom_methods) and does not return
226
- # the complete resource, only the resource identifier and high level
227
- # fields. Clients can subsequently call `Get` methods.
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.
228
198
  #
229
- # Note that Data Catalog search queries do not guarantee full recall. Query
230
- # results that match your query may not be returned, even in subsequent
231
- # result pages. Also note that results returned (and not returned) can vary
232
- # across repeated search queries.
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.
233
203
  #
234
- # See [Data Catalog Search
235
- # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
236
- # for more information.
204
+ # For more information, see [Data Catalog search syntax]
205
+ # (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
237
206
  #
238
207
  # @overload search_catalog(request, options = nil)
239
208
  # Pass arguments to `search_catalog` via a request object, either of type
@@ -251,43 +220,47 @@ module Google
251
220
  # the default parameter values, pass an empty Hash as a request object (see above).
252
221
  #
253
222
  # @param scope [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, ::Hash]
254
- # Required. The scope of this search request. A `scope` that has empty
255
- # `include_org_ids`, `include_project_ids` AND false
256
- # `include_gcp_public_datasets` is considered invalid. Data Catalog will
257
- # return an error in such a case.
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.
258
228
  # @param query [::String]
259
- # Optional. The query string in search query syntax. An empty query string will result
260
- # in all data assets (in the specified scope) that the user has access to.
229
+ # Optional. The query string with a minimum of 3 characters and specific syntax.
230
+ # For more information, see
231
+ # [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference).
261
232
  #
262
- # Query strings can be simple as "x" or more qualified as:
233
+ # An empty query string returns all data assets (in the specified scope)
234
+ # that you have access to.
263
235
  #
264
- # * name:x
265
- # * column:x
266
- # * description:y
236
+ # A query string can be a simple `xyz` or qualified by predicates:
267
237
  #
268
- # Note: Query tokens need to have a minimum of 3 characters for substring
269
- # matching to work correctly. See [Data Catalog Search
270
- # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
271
- # for more information.
238
+ # * `name:x`
239
+ # * `column:y`
240
+ # * `description:z`
272
241
  # @param page_size [::Integer]
273
- # Number of results in the search page. If <=0 then defaults to 10. Max limit
274
- # for page_size is 1000. Throws an invalid argument for page_size > 1000.
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.
275
247
  # @param page_token [::String]
276
- # Optional. Pagination token returned in an earlier
277
- # {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}, which
278
- # indicates that this is a continuation of a prior
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
279
253
  # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
280
- # call, and that the system should return the next page of data. If empty,
281
- # the first page is returned.
254
+ # call.
282
255
  # @param order_by [::String]
283
- # Specifies the ordering of results, currently supported case-sensitive
284
- # choices are:
256
+ # Specifies the order of results.
257
+ #
258
+ # Currently supported case-sensitive values are:
285
259
  #
286
- # * `relevance`, only supports descending
287
- # * `last_modified_timestamp [asc|desc]`, defaults to descending if not
288
- # specified
260
+ # * `relevance` that can only be descending
261
+ # * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
289
262
  #
290
- # If not specified, defaults to `relevance` descending.
263
+ # If this parameter is omitted, it defaults to the descending `relevance`.
291
264
  #
292
265
  # @yield [response, operation] Access the result along with the RPC operation
293
266
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
@@ -317,7 +290,9 @@ module Google
317
290
  options.apply_defaults timeout: @config.rpcs.search_catalog.timeout,
318
291
  metadata: metadata,
319
292
  retry_policy: @config.rpcs.search_catalog.retry_policy
320
- options.apply_defaults metadata: @config.metadata,
293
+
294
+ options.apply_defaults timeout: @config.timeout,
295
+ metadata: @config.metadata,
321
296
  retry_policy: @config.retry_policy
322
297
 
323
298
  @data_catalog_stub.call_rpc :search_catalog, request, options: options do |response, operation|
@@ -330,25 +305,33 @@ module Google
330
305
  end
331
306
 
332
307
  ##
333
- # Creates an EntryGroup.
308
+ # Creates an entry group.
309
+ #
310
+ # An entry group contains logically related entries together with [Cloud
311
+ # Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
312
+ # These policies specify users who can create, edit, and view entries
313
+ # within entry groups.
314
+ #
315
+ # Data Catalog automatically creates entry groups with names that start with
316
+ # the `@` symbol for the following resources:
317
+ #
318
+ # * BigQuery entries (`@bigquery`)
319
+ # * Pub/Sub topics (`@pubsub`)
320
+ # * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
334
321
  #
335
- # An entry group contains logically related entries together with Cloud
336
- # Identity and Access Management policies that specify the users who can
337
- # create, edit, and view entries within the entry group.
322
+ # You can create your own entry groups for Cloud Storage fileset entries
323
+ # and custom entries together with the corresponding IAM policies.
324
+ # User-created entry groups can't contain the `@` symbol, it is reserved
325
+ # for automatically created groups.
338
326
  #
339
- # Data Catalog automatically creates an entry group for BigQuery entries
340
- # ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry
341
- # group to contain Cloud Storage fileset entries or custom type entries,
342
- # and the IAM policies associated with those entries. Entry groups, like
343
- # entries, can be searched.
327
+ # Entry groups, like entries, can be searched.
344
328
  #
345
329
  # A maximum of 10,000 entry groups may be created per organization across all
346
330
  # locations.
347
331
  #
348
- # Users should enable the Data Catalog API in the project identified by
349
- # the `parent` parameter (see [Data Catalog Resource Project]
350
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
351
- # more information).
332
+ # You must enable the Data Catalog API in the project identified by
333
+ # the `parent` parameter. For more information, see [Data Catalog resource
334
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
352
335
  #
353
336
  # @overload create_entry_group(request, options = nil)
354
337
  # Pass arguments to `create_entry_group` via a request object, either of type
@@ -366,9 +349,7 @@ module Google
366
349
  # the default parameter values, pass an empty Hash as a request object (see above).
367
350
  #
368
351
  # @param parent [::String]
369
- # Required. The name of the project this entry group belongs to. Example:
370
- #
371
- # `projects/{project_id}/locations/{location}`
352
+ # Required. The names of the project and location that the new entry group belongs to.
372
353
  #
373
354
  # Note: The entry group itself and its child resources might not be
374
355
  # stored in the location specified in its name.
@@ -379,7 +360,7 @@ module Google
379
360
  # underscores (_), and must start with a letter or underscore.
380
361
  # The maximum size is 64 bytes when encoded in UTF-8.
381
362
  # @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
382
- # The entry group to create. Defaults to an empty entry group.
363
+ # The entry group to create. Defaults to empty.
383
364
  #
384
365
  # @yield [response, operation] Access the result along with the RPC operation
385
366
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
@@ -415,7 +396,9 @@ module Google
415
396
  options.apply_defaults timeout: @config.rpcs.create_entry_group.timeout,
416
397
  metadata: metadata,
417
398
  retry_policy: @config.rpcs.create_entry_group.retry_policy
418
- options.apply_defaults metadata: @config.metadata,
399
+
400
+ options.apply_defaults timeout: @config.timeout,
401
+ metadata: @config.metadata,
419
402
  retry_policy: @config.retry_policy
420
403
 
421
404
  @data_catalog_stub.call_rpc :create_entry_group, request, options: options do |response, operation|
@@ -427,7 +410,7 @@ module Google
427
410
  end
428
411
 
429
412
  ##
430
- # Gets an EntryGroup.
413
+ # Gets an entry group.
431
414
  #
432
415
  # @overload get_entry_group(request, options = nil)
433
416
  # Pass arguments to `get_entry_group` via a request object, either of type
@@ -445,10 +428,9 @@ module Google
445
428
  # the default parameter values, pass an empty Hash as a request object (see above).
446
429
  #
447
430
  # @param name [::String]
448
- # Required. The name of the entry group. For example,
449
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
431
+ # Required. The name of the entry group to get.
450
432
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
451
- # The fields to return. If not set or empty, all fields are returned.
433
+ # The fields to return. If empty or omitted, all fields are returned.
452
434
  #
453
435
  # @yield [response, operation] Access the result along with the RPC operation
454
436
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
@@ -484,7 +466,9 @@ module Google
484
466
  options.apply_defaults timeout: @config.rpcs.get_entry_group.timeout,
485
467
  metadata: metadata,
486
468
  retry_policy: @config.rpcs.get_entry_group.retry_policy
487
- options.apply_defaults metadata: @config.metadata,
469
+
470
+ options.apply_defaults timeout: @config.timeout,
471
+ metadata: @config.metadata,
488
472
  retry_policy: @config.retry_policy
489
473
 
490
474
  @data_catalog_stub.call_rpc :get_entry_group, request, options: options do |response, operation|
@@ -496,11 +480,12 @@ module Google
496
480
  end
497
481
 
498
482
  ##
499
- # Updates an EntryGroup. The user should enable the Data Catalog API in the
500
- # project identified by the `entry_group.name` parameter (see [Data Catalog
501
- # Resource Project]
502
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
503
- # more information).
483
+ # Updates an entry group.
484
+ #
485
+ # You must enable the Data Catalog API in the project identified by
486
+ # the `entry_group.name` parameter. For more information, see [Data Catalog
487
+ # resource
488
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
504
489
  #
505
490
  # @overload update_entry_group(request, options = nil)
506
491
  # Pass arguments to `update_entry_group` via a request object, either of type
@@ -518,7 +503,7 @@ module Google
518
503
  # the default parameter values, pass an empty Hash as a request object (see above).
519
504
  #
520
505
  # @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
521
- # Required. The updated entry group. "name" field must be set.
506
+ # Required. Updates for the entry group. The `name` field must be set.
522
507
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
523
508
  # Names of fields whose values to overwrite on an entry group.
524
509
  #
@@ -560,7 +545,9 @@ module Google
560
545
  options.apply_defaults timeout: @config.rpcs.update_entry_group.timeout,
561
546
  metadata: metadata,
562
547
  retry_policy: @config.rpcs.update_entry_group.retry_policy
563
- options.apply_defaults metadata: @config.metadata,
548
+
549
+ options.apply_defaults timeout: @config.timeout,
550
+ metadata: @config.metadata,
564
551
  retry_policy: @config.retry_policy
565
552
 
566
553
  @data_catalog_stub.call_rpc :update_entry_group, request, options: options do |response, operation|
@@ -572,11 +559,12 @@ module Google
572
559
  end
573
560
 
574
561
  ##
575
- # Deletes an EntryGroup. Only entry groups that do not contain entries can be
576
- # deleted. Users should enable the Data Catalog API in the project
577
- # identified by the `name` parameter (see [Data Catalog Resource Project]
578
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
579
- # more information).
562
+ # Deletes an entry group.
563
+ #
564
+ # You must enable the Data Catalog API in the project
565
+ # identified by the `name` parameter. For more information, see [Data Catalog
566
+ # resource
567
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
580
568
  #
581
569
  # @overload delete_entry_group(request, options = nil)
582
570
  # Pass arguments to `delete_entry_group` via a request object, either of type
@@ -594,8 +582,7 @@ module Google
594
582
  # the default parameter values, pass an empty Hash as a request object (see above).
595
583
  #
596
584
  # @param name [::String]
597
- # Required. The name of the entry group. For example,
598
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
585
+ # Required. The name of the entry group to delete.
599
586
  # @param force [::Boolean]
600
587
  # Optional. If true, deletes all entries in the entry group.
601
588
  #
@@ -633,7 +620,9 @@ module Google
633
620
  options.apply_defaults timeout: @config.rpcs.delete_entry_group.timeout,
634
621
  metadata: metadata,
635
622
  retry_policy: @config.rpcs.delete_entry_group.retry_policy
636
- options.apply_defaults metadata: @config.metadata,
623
+
624
+ options.apply_defaults timeout: @config.timeout,
625
+ metadata: @config.metadata,
637
626
  retry_policy: @config.retry_policy
638
627
 
639
628
  @data_catalog_stub.call_rpc :delete_entry_group, request, options: options do |response, operation|
@@ -663,16 +652,17 @@ module Google
663
652
  # the default parameter values, pass an empty Hash as a request object (see above).
664
653
  #
665
654
  # @param parent [::String]
666
- # Required. The name of the location that contains the entry groups, which can be
667
- # provided in URL format. Example:
655
+ # Required. The name of the location that contains the entry groups to list.
668
656
  #
669
- # * projects/\\{project_id}/locations/\\{location}
657
+ # Can be provided as a URL.
670
658
  # @param page_size [::Integer]
671
- # Optional. The maximum number of items to return. Default is 10. Max limit is 1000.
672
- # Throws an invalid argument for `page_size > 1000`.
659
+ # Optional. The maximum number of items to return.
660
+ #
661
+ # Default is 10. Maximum limit is 1000.
662
+ # Throws an invalid argument if `page_size` is greater than 1000.
673
663
  # @param page_token [::String]
674
- # Optional. Token that specifies which page is requested. If empty, the first page is
675
- # returned.
664
+ # Optional. Pagination token that specifies the next page to return.
665
+ # If empty, returns the first page.
676
666
  #
677
667
  # @yield [response, operation] Access the result along with the RPC operation
678
668
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
@@ -708,7 +698,9 @@ module Google
708
698
  options.apply_defaults timeout: @config.rpcs.list_entry_groups.timeout,
709
699
  metadata: metadata,
710
700
  retry_policy: @config.rpcs.list_entry_groups.retry_policy
711
- options.apply_defaults metadata: @config.metadata,
701
+
702
+ options.apply_defaults timeout: @config.timeout,
703
+ metadata: @config.metadata,
712
704
  retry_policy: @config.retry_policy
713
705
 
714
706
  @data_catalog_stub.call_rpc :list_entry_groups, request, options: options do |response, operation|
@@ -721,15 +713,17 @@ module Google
721
713
  end
722
714
 
723
715
  ##
724
- # Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM'
725
- # or with a user-specified type can be created.
716
+ # Creates an entry.
717
+ #
718
+ # You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
719
+ # or custom types. Data Catalog automatically creates entries with other
720
+ # types during metadata ingestion from integrated systems.
726
721
  #
727
- # Users should enable the Data Catalog API in the project identified by
728
- # the `parent` parameter (see [Data Catalog Resource Project]
729
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
730
- # more information).
722
+ # You must enable the Data Catalog API in the project identified by
723
+ # the `parent` parameter. For more information, see [Data Catalog resource
724
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
731
725
  #
732
- # A maximum of 100,000 entries may be created per entry group.
726
+ # An entry group can have a maximum of 100,000 entries.
733
727
  #
734
728
  # @overload create_entry(request, options = nil)
735
729
  # Pass arguments to `create_entry` via a request object, either of type
@@ -747,9 +741,7 @@ module Google
747
741
  # the default parameter values, pass an empty Hash as a request object (see above).
748
742
  #
749
743
  # @param parent [::String]
750
- # Required. The name of the entry group this entry belongs to. Example:
751
- #
752
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`
744
+ # Required. The name of the entry group this entry belongs to.
753
745
  #
754
746
  # Note: The entry itself and its child resources might not be stored in
755
747
  # the location specified in its name.
@@ -796,7 +788,9 @@ module Google
796
788
  options.apply_defaults timeout: @config.rpcs.create_entry.timeout,
797
789
  metadata: metadata,
798
790
  retry_policy: @config.rpcs.create_entry.retry_policy
799
- options.apply_defaults metadata: @config.metadata,
791
+
792
+ options.apply_defaults timeout: @config.timeout,
793
+ metadata: @config.metadata,
800
794
  retry_policy: @config.retry_policy
801
795
 
802
796
  @data_catalog_stub.call_rpc :create_entry, request, options: options do |response, operation|
@@ -809,10 +803,11 @@ module Google
809
803
 
810
804
  ##
811
805
  # Updates an existing entry.
812
- # Users should enable the Data Catalog API in the project identified by
813
- # the `entry.name` parameter (see [Data Catalog Resource Project]
814
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
815
- # more information).
806
+ #
807
+ # You must enable the Data Catalog API in the project identified by
808
+ # the `entry.name` parameter. For more information, see [Data Catalog
809
+ # resource
810
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
816
811
  #
817
812
  # @overload update_entry(request, options = nil)
818
813
  # Pass arguments to `update_entry` via a request object, either of type
@@ -830,7 +825,7 @@ module Google
830
825
  # the default parameter values, pass an empty Hash as a request object (see above).
831
826
  #
832
827
  # @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
833
- # Required. The updated entry. The "name" field must be set.
828
+ # Required. Updates for the entry. The `name` field must be set.
834
829
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
835
830
  # Names of fields whose values to overwrite on an entry.
836
831
  #
@@ -838,24 +833,29 @@ module Google
838
833
  # are overwritten. If such fields are non-required and omitted in the
839
834
  # request body, their values are emptied.
840
835
  #
841
- # The following fields are modifiable:
842
- #
843
- # * For entries with type `DATA_STREAM`:
844
- # * `schema`
845
- # * For entries with type `FILESET`:
846
- # * `schema`
847
- # * `display_name`
848
- # * `description`
849
- # * `gcs_fileset_spec`
850
- # * `gcs_fileset_spec.file_patterns`
851
- # * For entries with `user_specified_type`:
852
- # * `schema`
853
- # * `display_name`
854
- # * `description`
855
- # * `user_specified_type`
856
- # * `user_specified_system`
857
- # * `linked_resource`
858
- # * `source_system_timestamps`
836
+ # You can modify only the fields listed below.
837
+ #
838
+ # For entries with type `DATA_STREAM`:
839
+ #
840
+ # * `schema`
841
+ #
842
+ # For entries with type `FILESET`:
843
+ #
844
+ # * `schema`
845
+ # * `display_name`
846
+ # * `description`
847
+ # * `gcs_fileset_spec`
848
+ # * `gcs_fileset_spec.file_patterns`
849
+ #
850
+ # For entries with `user_specified_type`:
851
+ #
852
+ # * `schema`
853
+ # * `display_name`
854
+ # * `description`
855
+ # * `user_specified_type`
856
+ # * `user_specified_system`
857
+ # * `linked_resource`
858
+ # * `source_system_timestamps`
859
859
  #
860
860
  # @yield [response, operation] Access the result along with the RPC operation
861
861
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -891,7 +891,9 @@ module Google
891
891
  options.apply_defaults timeout: @config.rpcs.update_entry.timeout,
892
892
  metadata: metadata,
893
893
  retry_policy: @config.rpcs.update_entry.retry_policy
894
- options.apply_defaults metadata: @config.metadata,
894
+
895
+ options.apply_defaults timeout: @config.timeout,
896
+ metadata: @config.metadata,
895
897
  retry_policy: @config.retry_policy
896
898
 
897
899
  @data_catalog_stub.call_rpc :update_entry, request, options: options do |response, operation|
@@ -903,13 +905,16 @@ module Google
903
905
  end
904
906
 
905
907
  ##
906
- # Deletes an existing entry. Only entries created through
908
+ # Deletes an existing entry.
909
+ #
910
+ # You can delete only the entries created by the
907
911
  # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}
908
- # method can be deleted.
909
- # Users should enable the Data Catalog API in the project identified by
910
- # the `name` parameter (see [Data Catalog Resource Project]
911
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
912
- # more information).
912
+ # method.
913
+ #
914
+ # You must enable the Data Catalog API in the project identified by
915
+ # the `name` parameter. For more information, see [Data Catalog
916
+ # resource
917
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
913
918
  #
914
919
  # @overload delete_entry(request, options = nil)
915
920
  # Pass arguments to `delete_entry` via a request object, either of type
@@ -927,9 +932,7 @@ module Google
927
932
  # the default parameter values, pass an empty Hash as a request object (see above).
928
933
  #
929
934
  # @param name [::String]
930
- # Required. The name of the entry. Example:
931
- #
932
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
935
+ # Required. The name of the entry to delete.
933
936
  #
934
937
  # @yield [response, operation] Access the result along with the RPC operation
935
938
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -965,7 +968,9 @@ module Google
965
968
  options.apply_defaults timeout: @config.rpcs.delete_entry.timeout,
966
969
  metadata: metadata,
967
970
  retry_policy: @config.rpcs.delete_entry.retry_policy
968
- options.apply_defaults metadata: @config.metadata,
971
+
972
+ options.apply_defaults timeout: @config.timeout,
973
+ metadata: @config.metadata,
969
974
  retry_policy: @config.retry_policy
970
975
 
971
976
  @data_catalog_stub.call_rpc :delete_entry, request, options: options do |response, operation|
@@ -995,9 +1000,7 @@ module Google
995
1000
  # the default parameter values, pass an empty Hash as a request object (see above).
996
1001
  #
997
1002
  # @param name [::String]
998
- # Required. The name of the entry. Example:
999
- #
1000
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
1003
+ # Required. The name of the entry to get.
1001
1004
  #
1002
1005
  # @yield [response, operation] Access the result along with the RPC operation
1003
1006
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -1033,7 +1036,9 @@ module Google
1033
1036
  options.apply_defaults timeout: @config.rpcs.get_entry.timeout,
1034
1037
  metadata: metadata,
1035
1038
  retry_policy: @config.rpcs.get_entry.retry_policy
1036
- options.apply_defaults metadata: @config.metadata,
1039
+
1040
+ options.apply_defaults timeout: @config.timeout,
1041
+ metadata: @config.metadata,
1037
1042
  retry_policy: @config.retry_policy
1038
1043
 
1039
1044
  @data_catalog_stub.call_rpc :get_entry, request, options: options do |response, operation|
@@ -1045,9 +1050,9 @@ module Google
1045
1050
  end
1046
1051
 
1047
1052
  ##
1048
- # Get an entry by target resource name. This method allows clients to use
1049
- # the resource name from the source Google Cloud Platform service to get the
1050
- # Data Catalog Entry.
1053
+ # Gets an entry by its target resource name.
1054
+ #
1055
+ # The resource name comes from the source Google Cloud Platform service.
1051
1056
  #
1052
1057
  # @overload lookup_entry(request, options = nil)
1053
1058
  # Pass arguments to `lookup_entry` via a request object, either of type
@@ -1066,27 +1071,27 @@ module Google
1066
1071
  #
1067
1072
  # @param linked_resource [::String]
1068
1073
  # The full name of the Google Cloud Platform resource the Data Catalog
1069
- # entry represents. See:
1070
- # https://cloud.google.com/apis/design/resource_names#full_resource_name.
1071
- # Full names are case-sensitive.
1074
+ # entry represents. For more information, see [Full Resource Name]
1075
+ # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
1072
1076
  #
1073
- # Examples:
1077
+ # Full names are case-sensitive. For example:
1074
1078
  #
1075
- # * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
1076
- # * //pubsub.googleapis.com/projects/projectId/topics/topicId
1079
+ # * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
1080
+ # * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
1077
1081
  # @param sql_resource [::String]
1078
1082
  # The SQL name of the entry. SQL names are case-sensitive.
1079
1083
  #
1080
1084
  # Examples:
1081
1085
  #
1082
- # * `pubsub.project_id.topic_id`
1083
- # * ``pubsub.project_id.`topic.id.with.dots` ``
1084
- # * `bigquery.table.project_id.dataset_id.table_id`
1085
- # * `bigquery.dataset.project_id.dataset_id`
1086
- # * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id`
1086
+ # * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
1087
+ # * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
1088
+ # * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
1089
+ # * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
1090
+ # * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
1087
1091
  #
1088
- # `*_id`s should satisfy the standard SQL rules for identifiers.
1089
- # https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
1092
+ # Identifiers (`*_ID`) should comply with the
1093
+ # [Lexical structure in Standard SQL]
1094
+ # (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
1090
1095
  # @param fully_qualified_name [::String]
1091
1096
  # Fully qualified name (FQN) of the resource.
1092
1097
  #
@@ -1102,7 +1107,7 @@ module Google
1102
1107
  #
1103
1108
  # Example for a DPMS table:
1104
1109
  #
1105
- # `dataproc_metastore:project_id.location_id.instance_id.database_id.table_id`
1110
+ # `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
1106
1111
  #
1107
1112
  # @yield [response, operation] Access the result along with the RPC operation
1108
1113
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -1132,7 +1137,9 @@ module Google
1132
1137
  options.apply_defaults timeout: @config.rpcs.lookup_entry.timeout,
1133
1138
  metadata: metadata,
1134
1139
  retry_policy: @config.rpcs.lookup_entry.retry_policy
1135
- options.apply_defaults metadata: @config.metadata,
1140
+
1141
+ options.apply_defaults timeout: @config.timeout,
1142
+ metadata: @config.metadata,
1136
1143
  retry_policy: @config.retry_policy
1137
1144
 
1138
1145
  @data_catalog_stub.call_rpc :lookup_entry, request, options: options do |response, operation|
@@ -1162,21 +1169,21 @@ module Google
1162
1169
  # the default parameter values, pass an empty Hash as a request object (see above).
1163
1170
  #
1164
1171
  # @param parent [::String]
1165
- # Required. The name of the entry group that contains the entries, which can
1166
- # be provided in URL format. Example:
1172
+ # Required. The name of the entry group that contains the entries to list.
1167
1173
  #
1168
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
1174
+ # Can be provided in URL format.
1169
1175
  # @param page_size [::Integer]
1170
- # The maximum number of items to return. Default is 10. Max limit is 1000.
1171
- # Throws an invalid argument for `page_size > 1000`.
1176
+ # The maximum number of items to return. Default is 10. Maximum limit is
1177
+ # 1000. Throws an invalid argument if `page_size` is more than 1000.
1172
1178
  # @param page_token [::String]
1173
- # Token that specifies which page is requested. If empty, the first page is
1174
- # returned.
1179
+ # Pagination token that specifies the next page to return. If empty, the
1180
+ # first page is returned.
1175
1181
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1176
- # The fields to return for each Entry. If not set or empty, all
1182
+ # The fields to return for each entry. If empty or omitted, all
1177
1183
  # fields are returned.
1178
- # For example, setting read_mask to contain only one path "name" will cause
1179
- # ListEntries to return a list of Entries with only "name" field.
1184
+ #
1185
+ # For example, to return a list of entries with only the `name` field,
1186
+ # set `read_mask` to only one path with the `name` value.
1180
1187
  #
1181
1188
  # @yield [response, operation] Access the result along with the RPC operation
1182
1189
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>]
@@ -1212,7 +1219,9 @@ module Google
1212
1219
  options.apply_defaults timeout: @config.rpcs.list_entries.timeout,
1213
1220
  metadata: metadata,
1214
1221
  retry_policy: @config.rpcs.list_entries.retry_policy
1215
- options.apply_defaults metadata: @config.metadata,
1222
+
1223
+ options.apply_defaults timeout: @config.timeout,
1224
+ metadata: @config.metadata,
1216
1225
  retry_policy: @config.retry_policy
1217
1226
 
1218
1227
  @data_catalog_stub.call_rpc :list_entries, request, options: options do |response, operation|
@@ -1225,11 +1234,12 @@ module Google
1225
1234
  end
1226
1235
 
1227
1236
  ##
1228
- # Creates a tag template. The user should enable the Data Catalog API in
1229
- # the project identified by the `parent` parameter (see [Data Catalog
1230
- # Resource
1231
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
1232
- # for more information).
1237
+ # Creates a tag template.
1238
+ #
1239
+ # You must enable the Data Catalog API in the project identified by the
1240
+ # `parent` parameter.
1241
+ # For more information, see [Data Catalog resource project]
1242
+ # (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1233
1243
  #
1234
1244
  # @overload create_tag_template(request, options = nil)
1235
1245
  # Pass arguments to `create_tag_template` via a request object, either of type
@@ -1249,10 +1259,6 @@ module Google
1249
1259
  # @param parent [::String]
1250
1260
  # Required. The name of the project and the template location
1251
1261
  # [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
1252
- #
1253
- # Example:
1254
- #
1255
- # * projects/\\{project_id}/locations/us-central1
1256
1262
  # @param tag_template_id [::String]
1257
1263
  # Required. The ID of the tag template to create.
1258
1264
  #
@@ -1296,7 +1302,9 @@ module Google
1296
1302
  options.apply_defaults timeout: @config.rpcs.create_tag_template.timeout,
1297
1303
  metadata: metadata,
1298
1304
  retry_policy: @config.rpcs.create_tag_template.retry_policy
1299
- options.apply_defaults metadata: @config.metadata,
1305
+
1306
+ options.apply_defaults timeout: @config.timeout,
1307
+ metadata: @config.metadata,
1300
1308
  retry_policy: @config.retry_policy
1301
1309
 
1302
1310
  @data_catalog_stub.call_rpc :create_tag_template, request, options: options do |response, operation|
@@ -1326,9 +1334,7 @@ module Google
1326
1334
  # the default parameter values, pass an empty Hash as a request object (see above).
1327
1335
  #
1328
1336
  # @param name [::String]
1329
- # Required. The name of the tag template. Example:
1330
- #
1331
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
1337
+ # Required. The name of the tag template to get.
1332
1338
  #
1333
1339
  # @yield [response, operation] Access the result along with the RPC operation
1334
1340
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplate]
@@ -1364,7 +1370,9 @@ module Google
1364
1370
  options.apply_defaults timeout: @config.rpcs.get_tag_template.timeout,
1365
1371
  metadata: metadata,
1366
1372
  retry_policy: @config.rpcs.get_tag_template.retry_policy
1367
- options.apply_defaults metadata: @config.metadata,
1373
+
1374
+ options.apply_defaults timeout: @config.timeout,
1375
+ metadata: @config.metadata,
1368
1376
  retry_policy: @config.retry_policy
1369
1377
 
1370
1378
  @data_catalog_stub.call_rpc :get_tag_template, request, options: options do |response, operation|
@@ -1376,13 +1384,15 @@ module Google
1376
1384
  end
1377
1385
 
1378
1386
  ##
1379
- # Updates a tag template. This method cannot be used to update the fields of
1380
- # a template. The tag template fields are represented as separate resources
1381
- # and should be updated using their own create/update/delete methods.
1382
- # Users should enable the Data Catalog API in the project identified by
1383
- # the `tag_template.name` parameter (see [Data Catalog Resource Project]
1384
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1385
- # more information).
1387
+ # Updates a tag template.
1388
+ #
1389
+ # You can't update template fields with this method. These fields are
1390
+ # separate resources with their own create, update, and delete methods.
1391
+ #
1392
+ # You must enable the Data Catalog API in the project identified by
1393
+ # the `tag_template.name` parameter. For more information, see [Data Catalog
1394
+ # resource
1395
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1386
1396
  #
1387
1397
  # @overload update_tag_template(request, options = nil)
1388
1398
  # Pass arguments to `update_tag_template` via a request object, either of type
@@ -1400,12 +1410,12 @@ module Google
1400
1410
  # the default parameter values, pass an empty Hash as a request object (see above).
1401
1411
  #
1402
1412
  # @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
1403
- # Required. The template to update. The "name" field must be set.
1413
+ # Required. The template to update. The `name` field must be set.
1404
1414
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1405
1415
  # Names of fields whose values to overwrite on a tag template. Currently,
1406
1416
  # only `display_name` can be overwritten.
1407
1417
  #
1408
- # In general, if this parameter is absent or empty, all modifiable fields
1418
+ # If this parameter is absent or empty, all modifiable fields
1409
1419
  # are overwritten. If such fields are non-required and omitted in the
1410
1420
  # request body, their values are emptied.
1411
1421
  #
@@ -1443,7 +1453,9 @@ module Google
1443
1453
  options.apply_defaults timeout: @config.rpcs.update_tag_template.timeout,
1444
1454
  metadata: metadata,
1445
1455
  retry_policy: @config.rpcs.update_tag_template.retry_policy
1446
- options.apply_defaults metadata: @config.metadata,
1456
+
1457
+ options.apply_defaults timeout: @config.timeout,
1458
+ metadata: @config.metadata,
1447
1459
  retry_policy: @config.retry_policy
1448
1460
 
1449
1461
  @data_catalog_stub.call_rpc :update_tag_template, request, options: options do |response, operation|
@@ -1455,11 +1467,11 @@ module Google
1455
1467
  end
1456
1468
 
1457
1469
  ##
1458
- # Deletes a tag template and all tags using the template.
1459
- # Users should enable the Data Catalog API in the project identified by
1460
- # the `name` parameter (see [Data Catalog Resource Project]
1461
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1462
- # more information).
1470
+ # Deletes a tag template and all tags that use it.
1471
+ #
1472
+ # You must enable the Data Catalog API in the project identified by
1473
+ # the `name` parameter. For more information, see [Data Catalog resource
1474
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1463
1475
  #
1464
1476
  # @overload delete_tag_template(request, options = nil)
1465
1477
  # Pass arguments to `delete_tag_template` via a request object, either of type
@@ -1477,13 +1489,11 @@ module Google
1477
1489
  # the default parameter values, pass an empty Hash as a request object (see above).
1478
1490
  #
1479
1491
  # @param name [::String]
1480
- # Required. The name of the tag template to delete. Example:
1481
- #
1482
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
1492
+ # Required. The name of the tag template to delete.
1483
1493
  # @param force [::Boolean]
1484
- # Required. Currently, this field must always be set to `true`.
1485
- # This confirms the deletion of any possible tags using this template.
1486
- # `force = false` will be supported in the future.
1494
+ # Required. If true, deletes all tags that use this template.
1495
+ #
1496
+ # Currently, `true` is the only supported value.
1487
1497
  #
1488
1498
  # @yield [response, operation] Access the result along with the RPC operation
1489
1499
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1519,7 +1529,9 @@ module Google
1519
1529
  options.apply_defaults timeout: @config.rpcs.delete_tag_template.timeout,
1520
1530
  metadata: metadata,
1521
1531
  retry_policy: @config.rpcs.delete_tag_template.retry_policy
1522
- options.apply_defaults metadata: @config.metadata,
1532
+
1533
+ options.apply_defaults timeout: @config.timeout,
1534
+ metadata: @config.metadata,
1523
1535
  retry_policy: @config.retry_policy
1524
1536
 
1525
1537
  @data_catalog_stub.call_rpc :delete_tag_template, request, options: options do |response, operation|
@@ -1531,11 +1543,11 @@ module Google
1531
1543
  end
1532
1544
 
1533
1545
  ##
1534
- # Creates a field in a tag template. The user should enable the Data Catalog
1535
- # API in the project identified by the `parent` parameter (see
1536
- # [Data Catalog Resource
1537
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
1538
- # for more information).
1546
+ # Creates a field in a tag template.
1547
+ #
1548
+ # You must enable the Data Catalog API in the project identified by
1549
+ # the `parent` parameter. For more information, see [Data Catalog resource
1550
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1539
1551
  #
1540
1552
  # @overload create_tag_template_field(request, options = nil)
1541
1553
  # Pass arguments to `create_tag_template_field` via a request object, either of type
@@ -1555,10 +1567,6 @@ module Google
1555
1567
  # @param parent [::String]
1556
1568
  # Required. The name of the project and the template location
1557
1569
  # [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
1558
- #
1559
- # Example:
1560
- #
1561
- # * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
1562
1570
  # @param tag_template_field_id [::String]
1563
1571
  # Required. The ID of the tag template field to create.
1564
1572
  #
@@ -1605,7 +1613,9 @@ module Google
1605
1613
  options.apply_defaults timeout: @config.rpcs.create_tag_template_field.timeout,
1606
1614
  metadata: metadata,
1607
1615
  retry_policy: @config.rpcs.create_tag_template_field.retry_policy
1608
- options.apply_defaults metadata: @config.metadata,
1616
+
1617
+ options.apply_defaults timeout: @config.timeout,
1618
+ metadata: @config.metadata,
1609
1619
  retry_policy: @config.retry_policy
1610
1620
 
1611
1621
  @data_catalog_stub.call_rpc :create_tag_template_field, request, options: options do |response, operation|
@@ -1617,11 +1627,14 @@ module Google
1617
1627
  end
1618
1628
 
1619
1629
  ##
1620
- # Updates a field in a tag template. This method cannot be used to update the
1621
- # field type. Users should enable the Data Catalog API in the project
1622
- # identified by the `name` parameter (see [Data Catalog Resource Project]
1623
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1624
- # more information).
1630
+ # Updates a field in a tag template.
1631
+ #
1632
+ # You can't update the field type with this method.
1633
+ #
1634
+ # You must enable the Data Catalog API in the project
1635
+ # identified by the `name` parameter. For more information, see [Data Catalog
1636
+ # resource
1637
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1625
1638
  #
1626
1639
  # @overload update_tag_template_field(request, options = nil)
1627
1640
  # Pass arguments to `update_tag_template_field` via a request object, either of type
@@ -1639,18 +1652,16 @@ module Google
1639
1652
  # the default parameter values, pass an empty Hash as a request object (see above).
1640
1653
  #
1641
1654
  # @param name [::String]
1642
- # Required. The name of the tag template field. Example:
1643
- #
1644
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1655
+ # Required. The name of the tag template field.
1645
1656
  # @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
1646
1657
  # Required. The template to update.
1647
1658
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1648
1659
  # Optional. Names of fields whose values to overwrite on an individual field of a tag
1649
1660
  # template. The following fields are modifiable:
1650
1661
  #
1651
- # * `display_name`
1652
- # * `type.enum_type`
1653
- # * `is_required`
1662
+ # * `display_name`
1663
+ # * `type.enum_type`
1664
+ # * `is_required`
1654
1665
  #
1655
1666
  # If this parameter is absent or empty, all modifiable fields
1656
1667
  # are overwritten. If such fields are non-required and omitted in the request
@@ -1696,7 +1707,9 @@ module Google
1696
1707
  options.apply_defaults timeout: @config.rpcs.update_tag_template_field.timeout,
1697
1708
  metadata: metadata,
1698
1709
  retry_policy: @config.rpcs.update_tag_template_field.retry_policy
1699
- options.apply_defaults metadata: @config.metadata,
1710
+
1711
+ options.apply_defaults timeout: @config.timeout,
1712
+ metadata: @config.metadata,
1700
1713
  retry_policy: @config.retry_policy
1701
1714
 
1702
1715
  @data_catalog_stub.call_rpc :update_tag_template_field, request, options: options do |response, operation|
@@ -1708,11 +1721,11 @@ module Google
1708
1721
  end
1709
1722
 
1710
1723
  ##
1711
- # Renames a field in a tag template. The user should enable the Data Catalog
1712
- # API in the project identified by the `name` parameter (see [Data Catalog
1713
- # Resource
1714
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
1715
- # for more information).
1724
+ # Renames a field in a tag template.
1725
+ #
1726
+ # You must enable the Data Catalog API in the project identified by the
1727
+ # `name` parameter. For more information, see [Data Catalog resource project]
1728
+ # (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1716
1729
  #
1717
1730
  # @overload rename_tag_template_field(request, options = nil)
1718
1731
  # Pass arguments to `rename_tag_template_field` via a request object, either of type
@@ -1730,9 +1743,7 @@ module Google
1730
1743
  # the default parameter values, pass an empty Hash as a request object (see above).
1731
1744
  #
1732
1745
  # @param name [::String]
1733
- # Required. The name of the tag template. Example:
1734
- #
1735
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1746
+ # Required. The name of the tag template.
1736
1747
  # @param new_tag_template_field_id [::String]
1737
1748
  # Required. The new ID of this tag template field. For example, `my_new_field`.
1738
1749
  #
@@ -1770,7 +1781,9 @@ module Google
1770
1781
  options.apply_defaults timeout: @config.rpcs.rename_tag_template_field.timeout,
1771
1782
  metadata: metadata,
1772
1783
  retry_policy: @config.rpcs.rename_tag_template_field.retry_policy
1773
- options.apply_defaults metadata: @config.metadata,
1784
+
1785
+ options.apply_defaults timeout: @config.timeout,
1786
+ metadata: @config.metadata,
1774
1787
  retry_policy: @config.retry_policy
1775
1788
 
1776
1789
  @data_catalog_stub.call_rpc :rename_tag_template_field, request, options: options do |response, operation|
@@ -1782,8 +1795,9 @@ module Google
1782
1795
  end
1783
1796
 
1784
1797
  ##
1785
- # Renames an enum value in a tag template. The enum values have to be unique
1786
- # within one enum field.
1798
+ # Renames an enum value in a tag template.
1799
+ #
1800
+ # Within a single enum field, enum values must be unique.
1787
1801
  #
1788
1802
  # @overload rename_tag_template_field_enum_value(request, options = nil)
1789
1803
  # Pass arguments to `rename_tag_template_field_enum_value` via a request object, either of type
@@ -1801,9 +1815,7 @@ module Google
1801
1815
  # the default parameter values, pass an empty Hash as a request object (see above).
1802
1816
  #
1803
1817
  # @param name [::String]
1804
- # Required. The name of the enum field value. Example:
1805
- #
1806
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}/enumValues/\\{enum_value_display_name}
1818
+ # Required. The name of the enum field value.
1807
1819
  # @param new_enum_value_display_name [::String]
1808
1820
  # Required. The new display name of the enum value. For example, `my_new_enum_value`.
1809
1821
  #
@@ -1841,7 +1853,9 @@ module Google
1841
1853
  options.apply_defaults timeout: @config.rpcs.rename_tag_template_field_enum_value.timeout,
1842
1854
  metadata: metadata,
1843
1855
  retry_policy: @config.rpcs.rename_tag_template_field_enum_value.retry_policy
1844
- options.apply_defaults metadata: @config.metadata,
1856
+
1857
+ options.apply_defaults timeout: @config.timeout,
1858
+ metadata: @config.metadata,
1845
1859
  retry_policy: @config.retry_policy
1846
1860
 
1847
1861
  @data_catalog_stub.call_rpc :rename_tag_template_field_enum_value, request, options: options do |response, operation|
@@ -1853,11 +1867,12 @@ module Google
1853
1867
  end
1854
1868
 
1855
1869
  ##
1856
- # Deletes a field in a tag template and all uses of that field.
1857
- # Users should enable the Data Catalog API in the project identified by
1858
- # the `name` parameter (see [Data Catalog Resource Project]
1859
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1860
- # more information).
1870
+ # Deletes a field in a tag template and all uses of this field from the tags
1871
+ # based on this template.
1872
+ #
1873
+ # You must enable the Data Catalog API in the project identified by
1874
+ # the `name` parameter. For more information, see [Data Catalog resource
1875
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1861
1876
  #
1862
1877
  # @overload delete_tag_template_field(request, options = nil)
1863
1878
  # Pass arguments to `delete_tag_template_field` via a request object, either of type
@@ -1875,13 +1890,11 @@ module Google
1875
1890
  # the default parameter values, pass an empty Hash as a request object (see above).
1876
1891
  #
1877
1892
  # @param name [::String]
1878
- # Required. The name of the tag template field to delete. Example:
1879
- #
1880
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1893
+ # Required. The name of the tag template field to delete.
1881
1894
  # @param force [::Boolean]
1882
- # Required. Currently, this field must always be set to `true`.
1883
- # This confirms the deletion of this field from any tags using this field.
1884
- # `force = false` will be supported in the future.
1895
+ # Required. If true, deletes this field from any tags that use it.
1896
+ #
1897
+ # Currently, `true` is the only supported value.
1885
1898
  #
1886
1899
  # @yield [response, operation] Access the result along with the RPC operation
1887
1900
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1917,7 +1930,9 @@ module Google
1917
1930
  options.apply_defaults timeout: @config.rpcs.delete_tag_template_field.timeout,
1918
1931
  metadata: metadata,
1919
1932
  retry_policy: @config.rpcs.delete_tag_template_field.retry_policy
1920
- options.apply_defaults metadata: @config.metadata,
1933
+
1934
+ options.apply_defaults timeout: @config.timeout,
1935
+ metadata: @config.metadata,
1921
1936
  retry_policy: @config.retry_policy
1922
1937
 
1923
1938
  @data_catalog_stub.call_rpc :delete_tag_template_field, request, options: options do |response, operation|
@@ -1929,13 +1944,18 @@ module Google
1929
1944
  end
1930
1945
 
1931
1946
  ##
1932
- # Creates a tag on an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
1933
- # Note: The project identified by the `parent` parameter for the
1934
- # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
1935
- # and the
1936
- # [tag
1937
- # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
1938
- # used to create the tag must be from the same organization.
1947
+ # Creates a tag and assigns it to:
1948
+ #
1949
+ # * An {::Google::Cloud::DataCatalog::V1::Entry Entry} if the method name is
1950
+ # ``projects.locations.entryGroups.entries.tags.create``.
1951
+ # * Or {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}if the method
1952
+ # name is ``projects.locations.entryGroups.tags.create``.
1953
+ #
1954
+ # Note: The project identified by the `parent` parameter for the [tag]
1955
+ # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
1956
+ # and the [tag template]
1957
+ # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
1958
+ # used to create the tag must be in the same organization.
1939
1959
  #
1940
1960
  # @overload create_tag(request, options = nil)
1941
1961
  # Pass arguments to `create_tag` via a request object, either of type
@@ -1953,10 +1973,10 @@ module Google
1953
1973
  # the default parameter values, pass an empty Hash as a request object (see above).
1954
1974
  #
1955
1975
  # @param parent [::String]
1956
- # Required. The name of the resource to attach this tag to. Tags can be attached to
1957
- # entries. An entry can have up to 1000 attached tags. Example:
1976
+ # Required. The name of the resource to attach this tag to.
1958
1977
  #
1959
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}`
1978
+ # Tags can be attached to entries or entry groups. An entry can have up to
1979
+ # 1000 attached tags.
1960
1980
  #
1961
1981
  # Note: The tag and its child resources might not be stored in
1962
1982
  # the location specified in its name.
@@ -1997,7 +2017,9 @@ module Google
1997
2017
  options.apply_defaults timeout: @config.rpcs.create_tag.timeout,
1998
2018
  metadata: metadata,
1999
2019
  retry_policy: @config.rpcs.create_tag.retry_policy
2000
- options.apply_defaults metadata: @config.metadata,
2020
+
2021
+ options.apply_defaults timeout: @config.timeout,
2022
+ metadata: @config.metadata,
2001
2023
  retry_policy: @config.retry_policy
2002
2024
 
2003
2025
  @data_catalog_stub.call_rpc :create_tag, request, options: options do |response, operation|
@@ -2070,7 +2092,9 @@ module Google
2070
2092
  options.apply_defaults timeout: @config.rpcs.update_tag.timeout,
2071
2093
  metadata: metadata,
2072
2094
  retry_policy: @config.rpcs.update_tag.retry_policy
2073
- options.apply_defaults metadata: @config.metadata,
2095
+
2096
+ options.apply_defaults timeout: @config.timeout,
2097
+ metadata: @config.metadata,
2074
2098
  retry_policy: @config.retry_policy
2075
2099
 
2076
2100
  @data_catalog_stub.call_rpc :update_tag, request, options: options do |response, operation|
@@ -2100,9 +2124,7 @@ module Google
2100
2124
  # the default parameter values, pass an empty Hash as a request object (see above).
2101
2125
  #
2102
2126
  # @param name [::String]
2103
- # Required. The name of the tag to delete. Example:
2104
- #
2105
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
2127
+ # Required. The name of the tag to delete.
2106
2128
  #
2107
2129
  # @yield [response, operation] Access the result along with the RPC operation
2108
2130
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -2138,7 +2160,9 @@ module Google
2138
2160
  options.apply_defaults timeout: @config.rpcs.delete_tag.timeout,
2139
2161
  metadata: metadata,
2140
2162
  retry_policy: @config.rpcs.delete_tag.retry_policy
2141
- options.apply_defaults metadata: @config.metadata,
2163
+
2164
+ options.apply_defaults timeout: @config.timeout,
2165
+ metadata: @config.metadata,
2142
2166
  retry_policy: @config.retry_policy
2143
2167
 
2144
2168
  @data_catalog_stub.call_rpc :delete_tag, request, options: options do |response, operation|
@@ -2150,7 +2174,7 @@ module Google
2150
2174
  end
2151
2175
 
2152
2176
  ##
2153
- # Lists the tags on an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
2177
+ # Lists tags assigned to an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
2154
2178
  #
2155
2179
  # @overload list_tags(request, options = nil)
2156
2180
  # Pass arguments to `list_tags` via a request object, either of type
@@ -2168,19 +2192,16 @@ module Google
2168
2192
  # the default parameter values, pass an empty Hash as a request object (see above).
2169
2193
  #
2170
2194
  # @param parent [::String]
2171
- # Required. The name of the Data Catalog resource to list the tags of. The resource
2172
- # could be an {::Google::Cloud::DataCatalog::V1::Entry Entry} or an
2173
- # {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
2174
- #
2175
- # Examples:
2195
+ # Required. The name of the Data Catalog resource to list the tags of.
2176
2196
  #
2177
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
2178
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
2197
+ # The resource can be an {::Google::Cloud::DataCatalog::V1::Entry Entry}
2198
+ # or an {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}
2199
+ # (without `/entries/{entries}` at the end).
2179
2200
  # @param page_size [::Integer]
2180
- # The maximum number of tags to return. Default is 10. Max limit is 1000.
2201
+ # The maximum number of tags to return. Default is 10. Maximum limit is 1000.
2181
2202
  # @param page_token [::String]
2182
- # Token that specifies which page is requested. If empty, the first page is
2183
- # returned.
2203
+ # Pagination token that specifies the next page to return. If empty, the
2204
+ # first page is returned.
2184
2205
  #
2185
2206
  # @yield [response, operation] Access the result along with the RPC operation
2186
2207
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>]
@@ -2216,7 +2237,9 @@ module Google
2216
2237
  options.apply_defaults timeout: @config.rpcs.list_tags.timeout,
2217
2238
  metadata: metadata,
2218
2239
  retry_policy: @config.rpcs.list_tags.retry_policy
2219
- options.apply_defaults metadata: @config.metadata,
2240
+
2241
+ options.apply_defaults timeout: @config.timeout,
2242
+ metadata: @config.metadata,
2220
2243
  retry_policy: @config.retry_policy
2221
2244
 
2222
2245
  @data_catalog_stub.call_rpc :list_tags, request, options: options do |response, operation|
@@ -2229,20 +2252,23 @@ module Google
2229
2252
  end
2230
2253
 
2231
2254
  ##
2232
- # Sets the access control policy for a resource. Replaces any existing
2255
+ # Sets an access control policy for a resource. Replaces any existing
2233
2256
  # policy.
2257
+ #
2234
2258
  # Supported resources are:
2235
- # - Tag templates.
2236
- # - Entries.
2237
- # - Entry groups.
2238
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2239
- # and any external Google Cloud Platform resources synced to Data Catalog.
2240
- #
2241
- # Callers must have following Google IAM permission
2242
- # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
2243
- # templates.
2244
- # - `datacatalog.entries.setIamPolicy` to set policies on entries.
2245
- # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
2259
+ #
2260
+ # - Tag templates
2261
+ # - Entry groups
2262
+ #
2263
+ # Note: This method sets policies only within Data Catalog and can't be
2264
+ # used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
2265
+ # external Google Cloud Platform resources synced with the Data Catalog.
2266
+ #
2267
+ # To call this method, you must have the following Google IAM permissions:
2268
+ #
2269
+ # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
2270
+ # templates.
2271
+ # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
2246
2272
  #
2247
2273
  # @overload set_iam_policy(request, options = nil)
2248
2274
  # Pass arguments to `set_iam_policy` via a request object, either of type
@@ -2302,7 +2328,9 @@ module Google
2302
2328
  options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
2303
2329
  metadata: metadata,
2304
2330
  retry_policy: @config.rpcs.set_iam_policy.retry_policy
2305
- options.apply_defaults metadata: @config.metadata,
2331
+
2332
+ options.apply_defaults timeout: @config.timeout,
2333
+ metadata: @config.metadata,
2306
2334
  retry_policy: @config.retry_policy
2307
2335
 
2308
2336
  @data_catalog_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
@@ -2314,22 +2342,27 @@ module Google
2314
2342
  end
2315
2343
 
2316
2344
  ##
2317
- # Gets the access control policy for a resource. A `NOT_FOUND` error
2318
- # is returned if the resource does not exist. An empty policy is returned
2319
- # if the resource exists but does not have a policy set on it.
2345
+ # Gets the access control policy for a resource.
2346
+ #
2347
+ # May return:
2348
+ #
2349
+ # * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
2350
+ # permission to view it.
2351
+ # * An empty policy if the resource exists but doesn't have a set policy.
2320
2352
  #
2321
2353
  # Supported resources are:
2322
- # - Tag templates.
2323
- # - Entries.
2324
- # - Entry groups.
2325
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2326
- # and any external Google Cloud Platform resources synced to Data Catalog.
2327
- #
2328
- # Callers must have following Google IAM permission
2329
- # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
2330
- # templates.
2331
- # - `datacatalog.entries.getIamPolicy` to get policies on entries.
2332
- # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
2354
+ #
2355
+ # - Tag templates
2356
+ # - Entry groups
2357
+ #
2358
+ # Note: This method doesn't get policies from Google Cloud Platform
2359
+ # resources ingested into Data Catalog.
2360
+ #
2361
+ # To call this method, you must have the following Google IAM permissions:
2362
+ #
2363
+ # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
2364
+ # templates.
2365
+ # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
2333
2366
  #
2334
2367
  # @overload get_iam_policy(request, options = nil)
2335
2368
  # Pass arguments to `get_iam_policy` via a request object, either of type
@@ -2387,7 +2420,9 @@ module Google
2387
2420
  options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
2388
2421
  metadata: metadata,
2389
2422
  retry_policy: @config.rpcs.get_iam_policy.retry_policy
2390
- options.apply_defaults metadata: @config.metadata,
2423
+
2424
+ options.apply_defaults timeout: @config.timeout,
2425
+ metadata: @config.metadata,
2391
2426
  retry_policy: @config.retry_policy
2392
2427
 
2393
2428
  @data_catalog_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
@@ -2399,19 +2434,20 @@ module Google
2399
2434
  end
2400
2435
 
2401
2436
  ##
2402
- # Returns the caller's permissions on a resource.
2403
- # If the resource does not exist, an empty set of permissions is returned
2404
- # (We don't return a `NOT_FOUND` error).
2437
+ # Gets your permissions on a resource.
2438
+ #
2439
+ # Returns an empty set of permissions if the resource doesn't exist.
2405
2440
  #
2406
2441
  # Supported resources are:
2407
- # - Tag templates.
2408
- # - Entries.
2409
- # - Entry groups.
2410
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2411
- # and any external Google Cloud Platform resources synced to Data Catalog.
2412
2442
  #
2413
- # A caller is not required to have Google IAM permission to make this
2414
- # request.
2443
+ # - Tag templates
2444
+ # - Entry groups
2445
+ #
2446
+ # Note: This method gets policies only within Data Catalog and can't be
2447
+ # used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
2448
+ # external Google Cloud Platform resources ingested into Data Catalog.
2449
+ #
2450
+ # No Google IAM permissions are required to call this method.
2415
2451
  #
2416
2452
  # @overload test_iam_permissions(request, options = nil)
2417
2453
  # Pass arguments to `test_iam_permissions` via a request object, either of type
@@ -2471,7 +2507,9 @@ module Google
2471
2507
  options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
2472
2508
  metadata: metadata,
2473
2509
  retry_policy: @config.rpcs.test_iam_permissions.retry_policy
2474
- options.apply_defaults metadata: @config.metadata,
2510
+
2511
+ options.apply_defaults timeout: @config.timeout,
2512
+ metadata: @config.metadata,
2475
2513
  retry_policy: @config.retry_policy
2476
2514
 
2477
2515
  @data_catalog_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
@@ -2495,22 +2533,21 @@ module Google
2495
2533
  # Configuration can be applied globally to all clients, or to a single client
2496
2534
  # on construction.
2497
2535
  #
2498
- # # Examples
2499
- #
2500
- # To modify the global config, setting the timeout for search_catalog
2501
- # to 20 seconds, and all remaining timeouts to 10 seconds:
2502
- #
2503
- # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
2504
- # config.timeout = 10.0
2505
- # config.rpcs.search_catalog.timeout = 20.0
2506
- # end
2507
- #
2508
- # To apply the above configuration only to a new client:
2509
- #
2510
- # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
2511
- # config.timeout = 10.0
2512
- # config.rpcs.search_catalog.timeout = 20.0
2513
- # end
2536
+ # @example
2537
+ #
2538
+ # # Modify the global config, setting the timeout for
2539
+ # # search_catalog to 20 seconds,
2540
+ # # and all remaining timeouts to 10 seconds.
2541
+ # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
2542
+ # config.timeout = 10.0
2543
+ # config.rpcs.search_catalog.timeout = 20.0
2544
+ # end
2545
+ #
2546
+ # # Apply the above configuration only to a new client.
2547
+ # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
2548
+ # config.timeout = 10.0
2549
+ # config.rpcs.search_catalog.timeout = 20.0
2550
+ # end
2514
2551
  #
2515
2552
  # @!attribute [rw] endpoint
2516
2553
  # The hostname or hostname:port of the service endpoint.