google-cloud-data_catalog-v1 0.7.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/README.md +1 -1
- data/lib/google/cloud/data_catalog/v1/data_catalog.rb +2 -2
- data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +312 -324
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +1 -1
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +56 -46
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +4 -3
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +110 -23
- 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/datacatalog_pb.rb +44 -0
- data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +179 -142
- data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +16 -14
- data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +5 -0
- data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +28 -14
- data/lib/google/cloud/datacatalog/v1/tags_pb.rb +3 -0
- data/lib/google/cloud/datacatalog/v1/usage_pb.rb +31 -0
- data/proto_docs/google/api/field_behavior.rb +7 -1
- 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 +98 -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
- data/proto_docs/google/type/expr.rb +35 -12
- metadata +19 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ba6dc6009a98c8a25f244e37fadd139b37a2c100f1c855d599baf304a7c570aa
|
4
|
+
data.tar.gz: d5d529cebde9376bcafe9fac5ac1da3ceab4157365e84532a023ed5c96b3ce67
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0f956bfe7c2dc686e35ba1ff2be245ed7792806942ec1f5cb196a85e85750ea0ffc3c7d6b97268a7f3315ef190713265ac5e0e2ef3e3a6f847ff42ec33f6162f
|
7
|
+
data.tar.gz: 97e0d45757d40e7be14c3bac848adcb81f7090272413fc81c7ea56fc3a9483ec42808eff5c3f4a43061e78c97edf508a79fd41d9e5a967568290e00dbfc5c75f
|
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
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
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
|
86
|
-
environment
|
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
|
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 =
|
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
|
35
|
-
#
|
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
|
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
|
@@ -70,66 +70,42 @@ module Google
|
|
70
70
|
|
71
71
|
default_config.rpcs.search_catalog.timeout = 60.0
|
72
72
|
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]
|
73
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
77
74
|
}
|
78
75
|
|
79
76
|
default_config.rpcs.get_entry_group.timeout = 60.0
|
80
77
|
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]
|
78
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
85
79
|
}
|
86
80
|
|
87
81
|
default_config.rpcs.list_entry_groups.timeout = 60.0
|
88
82
|
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]
|
83
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
93
84
|
}
|
94
85
|
|
95
86
|
default_config.rpcs.get_entry.timeout = 60.0
|
96
87
|
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]
|
88
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
101
89
|
}
|
102
90
|
|
103
91
|
default_config.rpcs.lookup_entry.timeout = 60.0
|
104
92
|
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]
|
93
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
109
94
|
}
|
110
95
|
|
111
96
|
default_config.rpcs.list_entries.timeout = 60.0
|
112
97
|
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]
|
98
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
117
99
|
}
|
118
100
|
|
119
101
|
default_config.rpcs.list_tags.timeout = 60.0
|
120
102
|
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]
|
103
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
125
104
|
}
|
126
105
|
|
127
106
|
default_config.rpcs.get_iam_policy.timeout = 60.0
|
128
107
|
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]
|
108
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
133
109
|
}
|
134
110
|
|
135
111
|
default_config
|
@@ -200,7 +176,7 @@ module Google
|
|
200
176
|
!@config.endpoint.split(".").first.include?("-")
|
201
177
|
credentials ||= Credentials.default scope: @config.scope,
|
202
178
|
enable_self_signed_jwt: enable_self_signed_jwt
|
203
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
179
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
204
180
|
credentials = Credentials.new credentials, scope: @config.scope
|
205
181
|
end
|
206
182
|
@quota_project_id = @config.quota_project
|
@@ -218,22 +194,21 @@ module Google
|
|
218
194
|
# Service calls
|
219
195
|
|
220
196
|
##
|
221
|
-
# Searches Data Catalog for multiple resources like entries
|
197
|
+
# Searches Data Catalog for multiple resources like entries and tags that
|
222
198
|
# match a query.
|
223
199
|
#
|
224
|
-
# This is a
|
225
|
-
# (https://cloud.google.com/apis/design/custom_methods)
|
226
|
-
#
|
227
|
-
#
|
200
|
+
# This is a [Custom Method]
|
201
|
+
# (https://cloud.google.com/apis/design/custom_methods) that doesn't return
|
202
|
+
# all information on a resource, only its ID and high level fields. To get
|
203
|
+
# more information, you can subsequently call specific get methods.
|
228
204
|
#
|
229
|
-
# Note
|
230
|
-
#
|
231
|
-
# result pages.
|
232
|
-
#
|
205
|
+
# Note: Data Catalog search queries don't guarantee full recall. Results
|
206
|
+
# that match your query might not be returned, even in subsequent
|
207
|
+
# result pages. Additionally, returned (and not returned) results can vary
|
208
|
+
# if you repeat search queries.
|
233
209
|
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
# for more information.
|
210
|
+
# For more information, see [Data Catalog search syntax]
|
211
|
+
# (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
|
237
212
|
#
|
238
213
|
# @overload search_catalog(request, options = nil)
|
239
214
|
# Pass arguments to `search_catalog` via a request object, either of type
|
@@ -251,43 +226,47 @@ module Google
|
|
251
226
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
252
227
|
#
|
253
228
|
# @param scope [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, ::Hash]
|
254
|
-
# Required. The scope of this search request.
|
255
|
-
#
|
256
|
-
# `
|
257
|
-
#
|
229
|
+
# Required. The scope of this search request.
|
230
|
+
#
|
231
|
+
# The `scope` is invalid if `include_org_ids`, `include_project_ids` are
|
232
|
+
# empty AND `include_gcp_public_datasets` is set to `false`. In this case,
|
233
|
+
# the request returns an error.
|
258
234
|
# @param query [::String]
|
259
|
-
# Optional. The query string
|
260
|
-
#
|
235
|
+
# Optional. The query string with a minimum of 3 characters and specific syntax.
|
236
|
+
# For more information, see
|
237
|
+
# [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference).
|
261
238
|
#
|
262
|
-
#
|
239
|
+
# An empty query string returns all data assets (in the specified scope)
|
240
|
+
# that you have access to.
|
263
241
|
#
|
264
|
-
#
|
265
|
-
# * column:x
|
266
|
-
# * description:y
|
242
|
+
# A query string can be a simple `xyz` or qualified by predicates:
|
267
243
|
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
# for more information.
|
244
|
+
# * `name:x`
|
245
|
+
# * `column:y`
|
246
|
+
# * `description:z`
|
272
247
|
# @param page_size [::Integer]
|
273
|
-
# Number of results in
|
274
|
-
#
|
248
|
+
# Number of results to return in a single search page.
|
249
|
+
#
|
250
|
+
# Can't be negative or 0, defaults to 10 in this case.
|
251
|
+
# The maximum number is 1000. If exceeded, throws an "invalid argument"
|
252
|
+
# exception.
|
275
253
|
# @param page_token [::String]
|
276
|
-
# Optional. Pagination token
|
277
|
-
#
|
278
|
-
#
|
254
|
+
# Optional. Pagination token that, if specified, returns the next page of search
|
255
|
+
# results. If empty, returns the first page.
|
256
|
+
#
|
257
|
+
# This token is returned in the {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}
|
258
|
+
# field of the response to a previous
|
279
259
|
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
|
280
|
-
# call
|
281
|
-
# the first page is returned.
|
260
|
+
# call.
|
282
261
|
# @param order_by [::String]
|
283
|
-
# Specifies the
|
284
|
-
# choices are:
|
262
|
+
# Specifies the order of results.
|
285
263
|
#
|
286
|
-
#
|
287
|
-
# * `last_modified_timestamp [asc|desc]`, defaults to descending if not
|
288
|
-
# specified
|
264
|
+
# Currently supported case-sensitive values are:
|
289
265
|
#
|
290
|
-
#
|
266
|
+
# * `relevance` that can only be descending
|
267
|
+
# * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
|
268
|
+
#
|
269
|
+
# If this parameter is omitted, it defaults to the descending `relevance`.
|
291
270
|
#
|
292
271
|
# @yield [response, operation] Access the result along with the RPC operation
|
293
272
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
|
@@ -330,25 +309,33 @@ module Google
|
|
330
309
|
end
|
331
310
|
|
332
311
|
##
|
333
|
-
# Creates an
|
312
|
+
# Creates an entry group.
|
313
|
+
#
|
314
|
+
# An entry group contains logically related entries together with [Cloud
|
315
|
+
# Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
|
316
|
+
# These policies specify users who can create, edit, and view entries
|
317
|
+
# within entry groups.
|
334
318
|
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
# create, edit, and view entries within the entry group.
|
319
|
+
# Data Catalog automatically creates entry groups with names that start with
|
320
|
+
# the `@` symbol for the following resources:
|
338
321
|
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
322
|
+
# * BigQuery entries (`@bigquery`)
|
323
|
+
# * Pub/Sub topics (`@pubsub`)
|
324
|
+
# * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
|
325
|
+
#
|
326
|
+
# You can create your own entry groups for Cloud Storage fileset entries
|
327
|
+
# and custom entries together with the corresponding IAM policies.
|
328
|
+
# User-created entry groups can't contain the `@` symbol, it is reserved
|
329
|
+
# for automatically created groups.
|
330
|
+
#
|
331
|
+
# Entry groups, like entries, can be searched.
|
344
332
|
#
|
345
333
|
# A maximum of 10,000 entry groups may be created per organization across all
|
346
334
|
# locations.
|
347
335
|
#
|
348
|
-
#
|
349
|
-
# the `parent` parameter
|
350
|
-
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project)
|
351
|
-
# more information).
|
336
|
+
# You must enable the Data Catalog API in the project identified by
|
337
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
338
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
352
339
|
#
|
353
340
|
# @overload create_entry_group(request, options = nil)
|
354
341
|
# Pass arguments to `create_entry_group` via a request object, either of type
|
@@ -366,9 +353,7 @@ module Google
|
|
366
353
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
367
354
|
#
|
368
355
|
# @param parent [::String]
|
369
|
-
# Required. The
|
370
|
-
#
|
371
|
-
# `projects/{project_id}/locations/{location}`
|
356
|
+
# Required. The names of the project and location that the new entry group belongs to.
|
372
357
|
#
|
373
358
|
# Note: The entry group itself and its child resources might not be
|
374
359
|
# stored in the location specified in its name.
|
@@ -379,7 +364,7 @@ module Google
|
|
379
364
|
# underscores (_), and must start with a letter or underscore.
|
380
365
|
# The maximum size is 64 bytes when encoded in UTF-8.
|
381
366
|
# @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
|
382
|
-
# The entry group to create. Defaults to
|
367
|
+
# The entry group to create. Defaults to empty.
|
383
368
|
#
|
384
369
|
# @yield [response, operation] Access the result along with the RPC operation
|
385
370
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
@@ -427,7 +412,7 @@ module Google
|
|
427
412
|
end
|
428
413
|
|
429
414
|
##
|
430
|
-
# Gets an
|
415
|
+
# Gets an entry group.
|
431
416
|
#
|
432
417
|
# @overload get_entry_group(request, options = nil)
|
433
418
|
# Pass arguments to `get_entry_group` via a request object, either of type
|
@@ -445,10 +430,9 @@ module Google
|
|
445
430
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
446
431
|
#
|
447
432
|
# @param name [::String]
|
448
|
-
# Required. The name of the entry group
|
449
|
-
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
433
|
+
# Required. The name of the entry group to get.
|
450
434
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
451
|
-
# The fields to return. If
|
435
|
+
# The fields to return. If empty or omitted, all fields are returned.
|
452
436
|
#
|
453
437
|
# @yield [response, operation] Access the result along with the RPC operation
|
454
438
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
@@ -496,11 +480,12 @@ module Google
|
|
496
480
|
end
|
497
481
|
|
498
482
|
##
|
499
|
-
# Updates an
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
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.
|
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
|
#
|
@@ -572,11 +557,12 @@ module Google
|
|
572
557
|
end
|
573
558
|
|
574
559
|
##
|
575
|
-
# Deletes an
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
560
|
+
# Deletes an entry group.
|
561
|
+
#
|
562
|
+
# You must enable the Data Catalog API in the project
|
563
|
+
# identified by the `name` parameter. For more information, see [Data Catalog
|
564
|
+
# resource
|
565
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
580
566
|
#
|
581
567
|
# @overload delete_entry_group(request, options = nil)
|
582
568
|
# Pass arguments to `delete_entry_group` via a request object, either of type
|
@@ -594,8 +580,7 @@ module Google
|
|
594
580
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
595
581
|
#
|
596
582
|
# @param name [::String]
|
597
|
-
# Required. The name of the entry group
|
598
|
-
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
583
|
+
# Required. The name of the entry group to delete.
|
599
584
|
# @param force [::Boolean]
|
600
585
|
# Optional. If true, deletes all entries in the entry group.
|
601
586
|
#
|
@@ -663,16 +648,17 @@ module Google
|
|
663
648
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
664
649
|
#
|
665
650
|
# @param parent [::String]
|
666
|
-
# Required. The name of the location that contains the entry groups
|
667
|
-
# provided in URL format. Example:
|
651
|
+
# Required. The name of the location that contains the entry groups to list.
|
668
652
|
#
|
669
|
-
#
|
653
|
+
# Can be provided as a URL.
|
670
654
|
# @param page_size [::Integer]
|
671
|
-
# Optional. The maximum number of items to return.
|
672
|
-
#
|
655
|
+
# Optional. The maximum number of items to return.
|
656
|
+
#
|
657
|
+
# Default is 10. Maximum limit is 1000.
|
658
|
+
# Throws an invalid argument if `page_size` is greater than 1000.
|
673
659
|
# @param page_token [::String]
|
674
|
-
# Optional.
|
675
|
-
#
|
660
|
+
# Optional. Pagination token that specifies the next page to return.
|
661
|
+
# If empty, returns the first page.
|
676
662
|
#
|
677
663
|
# @yield [response, operation] Access the result along with the RPC operation
|
678
664
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
|
@@ -721,15 +707,17 @@ module Google
|
|
721
707
|
end
|
722
708
|
|
723
709
|
##
|
724
|
-
# Creates an entry.
|
725
|
-
#
|
710
|
+
# Creates an entry.
|
711
|
+
#
|
712
|
+
# You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
|
713
|
+
# or custom types. Data Catalog automatically creates entries with other
|
714
|
+
# types during metadata ingestion from integrated systems.
|
726
715
|
#
|
727
|
-
#
|
728
|
-
# the `parent` parameter
|
729
|
-
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project)
|
730
|
-
# more information).
|
716
|
+
# You must enable the Data Catalog API in the project identified by
|
717
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
718
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
731
719
|
#
|
732
|
-
#
|
720
|
+
# An entry group can have a maximum of 100,000 entries.
|
733
721
|
#
|
734
722
|
# @overload create_entry(request, options = nil)
|
735
723
|
# Pass arguments to `create_entry` via a request object, either of type
|
@@ -747,9 +735,7 @@ module Google
|
|
747
735
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
748
736
|
#
|
749
737
|
# @param parent [::String]
|
750
|
-
# Required. The name of the entry group this entry belongs to.
|
751
|
-
#
|
752
|
-
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`
|
738
|
+
# Required. The name of the entry group this entry belongs to.
|
753
739
|
#
|
754
740
|
# Note: The entry itself and its child resources might not be stored in
|
755
741
|
# the location specified in its name.
|
@@ -809,10 +795,11 @@ module Google
|
|
809
795
|
|
810
796
|
##
|
811
797
|
# Updates an existing entry.
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
798
|
+
#
|
799
|
+
# You must enable the Data Catalog API in the project identified by
|
800
|
+
# the `entry.name` parameter. For more information, see [Data Catalog
|
801
|
+
# resource
|
802
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
816
803
|
#
|
817
804
|
# @overload update_entry(request, options = nil)
|
818
805
|
# Pass arguments to `update_entry` via a request object, either of type
|
@@ -830,7 +817,7 @@ module Google
|
|
830
817
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
831
818
|
#
|
832
819
|
# @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
|
833
|
-
# Required.
|
820
|
+
# Required. Updates for the entry. The `name` field must be set.
|
834
821
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
835
822
|
# Names of fields whose values to overwrite on an entry.
|
836
823
|
#
|
@@ -838,24 +825,29 @@ module Google
|
|
838
825
|
# are overwritten. If such fields are non-required and omitted in the
|
839
826
|
# request body, their values are emptied.
|
840
827
|
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
# *
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
# *
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
828
|
+
# You can modify only the fields listed below.
|
829
|
+
#
|
830
|
+
# For entries with type `DATA_STREAM`:
|
831
|
+
#
|
832
|
+
# * `schema`
|
833
|
+
#
|
834
|
+
# For entries with type `FILESET`:
|
835
|
+
#
|
836
|
+
# * `schema`
|
837
|
+
# * `display_name`
|
838
|
+
# * `description`
|
839
|
+
# * `gcs_fileset_spec`
|
840
|
+
# * `gcs_fileset_spec.file_patterns`
|
841
|
+
#
|
842
|
+
# For entries with `user_specified_type`:
|
843
|
+
#
|
844
|
+
# * `schema`
|
845
|
+
# * `display_name`
|
846
|
+
# * `description`
|
847
|
+
# * `user_specified_type`
|
848
|
+
# * `user_specified_system`
|
849
|
+
# * `linked_resource`
|
850
|
+
# * `source_system_timestamps`
|
859
851
|
#
|
860
852
|
# @yield [response, operation] Access the result along with the RPC operation
|
861
853
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
|
@@ -903,13 +895,16 @@ module Google
|
|
903
895
|
end
|
904
896
|
|
905
897
|
##
|
906
|
-
# Deletes an existing entry.
|
898
|
+
# Deletes an existing entry.
|
899
|
+
#
|
900
|
+
# You can delete only the entries created by the
|
907
901
|
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}
|
908
|
-
# method
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
902
|
+
# method.
|
903
|
+
#
|
904
|
+
# You must enable the Data Catalog API in the project identified by
|
905
|
+
# the `name` parameter. For more information, see [Data Catalog
|
906
|
+
# resource
|
907
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
913
908
|
#
|
914
909
|
# @overload delete_entry(request, options = nil)
|
915
910
|
# Pass arguments to `delete_entry` via a request object, either of type
|
@@ -927,9 +922,7 @@ module Google
|
|
927
922
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
928
923
|
#
|
929
924
|
# @param name [::String]
|
930
|
-
# Required. The name of the entry.
|
931
|
-
#
|
932
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
925
|
+
# Required. The name of the entry to delete.
|
933
926
|
#
|
934
927
|
# @yield [response, operation] Access the result along with the RPC operation
|
935
928
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -995,9 +988,7 @@ module Google
|
|
995
988
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
996
989
|
#
|
997
990
|
# @param name [::String]
|
998
|
-
# Required. The name of the entry.
|
999
|
-
#
|
1000
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
991
|
+
# Required. The name of the entry to get.
|
1001
992
|
#
|
1002
993
|
# @yield [response, operation] Access the result along with the RPC operation
|
1003
994
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
|
@@ -1045,9 +1036,9 @@ module Google
|
|
1045
1036
|
end
|
1046
1037
|
|
1047
1038
|
##
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1039
|
+
# Gets an entry by its target resource name.
|
1040
|
+
#
|
1041
|
+
# The resource name comes from the source Google Cloud Platform service.
|
1051
1042
|
#
|
1052
1043
|
# @overload lookup_entry(request, options = nil)
|
1053
1044
|
# Pass arguments to `lookup_entry` via a request object, either of type
|
@@ -1066,27 +1057,27 @@ module Google
|
|
1066
1057
|
#
|
1067
1058
|
# @param linked_resource [::String]
|
1068
1059
|
# The full name of the Google Cloud Platform resource the Data Catalog
|
1069
|
-
# entry represents.
|
1070
|
-
# https://cloud.google.com/apis/design/resource_names#full_resource_name.
|
1071
|
-
# Full names are case-sensitive.
|
1060
|
+
# entry represents. For more information, see [Full Resource Name]
|
1061
|
+
# (https://cloud.google.com/apis/design/resource_names#full_resource_name).
|
1072
1062
|
#
|
1073
|
-
#
|
1063
|
+
# Full names are case-sensitive. For example:
|
1074
1064
|
#
|
1075
|
-
# *
|
1076
|
-
# *
|
1065
|
+
# * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
|
1066
|
+
# * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
|
1077
1067
|
# @param sql_resource [::String]
|
1078
1068
|
# The SQL name of the entry. SQL names are case-sensitive.
|
1079
1069
|
#
|
1080
1070
|
# Examples:
|
1081
1071
|
#
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
#
|
1086
|
-
#
|
1072
|
+
# * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
|
1073
|
+
# * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
|
1074
|
+
# * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
|
1075
|
+
# * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
|
1076
|
+
# * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
|
1087
1077
|
#
|
1088
|
-
# `*
|
1089
|
-
#
|
1078
|
+
# Identifiers (`*_ID`) should comply with the
|
1079
|
+
# [Lexical structure in Standard SQL]
|
1080
|
+
# (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
|
1090
1081
|
# @param fully_qualified_name [::String]
|
1091
1082
|
# Fully qualified name (FQN) of the resource.
|
1092
1083
|
#
|
@@ -1102,7 +1093,7 @@ module Google
|
|
1102
1093
|
#
|
1103
1094
|
# Example for a DPMS table:
|
1104
1095
|
#
|
1105
|
-
# `dataproc_metastore:
|
1096
|
+
# `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
|
1106
1097
|
#
|
1107
1098
|
# @yield [response, operation] Access the result along with the RPC operation
|
1108
1099
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
|
@@ -1162,21 +1153,21 @@ module Google
|
|
1162
1153
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1163
1154
|
#
|
1164
1155
|
# @param parent [::String]
|
1165
|
-
# Required. The name of the entry group that contains the entries
|
1166
|
-
# be provided in URL format. Example:
|
1156
|
+
# Required. The name of the entry group that contains the entries to list.
|
1167
1157
|
#
|
1168
|
-
#
|
1158
|
+
# Can be provided in URL format.
|
1169
1159
|
# @param page_size [::Integer]
|
1170
|
-
# The maximum number of items to return. Default is 10.
|
1171
|
-
# Throws an invalid argument
|
1160
|
+
# The maximum number of items to return. Default is 10. Maximum limit is
|
1161
|
+
# 1000. Throws an invalid argument if `page_size` is more than 1000.
|
1172
1162
|
# @param page_token [::String]
|
1173
|
-
#
|
1174
|
-
# returned.
|
1163
|
+
# Pagination token that specifies the next page to return. If empty, the
|
1164
|
+
# first page is returned.
|
1175
1165
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1176
|
-
# The fields to return for each
|
1166
|
+
# The fields to return for each entry. If empty or omitted, all
|
1177
1167
|
# fields are returned.
|
1178
|
-
#
|
1179
|
-
#
|
1168
|
+
#
|
1169
|
+
# For example, to return a list of entries with only the `name` field,
|
1170
|
+
# set `read_mask` to only one path with the `name` value.
|
1180
1171
|
#
|
1181
1172
|
# @yield [response, operation] Access the result along with the RPC operation
|
1182
1173
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>]
|
@@ -1225,11 +1216,12 @@ module Google
|
|
1225
1216
|
end
|
1226
1217
|
|
1227
1218
|
##
|
1228
|
-
# Creates a tag template.
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1219
|
+
# Creates a tag template.
|
1220
|
+
#
|
1221
|
+
# You must enable the Data Catalog API in the project identified by the
|
1222
|
+
# `parent` parameter.
|
1223
|
+
# For more information, see [Data Catalog resource project]
|
1224
|
+
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1233
1225
|
#
|
1234
1226
|
# @overload create_tag_template(request, options = nil)
|
1235
1227
|
# Pass arguments to `create_tag_template` via a request object, either of type
|
@@ -1249,10 +1241,6 @@ module Google
|
|
1249
1241
|
# @param parent [::String]
|
1250
1242
|
# Required. The name of the project and the template location
|
1251
1243
|
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
1252
|
-
#
|
1253
|
-
# Example:
|
1254
|
-
#
|
1255
|
-
# * projects/\\{project_id}/locations/us-central1
|
1256
1244
|
# @param tag_template_id [::String]
|
1257
1245
|
# Required. The ID of the tag template to create.
|
1258
1246
|
#
|
@@ -1326,9 +1314,7 @@ module Google
|
|
1326
1314
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1327
1315
|
#
|
1328
1316
|
# @param name [::String]
|
1329
|
-
# Required. The name of the tag template.
|
1330
|
-
#
|
1331
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
1317
|
+
# Required. The name of the tag template to get.
|
1332
1318
|
#
|
1333
1319
|
# @yield [response, operation] Access the result along with the RPC operation
|
1334
1320
|
# @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
@@ -1376,13 +1362,15 @@ module Google
|
|
1376
1362
|
end
|
1377
1363
|
|
1378
1364
|
##
|
1379
|
-
# Updates a tag template.
|
1380
|
-
#
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
#
|
1385
|
-
# more information
|
1365
|
+
# Updates a tag template.
|
1366
|
+
#
|
1367
|
+
# You can't update template fields with this method. These fields are
|
1368
|
+
# separate resources with their own create, update, and delete methods.
|
1369
|
+
#
|
1370
|
+
# You must enable the Data Catalog API in the project identified by
|
1371
|
+
# the `tag_template.name` parameter. For more information, see [Data Catalog
|
1372
|
+
# resource
|
1373
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1386
1374
|
#
|
1387
1375
|
# @overload update_tag_template(request, options = nil)
|
1388
1376
|
# Pass arguments to `update_tag_template` via a request object, either of type
|
@@ -1400,12 +1388,12 @@ module Google
|
|
1400
1388
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1401
1389
|
#
|
1402
1390
|
# @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
|
1403
|
-
# Required. The template to update. The
|
1391
|
+
# Required. The template to update. The `name` field must be set.
|
1404
1392
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1405
1393
|
# Names of fields whose values to overwrite on a tag template. Currently,
|
1406
1394
|
# only `display_name` can be overwritten.
|
1407
1395
|
#
|
1408
|
-
#
|
1396
|
+
# If this parameter is absent or empty, all modifiable fields
|
1409
1397
|
# are overwritten. If such fields are non-required and omitted in the
|
1410
1398
|
# request body, their values are emptied.
|
1411
1399
|
#
|
@@ -1455,11 +1443,11 @@ module Google
|
|
1455
1443
|
end
|
1456
1444
|
|
1457
1445
|
##
|
1458
|
-
# Deletes a tag template and all tags
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
#
|
1446
|
+
# Deletes a tag template and all tags that use it.
|
1447
|
+
#
|
1448
|
+
# You must enable the Data Catalog API in the project identified by
|
1449
|
+
# the `name` parameter. For more information, see [Data Catalog resource
|
1450
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1463
1451
|
#
|
1464
1452
|
# @overload delete_tag_template(request, options = nil)
|
1465
1453
|
# Pass arguments to `delete_tag_template` via a request object, either of type
|
@@ -1477,13 +1465,11 @@ module Google
|
|
1477
1465
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1478
1466
|
#
|
1479
1467
|
# @param name [::String]
|
1480
|
-
# Required. The name of the tag template to delete.
|
1481
|
-
#
|
1482
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
1468
|
+
# Required. The name of the tag template to delete.
|
1483
1469
|
# @param force [::Boolean]
|
1484
|
-
# Required.
|
1485
|
-
#
|
1486
|
-
# `
|
1470
|
+
# Required. If true, deletes all tags that use this template.
|
1471
|
+
#
|
1472
|
+
# Currently, `true` is the only supported value.
|
1487
1473
|
#
|
1488
1474
|
# @yield [response, operation] Access the result along with the RPC operation
|
1489
1475
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1531,11 +1517,11 @@ module Google
|
|
1531
1517
|
end
|
1532
1518
|
|
1533
1519
|
##
|
1534
|
-
# Creates a field in a tag template.
|
1535
|
-
#
|
1536
|
-
#
|
1537
|
-
#
|
1538
|
-
#
|
1520
|
+
# Creates a field in a tag template.
|
1521
|
+
#
|
1522
|
+
# You must enable the Data Catalog API in the project identified by
|
1523
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
1524
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1539
1525
|
#
|
1540
1526
|
# @overload create_tag_template_field(request, options = nil)
|
1541
1527
|
# Pass arguments to `create_tag_template_field` via a request object, either of type
|
@@ -1555,10 +1541,6 @@ module Google
|
|
1555
1541
|
# @param parent [::String]
|
1556
1542
|
# Required. The name of the project and the template location
|
1557
1543
|
# [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
1544
|
# @param tag_template_field_id [::String]
|
1563
1545
|
# Required. The ID of the tag template field to create.
|
1564
1546
|
#
|
@@ -1617,11 +1599,14 @@ module Google
|
|
1617
1599
|
end
|
1618
1600
|
|
1619
1601
|
##
|
1620
|
-
# Updates a field in a tag template.
|
1621
|
-
#
|
1622
|
-
#
|
1623
|
-
#
|
1624
|
-
#
|
1602
|
+
# Updates a field in a tag template.
|
1603
|
+
#
|
1604
|
+
# You can't update the field type with this method.
|
1605
|
+
#
|
1606
|
+
# You must enable the Data Catalog API in the project
|
1607
|
+
# identified by the `name` parameter. For more information, see [Data Catalog
|
1608
|
+
# resource
|
1609
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1625
1610
|
#
|
1626
1611
|
# @overload update_tag_template_field(request, options = nil)
|
1627
1612
|
# Pass arguments to `update_tag_template_field` via a request object, either of type
|
@@ -1639,18 +1624,16 @@ module Google
|
|
1639
1624
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1640
1625
|
#
|
1641
1626
|
# @param name [::String]
|
1642
|
-
# Required. The name of the tag template field.
|
1643
|
-
#
|
1644
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
1627
|
+
# Required. The name of the tag template field.
|
1645
1628
|
# @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
|
1646
1629
|
# Required. The template to update.
|
1647
1630
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1648
1631
|
# Optional. Names of fields whose values to overwrite on an individual field of a tag
|
1649
1632
|
# template. The following fields are modifiable:
|
1650
1633
|
#
|
1651
|
-
#
|
1652
|
-
#
|
1653
|
-
#
|
1634
|
+
# * `display_name`
|
1635
|
+
# * `type.enum_type`
|
1636
|
+
# * `is_required`
|
1654
1637
|
#
|
1655
1638
|
# If this parameter is absent or empty, all modifiable fields
|
1656
1639
|
# are overwritten. If such fields are non-required and omitted in the request
|
@@ -1708,11 +1691,11 @@ module Google
|
|
1708
1691
|
end
|
1709
1692
|
|
1710
1693
|
##
|
1711
|
-
# Renames a field in a tag template.
|
1712
|
-
#
|
1713
|
-
#
|
1714
|
-
#
|
1715
|
-
#
|
1694
|
+
# Renames a field in a tag template.
|
1695
|
+
#
|
1696
|
+
# You must enable the Data Catalog API in the project identified by the
|
1697
|
+
# `name` parameter. For more information, see [Data Catalog resource project]
|
1698
|
+
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1716
1699
|
#
|
1717
1700
|
# @overload rename_tag_template_field(request, options = nil)
|
1718
1701
|
# Pass arguments to `rename_tag_template_field` via a request object, either of type
|
@@ -1730,9 +1713,7 @@ module Google
|
|
1730
1713
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1731
1714
|
#
|
1732
1715
|
# @param name [::String]
|
1733
|
-
# Required. The name of the tag template.
|
1734
|
-
#
|
1735
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
1716
|
+
# Required. The name of the tag template.
|
1736
1717
|
# @param new_tag_template_field_id [::String]
|
1737
1718
|
# Required. The new ID of this tag template field. For example, `my_new_field`.
|
1738
1719
|
#
|
@@ -1782,8 +1763,9 @@ module Google
|
|
1782
1763
|
end
|
1783
1764
|
|
1784
1765
|
##
|
1785
|
-
# Renames an enum value in a tag template.
|
1786
|
-
#
|
1766
|
+
# Renames an enum value in a tag template.
|
1767
|
+
#
|
1768
|
+
# Within a single enum field, enum values must be unique.
|
1787
1769
|
#
|
1788
1770
|
# @overload rename_tag_template_field_enum_value(request, options = nil)
|
1789
1771
|
# Pass arguments to `rename_tag_template_field_enum_value` via a request object, either of type
|
@@ -1801,9 +1783,7 @@ module Google
|
|
1801
1783
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1802
1784
|
#
|
1803
1785
|
# @param name [::String]
|
1804
|
-
# Required. The name of the enum field value.
|
1805
|
-
#
|
1806
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}/enumValues/\\{enum_value_display_name}
|
1786
|
+
# Required. The name of the enum field value.
|
1807
1787
|
# @param new_enum_value_display_name [::String]
|
1808
1788
|
# Required. The new display name of the enum value. For example, `my_new_enum_value`.
|
1809
1789
|
#
|
@@ -1853,11 +1833,12 @@ module Google
|
|
1853
1833
|
end
|
1854
1834
|
|
1855
1835
|
##
|
1856
|
-
# Deletes a field in a tag template and all uses of
|
1857
|
-
#
|
1858
|
-
#
|
1859
|
-
#
|
1860
|
-
# more information
|
1836
|
+
# Deletes a field in a tag template and all uses of this field from the tags
|
1837
|
+
# based on this template.
|
1838
|
+
#
|
1839
|
+
# You must enable the Data Catalog API in the project identified by
|
1840
|
+
# the `name` parameter. For more information, see [Data Catalog resource
|
1841
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1861
1842
|
#
|
1862
1843
|
# @overload delete_tag_template_field(request, options = nil)
|
1863
1844
|
# Pass arguments to `delete_tag_template_field` via a request object, either of type
|
@@ -1875,13 +1856,11 @@ module Google
|
|
1875
1856
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1876
1857
|
#
|
1877
1858
|
# @param name [::String]
|
1878
|
-
# Required. The name of the tag template field to delete.
|
1879
|
-
#
|
1880
|
-
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
1859
|
+
# Required. The name of the tag template field to delete.
|
1881
1860
|
# @param force [::Boolean]
|
1882
|
-
# Required.
|
1883
|
-
#
|
1884
|
-
# `
|
1861
|
+
# Required. If true, deletes this field from any tags that use it.
|
1862
|
+
#
|
1863
|
+
# Currently, `true` is the only supported value.
|
1885
1864
|
#
|
1886
1865
|
# @yield [response, operation] Access the result along with the RPC operation
|
1887
1866
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1929,13 +1908,18 @@ module Google
|
|
1929
1908
|
end
|
1930
1909
|
|
1931
1910
|
##
|
1932
|
-
# Creates a tag
|
1933
|
-
#
|
1934
|
-
#
|
1935
|
-
#
|
1936
|
-
#
|
1937
|
-
#
|
1938
|
-
#
|
1911
|
+
# Creates a tag and assigns it to:
|
1912
|
+
#
|
1913
|
+
# * An {::Google::Cloud::DataCatalog::V1::Entry Entry} if the method name is
|
1914
|
+
# ``projects.locations.entryGroups.entries.tags.create``.
|
1915
|
+
# * Or {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}if the method
|
1916
|
+
# name is ``projects.locations.entryGroups.tags.create``.
|
1917
|
+
#
|
1918
|
+
# Note: The project identified by the `parent` parameter for the [tag]
|
1919
|
+
# (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
|
1920
|
+
# and the [tag template]
|
1921
|
+
# (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
|
1922
|
+
# used to create the tag must be in the same organization.
|
1939
1923
|
#
|
1940
1924
|
# @overload create_tag(request, options = nil)
|
1941
1925
|
# Pass arguments to `create_tag` via a request object, either of type
|
@@ -1953,10 +1937,10 @@ module Google
|
|
1953
1937
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1954
1938
|
#
|
1955
1939
|
# @param parent [::String]
|
1956
|
-
# Required. The name of the resource to attach this tag to.
|
1957
|
-
# entries. An entry can have up to 1000 attached tags. Example:
|
1940
|
+
# Required. The name of the resource to attach this tag to.
|
1958
1941
|
#
|
1959
|
-
#
|
1942
|
+
# Tags can be attached to entries or entry groups. An entry can have up to
|
1943
|
+
# 1000 attached tags.
|
1960
1944
|
#
|
1961
1945
|
# Note: The tag and its child resources might not be stored in
|
1962
1946
|
# the location specified in its name.
|
@@ -2100,9 +2084,7 @@ module Google
|
|
2100
2084
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2101
2085
|
#
|
2102
2086
|
# @param name [::String]
|
2103
|
-
# Required. The name of the tag to delete.
|
2104
|
-
#
|
2105
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
|
2087
|
+
# Required. The name of the tag to delete.
|
2106
2088
|
#
|
2107
2089
|
# @yield [response, operation] Access the result along with the RPC operation
|
2108
2090
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -2150,7 +2132,7 @@ module Google
|
|
2150
2132
|
end
|
2151
2133
|
|
2152
2134
|
##
|
2153
|
-
# Lists
|
2135
|
+
# Lists tags assigned to an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
|
2154
2136
|
#
|
2155
2137
|
# @overload list_tags(request, options = nil)
|
2156
2138
|
# Pass arguments to `list_tags` via a request object, either of type
|
@@ -2168,19 +2150,16 @@ module Google
|
|
2168
2150
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2169
2151
|
#
|
2170
2152
|
# @param parent [::String]
|
2171
|
-
# Required. The name of the Data Catalog resource to list the tags of.
|
2172
|
-
# could be an {::Google::Cloud::DataCatalog::V1::Entry Entry} or an
|
2173
|
-
# {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
|
2153
|
+
# Required. The name of the Data Catalog resource to list the tags of.
|
2174
2154
|
#
|
2175
|
-
#
|
2176
|
-
#
|
2177
|
-
#
|
2178
|
-
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
2155
|
+
# The resource can be an {::Google::Cloud::DataCatalog::V1::Entry Entry}
|
2156
|
+
# or an {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}
|
2157
|
+
# (without `/entries/{entries}` at the end).
|
2179
2158
|
# @param page_size [::Integer]
|
2180
|
-
# The maximum number of tags to return. Default is 10.
|
2159
|
+
# The maximum number of tags to return. Default is 10. Maximum limit is 1000.
|
2181
2160
|
# @param page_token [::String]
|
2182
|
-
#
|
2183
|
-
# returned.
|
2161
|
+
# Pagination token that specifies the next page to return. If empty, the
|
2162
|
+
# first page is returned.
|
2184
2163
|
#
|
2185
2164
|
# @yield [response, operation] Access the result along with the RPC operation
|
2186
2165
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>]
|
@@ -2229,20 +2208,23 @@ module Google
|
|
2229
2208
|
end
|
2230
2209
|
|
2231
2210
|
##
|
2232
|
-
# Sets
|
2211
|
+
# Sets an access control policy for a resource. Replaces any existing
|
2233
2212
|
# policy.
|
2213
|
+
#
|
2234
2214
|
# Supported resources are:
|
2235
|
-
#
|
2236
|
-
#
|
2237
|
-
#
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
#
|
2241
|
-
#
|
2242
|
-
#
|
2243
|
-
#
|
2244
|
-
#
|
2245
|
-
#
|
2215
|
+
#
|
2216
|
+
# - Tag templates
|
2217
|
+
# - Entry groups
|
2218
|
+
#
|
2219
|
+
# Note: This method sets policies only within Data Catalog and can't be
|
2220
|
+
# used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
|
2221
|
+
# external Google Cloud Platform resources synced with the Data Catalog.
|
2222
|
+
#
|
2223
|
+
# To call this method, you must have the following Google IAM permissions:
|
2224
|
+
#
|
2225
|
+
# - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
|
2226
|
+
# templates.
|
2227
|
+
# - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
|
2246
2228
|
#
|
2247
2229
|
# @overload set_iam_policy(request, options = nil)
|
2248
2230
|
# Pass arguments to `set_iam_policy` via a request object, either of type
|
@@ -2314,22 +2296,27 @@ module Google
|
|
2314
2296
|
end
|
2315
2297
|
|
2316
2298
|
##
|
2317
|
-
# Gets the access control policy for a resource.
|
2318
|
-
#
|
2319
|
-
#
|
2299
|
+
# Gets the access control policy for a resource.
|
2300
|
+
#
|
2301
|
+
# May return:
|
2302
|
+
#
|
2303
|
+
# * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
|
2304
|
+
# permission to view it.
|
2305
|
+
# * An empty policy if the resource exists but doesn't have a set policy.
|
2320
2306
|
#
|
2321
2307
|
# Supported resources are:
|
2322
|
-
#
|
2323
|
-
#
|
2324
|
-
#
|
2325
|
-
#
|
2326
|
-
#
|
2327
|
-
#
|
2328
|
-
#
|
2329
|
-
#
|
2330
|
-
#
|
2331
|
-
#
|
2332
|
-
#
|
2308
|
+
#
|
2309
|
+
# - Tag templates
|
2310
|
+
# - Entry groups
|
2311
|
+
#
|
2312
|
+
# Note: This method doesn't get policies from Google Cloud Platform
|
2313
|
+
# resources ingested into Data Catalog.
|
2314
|
+
#
|
2315
|
+
# To call this method, you must have the following Google IAM permissions:
|
2316
|
+
#
|
2317
|
+
# - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
|
2318
|
+
# templates.
|
2319
|
+
# - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
|
2333
2320
|
#
|
2334
2321
|
# @overload get_iam_policy(request, options = nil)
|
2335
2322
|
# Pass arguments to `get_iam_policy` via a request object, either of type
|
@@ -2399,19 +2386,20 @@ module Google
|
|
2399
2386
|
end
|
2400
2387
|
|
2401
2388
|
##
|
2402
|
-
#
|
2403
|
-
#
|
2404
|
-
#
|
2389
|
+
# Gets your permissions on a resource.
|
2390
|
+
#
|
2391
|
+
# Returns an empty set of permissions if the resource doesn't exist.
|
2405
2392
|
#
|
2406
2393
|
# Supported resources are:
|
2407
|
-
#
|
2408
|
-
#
|
2409
|
-
#
|
2410
|
-
#
|
2411
|
-
#
|
2412
|
-
#
|
2413
|
-
#
|
2414
|
-
#
|
2394
|
+
#
|
2395
|
+
# - Tag templates
|
2396
|
+
# - Entry groups
|
2397
|
+
#
|
2398
|
+
# Note: This method gets policies only within Data Catalog and can't be
|
2399
|
+
# used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
|
2400
|
+
# external Google Cloud Platform resources ingested into Data Catalog.
|
2401
|
+
#
|
2402
|
+
# No Google IAM permissions are required to call this method.
|
2415
2403
|
#
|
2416
2404
|
# @overload test_iam_permissions(request, options = nil)
|
2417
2405
|
# Pass arguments to `test_iam_permissions` via a request object, either of type
|