google-cloud-data_catalog-v1 0.12.1 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +30 -24
- data/lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb +3011 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog/rest/service_stub.rb +2022 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog/rest.rb +53 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog.rb +7 -1
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +22 -12
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/rest/client.rb +1270 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/rest/service_stub.rb +846 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/rest.rb +57 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +7 -1
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +14 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb +536 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/service_stub.rb +227 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest.rb +55 -0
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +7 -1
- data/lib/google/cloud/data_catalog/v1/rest.rb +39 -0
- data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
- data/lib/google/cloud/data_catalog/v1.rb +7 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- metadata +33 -16
- data/proto_docs/google/iam/v1/iam_policy.rb +0 -87
- data/proto_docs/google/iam/v1/options.rb +0 -50
- data/proto_docs/google/iam/v1/policy.rb +0 -418
@@ -0,0 +1,3011 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/errors"
|
20
|
+
require "google/cloud/datacatalog/v1/datacatalog_pb"
|
21
|
+
require "google/cloud/data_catalog/v1/data_catalog/rest/service_stub"
|
22
|
+
require "google/iam/v1/rest"
|
23
|
+
|
24
|
+
module Google
|
25
|
+
module Cloud
|
26
|
+
module DataCatalog
|
27
|
+
module V1
|
28
|
+
module DataCatalog
|
29
|
+
module Rest
|
30
|
+
##
|
31
|
+
# REST client for the DataCatalog service.
|
32
|
+
#
|
33
|
+
# Data Catalog API service allows you to discover, understand, and manage
|
34
|
+
# your data.
|
35
|
+
#
|
36
|
+
class Client
|
37
|
+
include Paths
|
38
|
+
|
39
|
+
# @private
|
40
|
+
attr_reader :data_catalog_stub
|
41
|
+
|
42
|
+
##
|
43
|
+
# Configure the DataCatalog Client class.
|
44
|
+
#
|
45
|
+
# See {::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client::Configuration}
|
46
|
+
# for a description of the configuration fields.
|
47
|
+
#
|
48
|
+
# @example
|
49
|
+
#
|
50
|
+
# # Modify the configuration for all DataCatalog clients
|
51
|
+
# ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.configure do |config|
|
52
|
+
# config.timeout = 10.0
|
53
|
+
# end
|
54
|
+
#
|
55
|
+
# @yield [config] Configure the Client client.
|
56
|
+
# @yieldparam config [Client::Configuration]
|
57
|
+
#
|
58
|
+
# @return [Client::Configuration]
|
59
|
+
#
|
60
|
+
def self.configure
|
61
|
+
@configure ||= begin
|
62
|
+
namespace = ["Google", "Cloud", "DataCatalog", "V1"]
|
63
|
+
parent_config = while namespace.any?
|
64
|
+
parent_name = namespace.join "::"
|
65
|
+
parent_const = const_get parent_name
|
66
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
67
|
+
namespace.pop
|
68
|
+
end
|
69
|
+
default_config = Client::Configuration.new parent_config
|
70
|
+
|
71
|
+
default_config.timeout = 60.0
|
72
|
+
|
73
|
+
default_config.rpcs.search_catalog.timeout = 60.0
|
74
|
+
default_config.rpcs.search_catalog.retry_policy = {
|
75
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
76
|
+
}
|
77
|
+
|
78
|
+
default_config.rpcs.get_entry_group.timeout = 60.0
|
79
|
+
default_config.rpcs.get_entry_group.retry_policy = {
|
80
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
81
|
+
}
|
82
|
+
|
83
|
+
default_config.rpcs.list_entry_groups.timeout = 60.0
|
84
|
+
default_config.rpcs.list_entry_groups.retry_policy = {
|
85
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
86
|
+
}
|
87
|
+
|
88
|
+
default_config.rpcs.get_entry.timeout = 60.0
|
89
|
+
default_config.rpcs.get_entry.retry_policy = {
|
90
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
91
|
+
}
|
92
|
+
|
93
|
+
default_config.rpcs.lookup_entry.timeout = 60.0
|
94
|
+
default_config.rpcs.lookup_entry.retry_policy = {
|
95
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
96
|
+
}
|
97
|
+
|
98
|
+
default_config.rpcs.list_entries.timeout = 60.0
|
99
|
+
default_config.rpcs.list_entries.retry_policy = {
|
100
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
101
|
+
}
|
102
|
+
|
103
|
+
default_config.rpcs.list_tags.timeout = 60.0
|
104
|
+
default_config.rpcs.list_tags.retry_policy = {
|
105
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
106
|
+
}
|
107
|
+
|
108
|
+
default_config.rpcs.get_iam_policy.timeout = 60.0
|
109
|
+
default_config.rpcs.get_iam_policy.retry_policy = {
|
110
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
111
|
+
}
|
112
|
+
|
113
|
+
default_config
|
114
|
+
end
|
115
|
+
yield @configure if block_given?
|
116
|
+
@configure
|
117
|
+
end
|
118
|
+
|
119
|
+
##
|
120
|
+
# Configure the DataCatalog Client instance.
|
121
|
+
#
|
122
|
+
# The configuration is set to the derived mode, meaning that values can be changed,
|
123
|
+
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
|
124
|
+
# should be made on {Client.configure}.
|
125
|
+
#
|
126
|
+
# See {::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client::Configuration}
|
127
|
+
# for a description of the configuration fields.
|
128
|
+
#
|
129
|
+
# @yield [config] Configure the Client client.
|
130
|
+
# @yieldparam config [Client::Configuration]
|
131
|
+
#
|
132
|
+
# @return [Client::Configuration]
|
133
|
+
#
|
134
|
+
def configure
|
135
|
+
yield @config if block_given?
|
136
|
+
@config
|
137
|
+
end
|
138
|
+
|
139
|
+
##
|
140
|
+
# Create a new DataCatalog REST client object.
|
141
|
+
#
|
142
|
+
# @example
|
143
|
+
#
|
144
|
+
# # Create a client using the default configuration
|
145
|
+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new
|
146
|
+
#
|
147
|
+
# # Create a client using a custom configuration
|
148
|
+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new do |config|
|
149
|
+
# config.timeout = 10.0
|
150
|
+
# end
|
151
|
+
#
|
152
|
+
# @yield [config] Configure the DataCatalog client.
|
153
|
+
# @yieldparam config [Client::Configuration]
|
154
|
+
#
|
155
|
+
def initialize
|
156
|
+
# Create the configuration object
|
157
|
+
@config = Configuration.new Client.configure
|
158
|
+
|
159
|
+
# Yield the configuration if needed
|
160
|
+
yield @config if block_given?
|
161
|
+
|
162
|
+
# Create credentials
|
163
|
+
credentials = @config.credentials
|
164
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
165
|
+
# but only if the default endpoint does not have a region prefix.
|
166
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
167
|
+
!@config.endpoint.split(".").first.include?("-")
|
168
|
+
credentials ||= Credentials.default scope: @config.scope,
|
169
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
170
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
171
|
+
credentials = Credentials.new credentials, scope: @config.scope
|
172
|
+
end
|
173
|
+
|
174
|
+
@quota_project_id = @config.quota_project
|
175
|
+
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
176
|
+
|
177
|
+
@iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
|
178
|
+
config.credentials = credentials
|
179
|
+
config.quota_project = @quota_project_id
|
180
|
+
config.endpoint = @config.endpoint
|
181
|
+
end
|
182
|
+
|
183
|
+
@data_catalog_stub = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
|
184
|
+
end
|
185
|
+
|
186
|
+
##
|
187
|
+
# Get the associated client for mix-in of the IAMPolicy.
|
188
|
+
#
|
189
|
+
# @return [Google::Iam::V1::IAMPolicy::Rest::Client]
|
190
|
+
#
|
191
|
+
attr_reader :iam_policy_client
|
192
|
+
|
193
|
+
# Service calls
|
194
|
+
|
195
|
+
##
|
196
|
+
# Searches Data Catalog for multiple resources like entries and tags that
|
197
|
+
# match a query.
|
198
|
+
#
|
199
|
+
# This is a [Custom Method]
|
200
|
+
# (https://cloud.google.com/apis/design/custom_methods) that doesn't return
|
201
|
+
# all information on a resource, only its ID and high level fields. To get
|
202
|
+
# more information, you can subsequently call specific get methods.
|
203
|
+
#
|
204
|
+
# Note: Data Catalog search queries don't guarantee full recall. Results
|
205
|
+
# that match your query might not be returned, even in subsequent
|
206
|
+
# result pages. Additionally, returned (and not returned) results can vary
|
207
|
+
# if you repeat search queries.
|
208
|
+
#
|
209
|
+
# For more information, see [Data Catalog search syntax]
|
210
|
+
# (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
|
211
|
+
#
|
212
|
+
# @overload search_catalog(request, options = nil)
|
213
|
+
# Pass arguments to `search_catalog` via a request object, either of type
|
214
|
+
# {::Google::Cloud::DataCatalog::V1::SearchCatalogRequest} or an equivalent Hash.
|
215
|
+
#
|
216
|
+
# @param request [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest, ::Hash]
|
217
|
+
# A request object representing the call parameters. Required. To specify no
|
218
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
219
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
220
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
221
|
+
#
|
222
|
+
# @overload search_catalog(scope: nil, query: nil, page_size: nil, page_token: nil, order_by: nil)
|
223
|
+
# Pass arguments to `search_catalog` via keyword arguments. Note that at
|
224
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
225
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
226
|
+
#
|
227
|
+
# @param scope [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, ::Hash]
|
228
|
+
# Required. The scope of this search request.
|
229
|
+
#
|
230
|
+
# The `scope` is invalid if `include_org_ids`, `include_project_ids` are
|
231
|
+
# empty AND `include_gcp_public_datasets` is set to `false`. In this case,
|
232
|
+
# the request returns an error.
|
233
|
+
# @param query [::String]
|
234
|
+
# Optional. The query string with a minimum of 3 characters and specific syntax.
|
235
|
+
# For more information, see
|
236
|
+
# [Data Catalog search
|
237
|
+
# syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
|
238
|
+
#
|
239
|
+
# An empty query string returns all data assets (in the specified scope)
|
240
|
+
# that you have access to.
|
241
|
+
#
|
242
|
+
# A query string can be a simple `xyz` or qualified by predicates:
|
243
|
+
#
|
244
|
+
# * `name:x`
|
245
|
+
# * `column:y`
|
246
|
+
# * `description:z`
|
247
|
+
# @param page_size [::Integer]
|
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.
|
253
|
+
# @param page_token [::String]
|
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
|
259
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client#search_catalog SearchCatalogRequest}
|
260
|
+
# call.
|
261
|
+
# @param order_by [::String]
|
262
|
+
# Specifies the order of results.
|
263
|
+
#
|
264
|
+
# Currently supported case-sensitive values are:
|
265
|
+
#
|
266
|
+
# * `relevance` that can only be descending
|
267
|
+
# * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
|
268
|
+
# * `default` that can only be descending
|
269
|
+
#
|
270
|
+
# If this parameter is omitted, it defaults to the descending `relevance`.
|
271
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
272
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::SearchCatalogResponse]
|
273
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
274
|
+
#
|
275
|
+
# @return [::Google::Cloud::DataCatalog::V1::SearchCatalogResponse]
|
276
|
+
#
|
277
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
278
|
+
def search_catalog request, options = nil
|
279
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
280
|
+
|
281
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest
|
282
|
+
|
283
|
+
# Converts hash and nil to an options object
|
284
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
285
|
+
|
286
|
+
# Customize the options with defaults
|
287
|
+
call_metadata = @config.rpcs.search_catalog.metadata.to_h
|
288
|
+
|
289
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
290
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
291
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
292
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
293
|
+
transports_version_send: [:rest]
|
294
|
+
|
295
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
296
|
+
|
297
|
+
options.apply_defaults timeout: @config.rpcs.search_catalog.timeout,
|
298
|
+
metadata: call_metadata,
|
299
|
+
retry_policy: @config.rpcs.search_catalog.retry_policy
|
300
|
+
|
301
|
+
options.apply_defaults timeout: @config.timeout,
|
302
|
+
metadata: @config.metadata,
|
303
|
+
retry_policy: @config.retry_policy
|
304
|
+
|
305
|
+
@data_catalog_stub.search_catalog request, options do |result, operation|
|
306
|
+
yield result, operation if block_given?
|
307
|
+
return result
|
308
|
+
end
|
309
|
+
rescue ::Gapic::Rest::Error => e
|
310
|
+
raise ::Google::Cloud::Error.from_error(e)
|
311
|
+
end
|
312
|
+
|
313
|
+
##
|
314
|
+
# Creates an entry group.
|
315
|
+
#
|
316
|
+
# An entry group contains logically related entries together with [Cloud
|
317
|
+
# Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
|
318
|
+
# These policies specify users who can create, edit, and view entries
|
319
|
+
# within entry groups.
|
320
|
+
#
|
321
|
+
# Data Catalog automatically creates entry groups with names that start with
|
322
|
+
# the `@` symbol for the following resources:
|
323
|
+
#
|
324
|
+
# * BigQuery entries (`@bigquery`)
|
325
|
+
# * Pub/Sub topics (`@pubsub`)
|
326
|
+
# * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
|
327
|
+
#
|
328
|
+
# You can create your own entry groups for Cloud Storage fileset entries
|
329
|
+
# and custom entries together with the corresponding IAM policies.
|
330
|
+
# User-created entry groups can't contain the `@` symbol, it is reserved
|
331
|
+
# for automatically created groups.
|
332
|
+
#
|
333
|
+
# Entry groups, like entries, can be searched.
|
334
|
+
#
|
335
|
+
# A maximum of 10,000 entry groups may be created per organization across all
|
336
|
+
# locations.
|
337
|
+
#
|
338
|
+
# You must enable the Data Catalog API in the project identified by
|
339
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
340
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
341
|
+
#
|
342
|
+
# @overload create_entry_group(request, options = nil)
|
343
|
+
# Pass arguments to `create_entry_group` via a request object, either of type
|
344
|
+
# {::Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest} or an equivalent Hash.
|
345
|
+
#
|
346
|
+
# @param request [::Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest, ::Hash]
|
347
|
+
# A request object representing the call parameters. Required. To specify no
|
348
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
349
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
350
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
351
|
+
#
|
352
|
+
# @overload create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil)
|
353
|
+
# Pass arguments to `create_entry_group` via keyword arguments. Note that at
|
354
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
355
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
356
|
+
#
|
357
|
+
# @param parent [::String]
|
358
|
+
# Required. The names of the project and location that the new entry group belongs to.
|
359
|
+
#
|
360
|
+
# Note: The entry group itself and its child resources might not be
|
361
|
+
# stored in the location specified in its name.
|
362
|
+
# @param entry_group_id [::String]
|
363
|
+
# Required. The ID of the entry group to create.
|
364
|
+
#
|
365
|
+
# The ID must contain only letters (a-z, A-Z), numbers (0-9),
|
366
|
+
# underscores (_), and must start with a letter or underscore.
|
367
|
+
# The maximum size is 64 bytes when encoded in UTF-8.
|
368
|
+
# @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
|
369
|
+
# The entry group to create. Defaults to empty.
|
370
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
371
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
372
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
373
|
+
#
|
374
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
375
|
+
#
|
376
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
377
|
+
def create_entry_group request, options = nil
|
378
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
379
|
+
|
380
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest
|
381
|
+
|
382
|
+
# Converts hash and nil to an options object
|
383
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
384
|
+
|
385
|
+
# Customize the options with defaults
|
386
|
+
call_metadata = @config.rpcs.create_entry_group.metadata.to_h
|
387
|
+
|
388
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
389
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
390
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
391
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
392
|
+
transports_version_send: [:rest]
|
393
|
+
|
394
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
395
|
+
|
396
|
+
options.apply_defaults timeout: @config.rpcs.create_entry_group.timeout,
|
397
|
+
metadata: call_metadata,
|
398
|
+
retry_policy: @config.rpcs.create_entry_group.retry_policy
|
399
|
+
|
400
|
+
options.apply_defaults timeout: @config.timeout,
|
401
|
+
metadata: @config.metadata,
|
402
|
+
retry_policy: @config.retry_policy
|
403
|
+
|
404
|
+
@data_catalog_stub.create_entry_group request, options do |result, operation|
|
405
|
+
yield result, operation if block_given?
|
406
|
+
return result
|
407
|
+
end
|
408
|
+
rescue ::Gapic::Rest::Error => e
|
409
|
+
raise ::Google::Cloud::Error.from_error(e)
|
410
|
+
end
|
411
|
+
|
412
|
+
##
|
413
|
+
# Gets an entry group.
|
414
|
+
#
|
415
|
+
# @overload get_entry_group(request, options = nil)
|
416
|
+
# Pass arguments to `get_entry_group` via a request object, either of type
|
417
|
+
# {::Google::Cloud::DataCatalog::V1::GetEntryGroupRequest} or an equivalent Hash.
|
418
|
+
#
|
419
|
+
# @param request [::Google::Cloud::DataCatalog::V1::GetEntryGroupRequest, ::Hash]
|
420
|
+
# A request object representing the call parameters. Required. To specify no
|
421
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
422
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
423
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
424
|
+
#
|
425
|
+
# @overload get_entry_group(name: nil, read_mask: nil)
|
426
|
+
# Pass arguments to `get_entry_group` via keyword arguments. Note that at
|
427
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
428
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
429
|
+
#
|
430
|
+
# @param name [::String]
|
431
|
+
# Required. The name of the entry group to get.
|
432
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
433
|
+
# The fields to return. If empty or omitted, all fields are returned.
|
434
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
435
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
436
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
437
|
+
#
|
438
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
439
|
+
#
|
440
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
441
|
+
def get_entry_group request, options = nil
|
442
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
443
|
+
|
444
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::GetEntryGroupRequest
|
445
|
+
|
446
|
+
# Converts hash and nil to an options object
|
447
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
448
|
+
|
449
|
+
# Customize the options with defaults
|
450
|
+
call_metadata = @config.rpcs.get_entry_group.metadata.to_h
|
451
|
+
|
452
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
453
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
454
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
455
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
456
|
+
transports_version_send: [:rest]
|
457
|
+
|
458
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
459
|
+
|
460
|
+
options.apply_defaults timeout: @config.rpcs.get_entry_group.timeout,
|
461
|
+
metadata: call_metadata,
|
462
|
+
retry_policy: @config.rpcs.get_entry_group.retry_policy
|
463
|
+
|
464
|
+
options.apply_defaults timeout: @config.timeout,
|
465
|
+
metadata: @config.metadata,
|
466
|
+
retry_policy: @config.retry_policy
|
467
|
+
|
468
|
+
@data_catalog_stub.get_entry_group request, options do |result, operation|
|
469
|
+
yield result, operation if block_given?
|
470
|
+
return result
|
471
|
+
end
|
472
|
+
rescue ::Gapic::Rest::Error => e
|
473
|
+
raise ::Google::Cloud::Error.from_error(e)
|
474
|
+
end
|
475
|
+
|
476
|
+
##
|
477
|
+
# Updates an entry group.
|
478
|
+
#
|
479
|
+
# You must enable the Data Catalog API in the project identified by
|
480
|
+
# the `entry_group.name` parameter. For more information, see [Data Catalog
|
481
|
+
# resource
|
482
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
483
|
+
#
|
484
|
+
# @overload update_entry_group(request, options = nil)
|
485
|
+
# Pass arguments to `update_entry_group` via a request object, either of type
|
486
|
+
# {::Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest} or an equivalent Hash.
|
487
|
+
#
|
488
|
+
# @param request [::Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest, ::Hash]
|
489
|
+
# A request object representing the call parameters. Required. To specify no
|
490
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
491
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
492
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
493
|
+
#
|
494
|
+
# @overload update_entry_group(entry_group: nil, update_mask: nil)
|
495
|
+
# Pass arguments to `update_entry_group` via keyword arguments. Note that at
|
496
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
497
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
498
|
+
#
|
499
|
+
# @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
|
500
|
+
# Required. Updates for the entry group. The `name` field must be set.
|
501
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
502
|
+
# Names of fields whose values to overwrite on an entry group.
|
503
|
+
#
|
504
|
+
# If this parameter is absent or empty, all modifiable fields
|
505
|
+
# are overwritten. If such fields are non-required and omitted in the
|
506
|
+
# request body, their values are emptied.
|
507
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
508
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
509
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
510
|
+
#
|
511
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
512
|
+
#
|
513
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
514
|
+
def update_entry_group request, options = nil
|
515
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
516
|
+
|
517
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest
|
518
|
+
|
519
|
+
# Converts hash and nil to an options object
|
520
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
521
|
+
|
522
|
+
# Customize the options with defaults
|
523
|
+
call_metadata = @config.rpcs.update_entry_group.metadata.to_h
|
524
|
+
|
525
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
526
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
527
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
528
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
529
|
+
transports_version_send: [:rest]
|
530
|
+
|
531
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
532
|
+
|
533
|
+
options.apply_defaults timeout: @config.rpcs.update_entry_group.timeout,
|
534
|
+
metadata: call_metadata,
|
535
|
+
retry_policy: @config.rpcs.update_entry_group.retry_policy
|
536
|
+
|
537
|
+
options.apply_defaults timeout: @config.timeout,
|
538
|
+
metadata: @config.metadata,
|
539
|
+
retry_policy: @config.retry_policy
|
540
|
+
|
541
|
+
@data_catalog_stub.update_entry_group request, options do |result, operation|
|
542
|
+
yield result, operation if block_given?
|
543
|
+
return result
|
544
|
+
end
|
545
|
+
rescue ::Gapic::Rest::Error => e
|
546
|
+
raise ::Google::Cloud::Error.from_error(e)
|
547
|
+
end
|
548
|
+
|
549
|
+
##
|
550
|
+
# Deletes an entry group.
|
551
|
+
#
|
552
|
+
# You must enable the Data Catalog API in the project
|
553
|
+
# identified by the `name` parameter. For more information, see [Data Catalog
|
554
|
+
# resource
|
555
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
556
|
+
#
|
557
|
+
# @overload delete_entry_group(request, options = nil)
|
558
|
+
# Pass arguments to `delete_entry_group` via a request object, either of type
|
559
|
+
# {::Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest} or an equivalent Hash.
|
560
|
+
#
|
561
|
+
# @param request [::Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest, ::Hash]
|
562
|
+
# A request object representing the call parameters. Required. To specify no
|
563
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
564
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
565
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
566
|
+
#
|
567
|
+
# @overload delete_entry_group(name: nil, force: nil)
|
568
|
+
# Pass arguments to `delete_entry_group` via keyword arguments. Note that at
|
569
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
570
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
571
|
+
#
|
572
|
+
# @param name [::String]
|
573
|
+
# Required. The name of the entry group to delete.
|
574
|
+
# @param force [::Boolean]
|
575
|
+
# Optional. If true, deletes all entries in the entry group.
|
576
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
577
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
578
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
579
|
+
#
|
580
|
+
# @return [::Google::Protobuf::Empty]
|
581
|
+
#
|
582
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
583
|
+
def delete_entry_group request, options = nil
|
584
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
585
|
+
|
586
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest
|
587
|
+
|
588
|
+
# Converts hash and nil to an options object
|
589
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
590
|
+
|
591
|
+
# Customize the options with defaults
|
592
|
+
call_metadata = @config.rpcs.delete_entry_group.metadata.to_h
|
593
|
+
|
594
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
595
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
596
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
597
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
598
|
+
transports_version_send: [:rest]
|
599
|
+
|
600
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
601
|
+
|
602
|
+
options.apply_defaults timeout: @config.rpcs.delete_entry_group.timeout,
|
603
|
+
metadata: call_metadata,
|
604
|
+
retry_policy: @config.rpcs.delete_entry_group.retry_policy
|
605
|
+
|
606
|
+
options.apply_defaults timeout: @config.timeout,
|
607
|
+
metadata: @config.metadata,
|
608
|
+
retry_policy: @config.retry_policy
|
609
|
+
|
610
|
+
@data_catalog_stub.delete_entry_group request, options do |result, operation|
|
611
|
+
yield result, operation if block_given?
|
612
|
+
return result
|
613
|
+
end
|
614
|
+
rescue ::Gapic::Rest::Error => e
|
615
|
+
raise ::Google::Cloud::Error.from_error(e)
|
616
|
+
end
|
617
|
+
|
618
|
+
##
|
619
|
+
# Lists entry groups.
|
620
|
+
#
|
621
|
+
# @overload list_entry_groups(request, options = nil)
|
622
|
+
# Pass arguments to `list_entry_groups` via a request object, either of type
|
623
|
+
# {::Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest} or an equivalent Hash.
|
624
|
+
#
|
625
|
+
# @param request [::Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest, ::Hash]
|
626
|
+
# A request object representing the call parameters. Required. To specify no
|
627
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
628
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
629
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
630
|
+
#
|
631
|
+
# @overload list_entry_groups(parent: nil, page_size: nil, page_token: nil)
|
632
|
+
# Pass arguments to `list_entry_groups` via keyword arguments. Note that at
|
633
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
634
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
635
|
+
#
|
636
|
+
# @param parent [::String]
|
637
|
+
# Required. The name of the location that contains the entry groups to list.
|
638
|
+
#
|
639
|
+
# Can be provided as a URL.
|
640
|
+
# @param page_size [::Integer]
|
641
|
+
# Optional. The maximum number of items to return.
|
642
|
+
#
|
643
|
+
# Default is 10. Maximum limit is 1000.
|
644
|
+
# Throws an invalid argument if `page_size` is greater than 1000.
|
645
|
+
# @param page_token [::String]
|
646
|
+
# Optional. Pagination token that specifies the next page to return.
|
647
|
+
# If empty, returns the first page.
|
648
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
649
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
|
650
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
651
|
+
#
|
652
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
|
653
|
+
#
|
654
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
655
|
+
def list_entry_groups request, options = nil
|
656
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
657
|
+
|
658
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest
|
659
|
+
|
660
|
+
# Converts hash and nil to an options object
|
661
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
662
|
+
|
663
|
+
# Customize the options with defaults
|
664
|
+
call_metadata = @config.rpcs.list_entry_groups.metadata.to_h
|
665
|
+
|
666
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
667
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
668
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
669
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
670
|
+
transports_version_send: [:rest]
|
671
|
+
|
672
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
673
|
+
|
674
|
+
options.apply_defaults timeout: @config.rpcs.list_entry_groups.timeout,
|
675
|
+
metadata: call_metadata,
|
676
|
+
retry_policy: @config.rpcs.list_entry_groups.retry_policy
|
677
|
+
|
678
|
+
options.apply_defaults timeout: @config.timeout,
|
679
|
+
metadata: @config.metadata,
|
680
|
+
retry_policy: @config.retry_policy
|
681
|
+
|
682
|
+
@data_catalog_stub.list_entry_groups request, options do |result, operation|
|
683
|
+
result = ::Gapic::Rest::PagedEnumerable.new @data_catalog_stub, :list_entry_groups, "entry_groups", request, result, options
|
684
|
+
yield result, operation if block_given?
|
685
|
+
return result
|
686
|
+
end
|
687
|
+
rescue ::Gapic::Rest::Error => e
|
688
|
+
raise ::Google::Cloud::Error.from_error(e)
|
689
|
+
end
|
690
|
+
|
691
|
+
##
|
692
|
+
# Creates an entry.
|
693
|
+
#
|
694
|
+
# You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
|
695
|
+
# or custom types. Data Catalog automatically creates entries with other
|
696
|
+
# types during metadata ingestion from integrated systems.
|
697
|
+
#
|
698
|
+
# You must enable the Data Catalog API in the project identified by
|
699
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
700
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
701
|
+
#
|
702
|
+
# An entry group can have a maximum of 100,000 entries.
|
703
|
+
#
|
704
|
+
# @overload create_entry(request, options = nil)
|
705
|
+
# Pass arguments to `create_entry` via a request object, either of type
|
706
|
+
# {::Google::Cloud::DataCatalog::V1::CreateEntryRequest} or an equivalent Hash.
|
707
|
+
#
|
708
|
+
# @param request [::Google::Cloud::DataCatalog::V1::CreateEntryRequest, ::Hash]
|
709
|
+
# A request object representing the call parameters. Required. To specify no
|
710
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
711
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
712
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
713
|
+
#
|
714
|
+
# @overload create_entry(parent: nil, entry_id: nil, entry: nil)
|
715
|
+
# Pass arguments to `create_entry` via keyword arguments. Note that at
|
716
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
717
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
718
|
+
#
|
719
|
+
# @param parent [::String]
|
720
|
+
# Required. The name of the entry group this entry belongs to.
|
721
|
+
#
|
722
|
+
# Note: The entry itself and its child resources might not be stored in
|
723
|
+
# the location specified in its name.
|
724
|
+
# @param entry_id [::String]
|
725
|
+
# Required. The ID of the entry to create.
|
726
|
+
#
|
727
|
+
# The ID must contain only letters (a-z, A-Z), numbers (0-9),
|
728
|
+
# and underscores (_).
|
729
|
+
# The maximum size is 64 bytes when encoded in UTF-8.
|
730
|
+
# @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
|
731
|
+
# Required. The entry to create.
|
732
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
733
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Entry]
|
734
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
735
|
+
#
|
736
|
+
# @return [::Google::Cloud::DataCatalog::V1::Entry]
|
737
|
+
#
|
738
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
739
|
+
def create_entry request, options = nil
|
740
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
741
|
+
|
742
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateEntryRequest
|
743
|
+
|
744
|
+
# Converts hash and nil to an options object
|
745
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
746
|
+
|
747
|
+
# Customize the options with defaults
|
748
|
+
call_metadata = @config.rpcs.create_entry.metadata.to_h
|
749
|
+
|
750
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
751
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
752
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
753
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
754
|
+
transports_version_send: [:rest]
|
755
|
+
|
756
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
757
|
+
|
758
|
+
options.apply_defaults timeout: @config.rpcs.create_entry.timeout,
|
759
|
+
metadata: call_metadata,
|
760
|
+
retry_policy: @config.rpcs.create_entry.retry_policy
|
761
|
+
|
762
|
+
options.apply_defaults timeout: @config.timeout,
|
763
|
+
metadata: @config.metadata,
|
764
|
+
retry_policy: @config.retry_policy
|
765
|
+
|
766
|
+
@data_catalog_stub.create_entry request, options do |result, operation|
|
767
|
+
yield result, operation if block_given?
|
768
|
+
return result
|
769
|
+
end
|
770
|
+
rescue ::Gapic::Rest::Error => e
|
771
|
+
raise ::Google::Cloud::Error.from_error(e)
|
772
|
+
end
|
773
|
+
|
774
|
+
##
|
775
|
+
# Updates an existing entry.
|
776
|
+
#
|
777
|
+
# You must enable the Data Catalog API in the project identified by
|
778
|
+
# the `entry.name` parameter. For more information, see [Data Catalog
|
779
|
+
# resource
|
780
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
781
|
+
#
|
782
|
+
# @overload update_entry(request, options = nil)
|
783
|
+
# Pass arguments to `update_entry` via a request object, either of type
|
784
|
+
# {::Google::Cloud::DataCatalog::V1::UpdateEntryRequest} or an equivalent Hash.
|
785
|
+
#
|
786
|
+
# @param request [::Google::Cloud::DataCatalog::V1::UpdateEntryRequest, ::Hash]
|
787
|
+
# A request object representing the call parameters. Required. To specify no
|
788
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
789
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
790
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
791
|
+
#
|
792
|
+
# @overload update_entry(entry: nil, update_mask: nil)
|
793
|
+
# Pass arguments to `update_entry` via keyword arguments. Note that at
|
794
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
795
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
796
|
+
#
|
797
|
+
# @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
|
798
|
+
# Required. Updates for the entry. The `name` field must be set.
|
799
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
800
|
+
# Names of fields whose values to overwrite on an entry.
|
801
|
+
#
|
802
|
+
# If this parameter is absent or empty, all modifiable fields
|
803
|
+
# are overwritten. If such fields are non-required and omitted in the
|
804
|
+
# request body, their values are emptied.
|
805
|
+
#
|
806
|
+
# You can modify only the fields listed below.
|
807
|
+
#
|
808
|
+
# For entries with type `DATA_STREAM`:
|
809
|
+
#
|
810
|
+
# * `schema`
|
811
|
+
#
|
812
|
+
# For entries with type `FILESET`:
|
813
|
+
#
|
814
|
+
# * `schema`
|
815
|
+
# * `display_name`
|
816
|
+
# * `description`
|
817
|
+
# * `gcs_fileset_spec`
|
818
|
+
# * `gcs_fileset_spec.file_patterns`
|
819
|
+
#
|
820
|
+
# For entries with `user_specified_type`:
|
821
|
+
#
|
822
|
+
# * `schema`
|
823
|
+
# * `display_name`
|
824
|
+
# * `description`
|
825
|
+
# * `user_specified_type`
|
826
|
+
# * `user_specified_system`
|
827
|
+
# * `linked_resource`
|
828
|
+
# * `source_system_timestamps`
|
829
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
830
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Entry]
|
831
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
832
|
+
#
|
833
|
+
# @return [::Google::Cloud::DataCatalog::V1::Entry]
|
834
|
+
#
|
835
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
836
|
+
def update_entry request, options = nil
|
837
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
838
|
+
|
839
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateEntryRequest
|
840
|
+
|
841
|
+
# Converts hash and nil to an options object
|
842
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
843
|
+
|
844
|
+
# Customize the options with defaults
|
845
|
+
call_metadata = @config.rpcs.update_entry.metadata.to_h
|
846
|
+
|
847
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
848
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
849
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
850
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
851
|
+
transports_version_send: [:rest]
|
852
|
+
|
853
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
854
|
+
|
855
|
+
options.apply_defaults timeout: @config.rpcs.update_entry.timeout,
|
856
|
+
metadata: call_metadata,
|
857
|
+
retry_policy: @config.rpcs.update_entry.retry_policy
|
858
|
+
|
859
|
+
options.apply_defaults timeout: @config.timeout,
|
860
|
+
metadata: @config.metadata,
|
861
|
+
retry_policy: @config.retry_policy
|
862
|
+
|
863
|
+
@data_catalog_stub.update_entry request, options do |result, operation|
|
864
|
+
yield result, operation if block_given?
|
865
|
+
return result
|
866
|
+
end
|
867
|
+
rescue ::Gapic::Rest::Error => e
|
868
|
+
raise ::Google::Cloud::Error.from_error(e)
|
869
|
+
end
|
870
|
+
|
871
|
+
##
|
872
|
+
# Deletes an existing entry.
|
873
|
+
#
|
874
|
+
# You can delete only the entries created by the
|
875
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client#create_entry CreateEntry}
|
876
|
+
# method.
|
877
|
+
#
|
878
|
+
# You must enable the Data Catalog API in the project identified by
|
879
|
+
# the `name` parameter. For more information, see [Data Catalog
|
880
|
+
# resource
|
881
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
882
|
+
#
|
883
|
+
# @overload delete_entry(request, options = nil)
|
884
|
+
# Pass arguments to `delete_entry` via a request object, either of type
|
885
|
+
# {::Google::Cloud::DataCatalog::V1::DeleteEntryRequest} or an equivalent Hash.
|
886
|
+
#
|
887
|
+
# @param request [::Google::Cloud::DataCatalog::V1::DeleteEntryRequest, ::Hash]
|
888
|
+
# A request object representing the call parameters. Required. To specify no
|
889
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
890
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
891
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
892
|
+
#
|
893
|
+
# @overload delete_entry(name: nil)
|
894
|
+
# Pass arguments to `delete_entry` via keyword arguments. Note that at
|
895
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
896
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
897
|
+
#
|
898
|
+
# @param name [::String]
|
899
|
+
# Required. The name of the entry to delete.
|
900
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
901
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
902
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
903
|
+
#
|
904
|
+
# @return [::Google::Protobuf::Empty]
|
905
|
+
#
|
906
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
907
|
+
def delete_entry request, options = nil
|
908
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
909
|
+
|
910
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteEntryRequest
|
911
|
+
|
912
|
+
# Converts hash and nil to an options object
|
913
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
914
|
+
|
915
|
+
# Customize the options with defaults
|
916
|
+
call_metadata = @config.rpcs.delete_entry.metadata.to_h
|
917
|
+
|
918
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
919
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
920
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
921
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
922
|
+
transports_version_send: [:rest]
|
923
|
+
|
924
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
925
|
+
|
926
|
+
options.apply_defaults timeout: @config.rpcs.delete_entry.timeout,
|
927
|
+
metadata: call_metadata,
|
928
|
+
retry_policy: @config.rpcs.delete_entry.retry_policy
|
929
|
+
|
930
|
+
options.apply_defaults timeout: @config.timeout,
|
931
|
+
metadata: @config.metadata,
|
932
|
+
retry_policy: @config.retry_policy
|
933
|
+
|
934
|
+
@data_catalog_stub.delete_entry request, options do |result, operation|
|
935
|
+
yield result, operation if block_given?
|
936
|
+
return result
|
937
|
+
end
|
938
|
+
rescue ::Gapic::Rest::Error => e
|
939
|
+
raise ::Google::Cloud::Error.from_error(e)
|
940
|
+
end
|
941
|
+
|
942
|
+
##
|
943
|
+
# Gets an entry.
|
944
|
+
#
|
945
|
+
# @overload get_entry(request, options = nil)
|
946
|
+
# Pass arguments to `get_entry` via a request object, either of type
|
947
|
+
# {::Google::Cloud::DataCatalog::V1::GetEntryRequest} or an equivalent Hash.
|
948
|
+
#
|
949
|
+
# @param request [::Google::Cloud::DataCatalog::V1::GetEntryRequest, ::Hash]
|
950
|
+
# A request object representing the call parameters. Required. To specify no
|
951
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
952
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
953
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
954
|
+
#
|
955
|
+
# @overload get_entry(name: nil)
|
956
|
+
# Pass arguments to `get_entry` via keyword arguments. Note that at
|
957
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
958
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
959
|
+
#
|
960
|
+
# @param name [::String]
|
961
|
+
# Required. The name of the entry to get.
|
962
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
963
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Entry]
|
964
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
965
|
+
#
|
966
|
+
# @return [::Google::Cloud::DataCatalog::V1::Entry]
|
967
|
+
#
|
968
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
969
|
+
def get_entry request, options = nil
|
970
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
971
|
+
|
972
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::GetEntryRequest
|
973
|
+
|
974
|
+
# Converts hash and nil to an options object
|
975
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
976
|
+
|
977
|
+
# Customize the options with defaults
|
978
|
+
call_metadata = @config.rpcs.get_entry.metadata.to_h
|
979
|
+
|
980
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
981
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
982
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
983
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
984
|
+
transports_version_send: [:rest]
|
985
|
+
|
986
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
987
|
+
|
988
|
+
options.apply_defaults timeout: @config.rpcs.get_entry.timeout,
|
989
|
+
metadata: call_metadata,
|
990
|
+
retry_policy: @config.rpcs.get_entry.retry_policy
|
991
|
+
|
992
|
+
options.apply_defaults timeout: @config.timeout,
|
993
|
+
metadata: @config.metadata,
|
994
|
+
retry_policy: @config.retry_policy
|
995
|
+
|
996
|
+
@data_catalog_stub.get_entry request, options do |result, operation|
|
997
|
+
yield result, operation if block_given?
|
998
|
+
return result
|
999
|
+
end
|
1000
|
+
rescue ::Gapic::Rest::Error => e
|
1001
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
##
|
1005
|
+
# Gets an entry by its target resource name.
|
1006
|
+
#
|
1007
|
+
# The resource name comes from the source Google Cloud Platform service.
|
1008
|
+
#
|
1009
|
+
# @overload lookup_entry(request, options = nil)
|
1010
|
+
# Pass arguments to `lookup_entry` via a request object, either of type
|
1011
|
+
# {::Google::Cloud::DataCatalog::V1::LookupEntryRequest} or an equivalent Hash.
|
1012
|
+
#
|
1013
|
+
# @param request [::Google::Cloud::DataCatalog::V1::LookupEntryRequest, ::Hash]
|
1014
|
+
# A request object representing the call parameters. Required. To specify no
|
1015
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1016
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1017
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1018
|
+
#
|
1019
|
+
# @overload lookup_entry(linked_resource: nil, sql_resource: nil, fully_qualified_name: nil)
|
1020
|
+
# Pass arguments to `lookup_entry` via keyword arguments. Note that at
|
1021
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1022
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1023
|
+
#
|
1024
|
+
# @param linked_resource [::String]
|
1025
|
+
# The full name of the Google Cloud Platform resource the Data Catalog
|
1026
|
+
# entry represents. For more information, see [Full Resource Name]
|
1027
|
+
# (https://cloud.google.com/apis/design/resource_names#full_resource_name).
|
1028
|
+
#
|
1029
|
+
# Full names are case-sensitive. For example:
|
1030
|
+
#
|
1031
|
+
# * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
|
1032
|
+
# * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
|
1033
|
+
# @param sql_resource [::String]
|
1034
|
+
# The SQL name of the entry. SQL names are case-sensitive.
|
1035
|
+
#
|
1036
|
+
# Examples:
|
1037
|
+
#
|
1038
|
+
# * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
|
1039
|
+
# * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
|
1040
|
+
# * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
|
1041
|
+
# * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
|
1042
|
+
# * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
|
1043
|
+
#
|
1044
|
+
# Identifiers (`*_ID`) should comply with the
|
1045
|
+
# [Lexical structure in Standard SQL]
|
1046
|
+
# (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
|
1047
|
+
# @param fully_qualified_name [::String]
|
1048
|
+
# Fully qualified name (FQN) of the resource.
|
1049
|
+
#
|
1050
|
+
# FQNs take two forms:
|
1051
|
+
#
|
1052
|
+
# * For non-regionalized resources:
|
1053
|
+
#
|
1054
|
+
# `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
|
1055
|
+
#
|
1056
|
+
# * For regionalized resources:
|
1057
|
+
#
|
1058
|
+
# `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
|
1059
|
+
#
|
1060
|
+
# Example for a DPMS table:
|
1061
|
+
#
|
1062
|
+
# `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
|
1063
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1064
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Entry]
|
1065
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1066
|
+
#
|
1067
|
+
# @return [::Google::Cloud::DataCatalog::V1::Entry]
|
1068
|
+
#
|
1069
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1070
|
+
def lookup_entry request, options = nil
|
1071
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1072
|
+
|
1073
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::LookupEntryRequest
|
1074
|
+
|
1075
|
+
# Converts hash and nil to an options object
|
1076
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1077
|
+
|
1078
|
+
# Customize the options with defaults
|
1079
|
+
call_metadata = @config.rpcs.lookup_entry.metadata.to_h
|
1080
|
+
|
1081
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1082
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1083
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1084
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1085
|
+
transports_version_send: [:rest]
|
1086
|
+
|
1087
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1088
|
+
|
1089
|
+
options.apply_defaults timeout: @config.rpcs.lookup_entry.timeout,
|
1090
|
+
metadata: call_metadata,
|
1091
|
+
retry_policy: @config.rpcs.lookup_entry.retry_policy
|
1092
|
+
|
1093
|
+
options.apply_defaults timeout: @config.timeout,
|
1094
|
+
metadata: @config.metadata,
|
1095
|
+
retry_policy: @config.retry_policy
|
1096
|
+
|
1097
|
+
@data_catalog_stub.lookup_entry request, options do |result, operation|
|
1098
|
+
yield result, operation if block_given?
|
1099
|
+
return result
|
1100
|
+
end
|
1101
|
+
rescue ::Gapic::Rest::Error => e
|
1102
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1103
|
+
end
|
1104
|
+
|
1105
|
+
##
|
1106
|
+
# Lists entries.
|
1107
|
+
#
|
1108
|
+
# Note: Currently, this method can list only custom entries.
|
1109
|
+
# To get a list of both custom and automatically created entries, use
|
1110
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client#search_catalog SearchCatalog}.
|
1111
|
+
#
|
1112
|
+
# @overload list_entries(request, options = nil)
|
1113
|
+
# Pass arguments to `list_entries` via a request object, either of type
|
1114
|
+
# {::Google::Cloud::DataCatalog::V1::ListEntriesRequest} or an equivalent Hash.
|
1115
|
+
#
|
1116
|
+
# @param request [::Google::Cloud::DataCatalog::V1::ListEntriesRequest, ::Hash]
|
1117
|
+
# A request object representing the call parameters. Required. To specify no
|
1118
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1119
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1120
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1121
|
+
#
|
1122
|
+
# @overload list_entries(parent: nil, page_size: nil, page_token: nil, read_mask: nil)
|
1123
|
+
# Pass arguments to `list_entries` via keyword arguments. Note that at
|
1124
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1125
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1126
|
+
#
|
1127
|
+
# @param parent [::String]
|
1128
|
+
# Required. The name of the entry group that contains the entries to list.
|
1129
|
+
#
|
1130
|
+
# Can be provided in URL format.
|
1131
|
+
# @param page_size [::Integer]
|
1132
|
+
# The maximum number of items to return. Default is 10. Maximum limit is
|
1133
|
+
# 1000. Throws an invalid argument if `page_size` is more than 1000.
|
1134
|
+
# @param page_token [::String]
|
1135
|
+
# Pagination token that specifies the next page to return. If empty, the
|
1136
|
+
# first page is returned.
|
1137
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1138
|
+
# The fields to return for each entry. If empty or omitted, all
|
1139
|
+
# fields are returned.
|
1140
|
+
#
|
1141
|
+
# For example, to return a list of entries with only the `name` field,
|
1142
|
+
# set `read_mask` to only one path with the `name` value.
|
1143
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1144
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>]
|
1145
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1146
|
+
#
|
1147
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>]
|
1148
|
+
#
|
1149
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1150
|
+
def list_entries request, options = nil
|
1151
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1152
|
+
|
1153
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ListEntriesRequest
|
1154
|
+
|
1155
|
+
# Converts hash and nil to an options object
|
1156
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1157
|
+
|
1158
|
+
# Customize the options with defaults
|
1159
|
+
call_metadata = @config.rpcs.list_entries.metadata.to_h
|
1160
|
+
|
1161
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1162
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1163
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1164
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1165
|
+
transports_version_send: [:rest]
|
1166
|
+
|
1167
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1168
|
+
|
1169
|
+
options.apply_defaults timeout: @config.rpcs.list_entries.timeout,
|
1170
|
+
metadata: call_metadata,
|
1171
|
+
retry_policy: @config.rpcs.list_entries.retry_policy
|
1172
|
+
|
1173
|
+
options.apply_defaults timeout: @config.timeout,
|
1174
|
+
metadata: @config.metadata,
|
1175
|
+
retry_policy: @config.retry_policy
|
1176
|
+
|
1177
|
+
@data_catalog_stub.list_entries request, options do |result, operation|
|
1178
|
+
result = ::Gapic::Rest::PagedEnumerable.new @data_catalog_stub, :list_entries, "entries", request, result, options
|
1179
|
+
yield result, operation if block_given?
|
1180
|
+
return result
|
1181
|
+
end
|
1182
|
+
rescue ::Gapic::Rest::Error => e
|
1183
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1184
|
+
end
|
1185
|
+
|
1186
|
+
##
|
1187
|
+
# Modifies entry overview, part of the business context of an
|
1188
|
+
# {::Google::Cloud::DataCatalog::V1::Entry Entry}.
|
1189
|
+
#
|
1190
|
+
# To call this method, you must have the `datacatalog.entries.updateOverview`
|
1191
|
+
# IAM permission on the corresponding project.
|
1192
|
+
#
|
1193
|
+
# @overload modify_entry_overview(request, options = nil)
|
1194
|
+
# Pass arguments to `modify_entry_overview` via a request object, either of type
|
1195
|
+
# {::Google::Cloud::DataCatalog::V1::ModifyEntryOverviewRequest} or an equivalent Hash.
|
1196
|
+
#
|
1197
|
+
# @param request [::Google::Cloud::DataCatalog::V1::ModifyEntryOverviewRequest, ::Hash]
|
1198
|
+
# A request object representing the call parameters. Required. To specify no
|
1199
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1200
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1201
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1202
|
+
#
|
1203
|
+
# @overload modify_entry_overview(name: nil, entry_overview: nil)
|
1204
|
+
# Pass arguments to `modify_entry_overview` via keyword arguments. Note that at
|
1205
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1206
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1207
|
+
#
|
1208
|
+
# @param name [::String]
|
1209
|
+
# Required. The full resource name of the entry.
|
1210
|
+
# @param entry_overview [::Google::Cloud::DataCatalog::V1::EntryOverview, ::Hash]
|
1211
|
+
# Required. The new value for the Entry Overview.
|
1212
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1213
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::EntryOverview]
|
1214
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1215
|
+
#
|
1216
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryOverview]
|
1217
|
+
#
|
1218
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1219
|
+
def modify_entry_overview request, options = nil
|
1220
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1221
|
+
|
1222
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ModifyEntryOverviewRequest
|
1223
|
+
|
1224
|
+
# Converts hash and nil to an options object
|
1225
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1226
|
+
|
1227
|
+
# Customize the options with defaults
|
1228
|
+
call_metadata = @config.rpcs.modify_entry_overview.metadata.to_h
|
1229
|
+
|
1230
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1231
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1232
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1233
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1234
|
+
transports_version_send: [:rest]
|
1235
|
+
|
1236
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1237
|
+
|
1238
|
+
options.apply_defaults timeout: @config.rpcs.modify_entry_overview.timeout,
|
1239
|
+
metadata: call_metadata,
|
1240
|
+
retry_policy: @config.rpcs.modify_entry_overview.retry_policy
|
1241
|
+
|
1242
|
+
options.apply_defaults timeout: @config.timeout,
|
1243
|
+
metadata: @config.metadata,
|
1244
|
+
retry_policy: @config.retry_policy
|
1245
|
+
|
1246
|
+
@data_catalog_stub.modify_entry_overview request, options do |result, operation|
|
1247
|
+
yield result, operation if block_given?
|
1248
|
+
return result
|
1249
|
+
end
|
1250
|
+
rescue ::Gapic::Rest::Error => e
|
1251
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1252
|
+
end
|
1253
|
+
|
1254
|
+
##
|
1255
|
+
# Modifies contacts, part of the business context of an
|
1256
|
+
# {::Google::Cloud::DataCatalog::V1::Entry Entry}.
|
1257
|
+
#
|
1258
|
+
# To call this method, you must have the `datacatalog.entries.updateContacts`
|
1259
|
+
# IAM permission on the corresponding project.
|
1260
|
+
#
|
1261
|
+
# @overload modify_entry_contacts(request, options = nil)
|
1262
|
+
# Pass arguments to `modify_entry_contacts` via a request object, either of type
|
1263
|
+
# {::Google::Cloud::DataCatalog::V1::ModifyEntryContactsRequest} or an equivalent Hash.
|
1264
|
+
#
|
1265
|
+
# @param request [::Google::Cloud::DataCatalog::V1::ModifyEntryContactsRequest, ::Hash]
|
1266
|
+
# A request object representing the call parameters. Required. To specify no
|
1267
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1268
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1269
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1270
|
+
#
|
1271
|
+
# @overload modify_entry_contacts(name: nil, contacts: nil)
|
1272
|
+
# Pass arguments to `modify_entry_contacts` via keyword arguments. Note that at
|
1273
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1274
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1275
|
+
#
|
1276
|
+
# @param name [::String]
|
1277
|
+
# Required. The full resource name of the entry.
|
1278
|
+
# @param contacts [::Google::Cloud::DataCatalog::V1::Contacts, ::Hash]
|
1279
|
+
# Required. The new value for the Contacts.
|
1280
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1281
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Contacts]
|
1282
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1283
|
+
#
|
1284
|
+
# @return [::Google::Cloud::DataCatalog::V1::Contacts]
|
1285
|
+
#
|
1286
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1287
|
+
def modify_entry_contacts request, options = nil
|
1288
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1289
|
+
|
1290
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ModifyEntryContactsRequest
|
1291
|
+
|
1292
|
+
# Converts hash and nil to an options object
|
1293
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1294
|
+
|
1295
|
+
# Customize the options with defaults
|
1296
|
+
call_metadata = @config.rpcs.modify_entry_contacts.metadata.to_h
|
1297
|
+
|
1298
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1299
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1300
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1301
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1302
|
+
transports_version_send: [:rest]
|
1303
|
+
|
1304
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1305
|
+
|
1306
|
+
options.apply_defaults timeout: @config.rpcs.modify_entry_contacts.timeout,
|
1307
|
+
metadata: call_metadata,
|
1308
|
+
retry_policy: @config.rpcs.modify_entry_contacts.retry_policy
|
1309
|
+
|
1310
|
+
options.apply_defaults timeout: @config.timeout,
|
1311
|
+
metadata: @config.metadata,
|
1312
|
+
retry_policy: @config.retry_policy
|
1313
|
+
|
1314
|
+
@data_catalog_stub.modify_entry_contacts request, options do |result, operation|
|
1315
|
+
yield result, operation if block_given?
|
1316
|
+
return result
|
1317
|
+
end
|
1318
|
+
rescue ::Gapic::Rest::Error => e
|
1319
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1320
|
+
end
|
1321
|
+
|
1322
|
+
##
|
1323
|
+
# Creates a tag template.
|
1324
|
+
#
|
1325
|
+
# You must enable the Data Catalog API in the project identified by the
|
1326
|
+
# `parent` parameter.
|
1327
|
+
# For more information, see [Data Catalog resource project]
|
1328
|
+
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1329
|
+
#
|
1330
|
+
# @overload create_tag_template(request, options = nil)
|
1331
|
+
# Pass arguments to `create_tag_template` via a request object, either of type
|
1332
|
+
# {::Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest} or an equivalent Hash.
|
1333
|
+
#
|
1334
|
+
# @param request [::Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest, ::Hash]
|
1335
|
+
# A request object representing the call parameters. Required. To specify no
|
1336
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1337
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1338
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1339
|
+
#
|
1340
|
+
# @overload create_tag_template(parent: nil, tag_template_id: nil, tag_template: nil)
|
1341
|
+
# Pass arguments to `create_tag_template` via keyword arguments. Note that at
|
1342
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1343
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1344
|
+
#
|
1345
|
+
# @param parent [::String]
|
1346
|
+
# Required. The name of the project and the template location
|
1347
|
+
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
1348
|
+
# @param tag_template_id [::String]
|
1349
|
+
# Required. The ID of the tag template to create.
|
1350
|
+
#
|
1351
|
+
# The ID must contain only lowercase letters (a-z), numbers (0-9),
|
1352
|
+
# or underscores (_), and must start with a letter or underscore.
|
1353
|
+
# The maximum size is 64 bytes when encoded in UTF-8.
|
1354
|
+
# @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
|
1355
|
+
# Required. The tag template to create.
|
1356
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1357
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
1358
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1359
|
+
#
|
1360
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
1361
|
+
#
|
1362
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1363
|
+
def create_tag_template request, options = nil
|
1364
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1365
|
+
|
1366
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest
|
1367
|
+
|
1368
|
+
# Converts hash and nil to an options object
|
1369
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1370
|
+
|
1371
|
+
# Customize the options with defaults
|
1372
|
+
call_metadata = @config.rpcs.create_tag_template.metadata.to_h
|
1373
|
+
|
1374
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1375
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1376
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1377
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1378
|
+
transports_version_send: [:rest]
|
1379
|
+
|
1380
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1381
|
+
|
1382
|
+
options.apply_defaults timeout: @config.rpcs.create_tag_template.timeout,
|
1383
|
+
metadata: call_metadata,
|
1384
|
+
retry_policy: @config.rpcs.create_tag_template.retry_policy
|
1385
|
+
|
1386
|
+
options.apply_defaults timeout: @config.timeout,
|
1387
|
+
metadata: @config.metadata,
|
1388
|
+
retry_policy: @config.retry_policy
|
1389
|
+
|
1390
|
+
@data_catalog_stub.create_tag_template request, options do |result, operation|
|
1391
|
+
yield result, operation if block_given?
|
1392
|
+
return result
|
1393
|
+
end
|
1394
|
+
rescue ::Gapic::Rest::Error => e
|
1395
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1396
|
+
end
|
1397
|
+
|
1398
|
+
##
|
1399
|
+
# Gets a tag template.
|
1400
|
+
#
|
1401
|
+
# @overload get_tag_template(request, options = nil)
|
1402
|
+
# Pass arguments to `get_tag_template` via a request object, either of type
|
1403
|
+
# {::Google::Cloud::DataCatalog::V1::GetTagTemplateRequest} or an equivalent Hash.
|
1404
|
+
#
|
1405
|
+
# @param request [::Google::Cloud::DataCatalog::V1::GetTagTemplateRequest, ::Hash]
|
1406
|
+
# A request object representing the call parameters. Required. To specify no
|
1407
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1408
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1409
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1410
|
+
#
|
1411
|
+
# @overload get_tag_template(name: nil)
|
1412
|
+
# Pass arguments to `get_tag_template` via keyword arguments. Note that at
|
1413
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1414
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1415
|
+
#
|
1416
|
+
# @param name [::String]
|
1417
|
+
# Required. The name of the tag template to get.
|
1418
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1419
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
1420
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1421
|
+
#
|
1422
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
1423
|
+
#
|
1424
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1425
|
+
def get_tag_template request, options = nil
|
1426
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1427
|
+
|
1428
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::GetTagTemplateRequest
|
1429
|
+
|
1430
|
+
# Converts hash and nil to an options object
|
1431
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1432
|
+
|
1433
|
+
# Customize the options with defaults
|
1434
|
+
call_metadata = @config.rpcs.get_tag_template.metadata.to_h
|
1435
|
+
|
1436
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1437
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1438
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1439
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1440
|
+
transports_version_send: [:rest]
|
1441
|
+
|
1442
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1443
|
+
|
1444
|
+
options.apply_defaults timeout: @config.rpcs.get_tag_template.timeout,
|
1445
|
+
metadata: call_metadata,
|
1446
|
+
retry_policy: @config.rpcs.get_tag_template.retry_policy
|
1447
|
+
|
1448
|
+
options.apply_defaults timeout: @config.timeout,
|
1449
|
+
metadata: @config.metadata,
|
1450
|
+
retry_policy: @config.retry_policy
|
1451
|
+
|
1452
|
+
@data_catalog_stub.get_tag_template request, options do |result, operation|
|
1453
|
+
yield result, operation if block_given?
|
1454
|
+
return result
|
1455
|
+
end
|
1456
|
+
rescue ::Gapic::Rest::Error => e
|
1457
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1458
|
+
end
|
1459
|
+
|
1460
|
+
##
|
1461
|
+
# Updates a tag template.
|
1462
|
+
#
|
1463
|
+
# You can't update template fields with this method. These fields are
|
1464
|
+
# separate resources with their own create, update, and delete methods.
|
1465
|
+
#
|
1466
|
+
# You must enable the Data Catalog API in the project identified by
|
1467
|
+
# the `tag_template.name` parameter. For more information, see [Data Catalog
|
1468
|
+
# resource
|
1469
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1470
|
+
#
|
1471
|
+
# @overload update_tag_template(request, options = nil)
|
1472
|
+
# Pass arguments to `update_tag_template` via a request object, either of type
|
1473
|
+
# {::Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest} or an equivalent Hash.
|
1474
|
+
#
|
1475
|
+
# @param request [::Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest, ::Hash]
|
1476
|
+
# A request object representing the call parameters. Required. To specify no
|
1477
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1478
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1479
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1480
|
+
#
|
1481
|
+
# @overload update_tag_template(tag_template: nil, update_mask: nil)
|
1482
|
+
# Pass arguments to `update_tag_template` via keyword arguments. Note that at
|
1483
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1484
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1485
|
+
#
|
1486
|
+
# @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
|
1487
|
+
# Required. The template to update. The `name` field must be set.
|
1488
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1489
|
+
# Names of fields whose values to overwrite on a tag template. Currently,
|
1490
|
+
# only `display_name` and `is_publicly_readable` can be overwritten.
|
1491
|
+
#
|
1492
|
+
# If this parameter is absent or empty, all modifiable fields
|
1493
|
+
# are overwritten. If such fields are non-required and omitted in the
|
1494
|
+
# request body, their values are emptied.
|
1495
|
+
#
|
1496
|
+
# Note: Updating the `is_publicly_readable` field may require up to 12
|
1497
|
+
# hours to take effect in search results.
|
1498
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1499
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
1500
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1501
|
+
#
|
1502
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
1503
|
+
#
|
1504
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1505
|
+
def update_tag_template request, options = nil
|
1506
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1507
|
+
|
1508
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest
|
1509
|
+
|
1510
|
+
# Converts hash and nil to an options object
|
1511
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1512
|
+
|
1513
|
+
# Customize the options with defaults
|
1514
|
+
call_metadata = @config.rpcs.update_tag_template.metadata.to_h
|
1515
|
+
|
1516
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1517
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1518
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1519
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1520
|
+
transports_version_send: [:rest]
|
1521
|
+
|
1522
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1523
|
+
|
1524
|
+
options.apply_defaults timeout: @config.rpcs.update_tag_template.timeout,
|
1525
|
+
metadata: call_metadata,
|
1526
|
+
retry_policy: @config.rpcs.update_tag_template.retry_policy
|
1527
|
+
|
1528
|
+
options.apply_defaults timeout: @config.timeout,
|
1529
|
+
metadata: @config.metadata,
|
1530
|
+
retry_policy: @config.retry_policy
|
1531
|
+
|
1532
|
+
@data_catalog_stub.update_tag_template request, options do |result, operation|
|
1533
|
+
yield result, operation if block_given?
|
1534
|
+
return result
|
1535
|
+
end
|
1536
|
+
rescue ::Gapic::Rest::Error => e
|
1537
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1538
|
+
end
|
1539
|
+
|
1540
|
+
##
|
1541
|
+
# Deletes a tag template and all tags that use it.
|
1542
|
+
#
|
1543
|
+
# You must enable the Data Catalog API in the project identified by
|
1544
|
+
# the `name` parameter. For more information, see [Data Catalog resource
|
1545
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1546
|
+
#
|
1547
|
+
# @overload delete_tag_template(request, options = nil)
|
1548
|
+
# Pass arguments to `delete_tag_template` via a request object, either of type
|
1549
|
+
# {::Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest} or an equivalent Hash.
|
1550
|
+
#
|
1551
|
+
# @param request [::Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest, ::Hash]
|
1552
|
+
# A request object representing the call parameters. Required. To specify no
|
1553
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1554
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1555
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1556
|
+
#
|
1557
|
+
# @overload delete_tag_template(name: nil, force: nil)
|
1558
|
+
# Pass arguments to `delete_tag_template` via keyword arguments. Note that at
|
1559
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1560
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1561
|
+
#
|
1562
|
+
# @param name [::String]
|
1563
|
+
# Required. The name of the tag template to delete.
|
1564
|
+
# @param force [::Boolean]
|
1565
|
+
# Required. If true, deletes all tags that use this template.
|
1566
|
+
#
|
1567
|
+
# Currently, `true` is the only supported value.
|
1568
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1569
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
1570
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1571
|
+
#
|
1572
|
+
# @return [::Google::Protobuf::Empty]
|
1573
|
+
#
|
1574
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1575
|
+
def delete_tag_template request, options = nil
|
1576
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1577
|
+
|
1578
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest
|
1579
|
+
|
1580
|
+
# Converts hash and nil to an options object
|
1581
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1582
|
+
|
1583
|
+
# Customize the options with defaults
|
1584
|
+
call_metadata = @config.rpcs.delete_tag_template.metadata.to_h
|
1585
|
+
|
1586
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1587
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1588
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1589
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1590
|
+
transports_version_send: [:rest]
|
1591
|
+
|
1592
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1593
|
+
|
1594
|
+
options.apply_defaults timeout: @config.rpcs.delete_tag_template.timeout,
|
1595
|
+
metadata: call_metadata,
|
1596
|
+
retry_policy: @config.rpcs.delete_tag_template.retry_policy
|
1597
|
+
|
1598
|
+
options.apply_defaults timeout: @config.timeout,
|
1599
|
+
metadata: @config.metadata,
|
1600
|
+
retry_policy: @config.retry_policy
|
1601
|
+
|
1602
|
+
@data_catalog_stub.delete_tag_template request, options do |result, operation|
|
1603
|
+
yield result, operation if block_given?
|
1604
|
+
return result
|
1605
|
+
end
|
1606
|
+
rescue ::Gapic::Rest::Error => e
|
1607
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
##
|
1611
|
+
# Creates a field in a tag template.
|
1612
|
+
#
|
1613
|
+
# You must enable the Data Catalog API in the project identified by
|
1614
|
+
# the `parent` parameter. For more information, see [Data Catalog resource
|
1615
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1616
|
+
#
|
1617
|
+
# @overload create_tag_template_field(request, options = nil)
|
1618
|
+
# Pass arguments to `create_tag_template_field` via a request object, either of type
|
1619
|
+
# {::Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest} or an equivalent Hash.
|
1620
|
+
#
|
1621
|
+
# @param request [::Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest, ::Hash]
|
1622
|
+
# A request object representing the call parameters. Required. To specify no
|
1623
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1624
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1625
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1626
|
+
#
|
1627
|
+
# @overload create_tag_template_field(parent: nil, tag_template_field_id: nil, tag_template_field: nil)
|
1628
|
+
# Pass arguments to `create_tag_template_field` via keyword arguments. Note that at
|
1629
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1630
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1631
|
+
#
|
1632
|
+
# @param parent [::String]
|
1633
|
+
# Required. The name of the project and the template location
|
1634
|
+
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
1635
|
+
# @param tag_template_field_id [::String]
|
1636
|
+
# Required. The ID of the tag template field to create.
|
1637
|
+
#
|
1638
|
+
# Note: Adding a required field to an existing template is *not* allowed.
|
1639
|
+
#
|
1640
|
+
# Field IDs can contain letters (both uppercase and lowercase), numbers
|
1641
|
+
# (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
|
1642
|
+
# character long and at most 128 characters long. Field IDs must also be
|
1643
|
+
# unique within their template.
|
1644
|
+
# @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
|
1645
|
+
# Required. The tag template field to create.
|
1646
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1647
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1648
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1649
|
+
#
|
1650
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1651
|
+
#
|
1652
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1653
|
+
def create_tag_template_field request, options = nil
|
1654
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1655
|
+
|
1656
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest
|
1657
|
+
|
1658
|
+
# Converts hash and nil to an options object
|
1659
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1660
|
+
|
1661
|
+
# Customize the options with defaults
|
1662
|
+
call_metadata = @config.rpcs.create_tag_template_field.metadata.to_h
|
1663
|
+
|
1664
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1665
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1666
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1667
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1668
|
+
transports_version_send: [:rest]
|
1669
|
+
|
1670
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1671
|
+
|
1672
|
+
options.apply_defaults timeout: @config.rpcs.create_tag_template_field.timeout,
|
1673
|
+
metadata: call_metadata,
|
1674
|
+
retry_policy: @config.rpcs.create_tag_template_field.retry_policy
|
1675
|
+
|
1676
|
+
options.apply_defaults timeout: @config.timeout,
|
1677
|
+
metadata: @config.metadata,
|
1678
|
+
retry_policy: @config.retry_policy
|
1679
|
+
|
1680
|
+
@data_catalog_stub.create_tag_template_field request, options do |result, operation|
|
1681
|
+
yield result, operation if block_given?
|
1682
|
+
return result
|
1683
|
+
end
|
1684
|
+
rescue ::Gapic::Rest::Error => e
|
1685
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1686
|
+
end
|
1687
|
+
|
1688
|
+
##
|
1689
|
+
# Updates a field in a tag template.
|
1690
|
+
#
|
1691
|
+
# You can't update the field type with this method.
|
1692
|
+
#
|
1693
|
+
# You must enable the Data Catalog API in the project
|
1694
|
+
# identified by the `name` parameter. For more information, see [Data Catalog
|
1695
|
+
# resource
|
1696
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1697
|
+
#
|
1698
|
+
# @overload update_tag_template_field(request, options = nil)
|
1699
|
+
# Pass arguments to `update_tag_template_field` via a request object, either of type
|
1700
|
+
# {::Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest} or an equivalent Hash.
|
1701
|
+
#
|
1702
|
+
# @param request [::Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest, ::Hash]
|
1703
|
+
# A request object representing the call parameters. Required. To specify no
|
1704
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1705
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1706
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1707
|
+
#
|
1708
|
+
# @overload update_tag_template_field(name: nil, tag_template_field: nil, update_mask: nil)
|
1709
|
+
# Pass arguments to `update_tag_template_field` via keyword arguments. Note that at
|
1710
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1711
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1712
|
+
#
|
1713
|
+
# @param name [::String]
|
1714
|
+
# Required. The name of the tag template field.
|
1715
|
+
# @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
|
1716
|
+
# Required. The template to update.
|
1717
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1718
|
+
# Optional. Names of fields whose values to overwrite on an individual field of a tag
|
1719
|
+
# template. The following fields are modifiable:
|
1720
|
+
#
|
1721
|
+
# * `display_name`
|
1722
|
+
# * `type.enum_type`
|
1723
|
+
# * `is_required`
|
1724
|
+
#
|
1725
|
+
# If this parameter is absent or empty, all modifiable fields
|
1726
|
+
# are overwritten. If such fields are non-required and omitted in the request
|
1727
|
+
# body, their values are emptied with one exception: when updating an enum
|
1728
|
+
# type, the provided values are merged with the existing values. Therefore,
|
1729
|
+
# enum values can only be added, existing enum values cannot be deleted or
|
1730
|
+
# renamed.
|
1731
|
+
#
|
1732
|
+
# Additionally, updating a template field from optional to required is
|
1733
|
+
# *not* allowed.
|
1734
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1735
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1736
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1737
|
+
#
|
1738
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1739
|
+
#
|
1740
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1741
|
+
def update_tag_template_field request, options = nil
|
1742
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1743
|
+
|
1744
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest
|
1745
|
+
|
1746
|
+
# Converts hash and nil to an options object
|
1747
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1748
|
+
|
1749
|
+
# Customize the options with defaults
|
1750
|
+
call_metadata = @config.rpcs.update_tag_template_field.metadata.to_h
|
1751
|
+
|
1752
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1753
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1754
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1755
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1756
|
+
transports_version_send: [:rest]
|
1757
|
+
|
1758
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1759
|
+
|
1760
|
+
options.apply_defaults timeout: @config.rpcs.update_tag_template_field.timeout,
|
1761
|
+
metadata: call_metadata,
|
1762
|
+
retry_policy: @config.rpcs.update_tag_template_field.retry_policy
|
1763
|
+
|
1764
|
+
options.apply_defaults timeout: @config.timeout,
|
1765
|
+
metadata: @config.metadata,
|
1766
|
+
retry_policy: @config.retry_policy
|
1767
|
+
|
1768
|
+
@data_catalog_stub.update_tag_template_field request, options do |result, operation|
|
1769
|
+
yield result, operation if block_given?
|
1770
|
+
return result
|
1771
|
+
end
|
1772
|
+
rescue ::Gapic::Rest::Error => e
|
1773
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1774
|
+
end
|
1775
|
+
|
1776
|
+
##
|
1777
|
+
# Renames a field in a tag template.
|
1778
|
+
#
|
1779
|
+
# You must enable the Data Catalog API in the project identified by the
|
1780
|
+
# `name` parameter. For more information, see [Data Catalog resource project]
|
1781
|
+
# (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1782
|
+
#
|
1783
|
+
# @overload rename_tag_template_field(request, options = nil)
|
1784
|
+
# Pass arguments to `rename_tag_template_field` via a request object, either of type
|
1785
|
+
# {::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest} or an equivalent Hash.
|
1786
|
+
#
|
1787
|
+
# @param request [::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest, ::Hash]
|
1788
|
+
# A request object representing the call parameters. Required. To specify no
|
1789
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1790
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1791
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1792
|
+
#
|
1793
|
+
# @overload rename_tag_template_field(name: nil, new_tag_template_field_id: nil)
|
1794
|
+
# Pass arguments to `rename_tag_template_field` via keyword arguments. Note that at
|
1795
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1796
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1797
|
+
#
|
1798
|
+
# @param name [::String]
|
1799
|
+
# Required. The name of the tag template field.
|
1800
|
+
# @param new_tag_template_field_id [::String]
|
1801
|
+
# Required. The new ID of this tag template field. For example, `my_new_field`.
|
1802
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1803
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1804
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1805
|
+
#
|
1806
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1807
|
+
#
|
1808
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1809
|
+
def rename_tag_template_field request, options = nil
|
1810
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1811
|
+
|
1812
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest
|
1813
|
+
|
1814
|
+
# Converts hash and nil to an options object
|
1815
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1816
|
+
|
1817
|
+
# Customize the options with defaults
|
1818
|
+
call_metadata = @config.rpcs.rename_tag_template_field.metadata.to_h
|
1819
|
+
|
1820
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1821
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1822
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1823
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1824
|
+
transports_version_send: [:rest]
|
1825
|
+
|
1826
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1827
|
+
|
1828
|
+
options.apply_defaults timeout: @config.rpcs.rename_tag_template_field.timeout,
|
1829
|
+
metadata: call_metadata,
|
1830
|
+
retry_policy: @config.rpcs.rename_tag_template_field.retry_policy
|
1831
|
+
|
1832
|
+
options.apply_defaults timeout: @config.timeout,
|
1833
|
+
metadata: @config.metadata,
|
1834
|
+
retry_policy: @config.retry_policy
|
1835
|
+
|
1836
|
+
@data_catalog_stub.rename_tag_template_field request, options do |result, operation|
|
1837
|
+
yield result, operation if block_given?
|
1838
|
+
return result
|
1839
|
+
end
|
1840
|
+
rescue ::Gapic::Rest::Error => e
|
1841
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1842
|
+
end
|
1843
|
+
|
1844
|
+
##
|
1845
|
+
# Renames an enum value in a tag template.
|
1846
|
+
#
|
1847
|
+
# Within a single enum field, enum values must be unique.
|
1848
|
+
#
|
1849
|
+
# @overload rename_tag_template_field_enum_value(request, options = nil)
|
1850
|
+
# Pass arguments to `rename_tag_template_field_enum_value` via a request object, either of type
|
1851
|
+
# {::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest} or an equivalent Hash.
|
1852
|
+
#
|
1853
|
+
# @param request [::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest, ::Hash]
|
1854
|
+
# A request object representing the call parameters. Required. To specify no
|
1855
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1856
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1857
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1858
|
+
#
|
1859
|
+
# @overload rename_tag_template_field_enum_value(name: nil, new_enum_value_display_name: nil)
|
1860
|
+
# Pass arguments to `rename_tag_template_field_enum_value` via keyword arguments. Note that at
|
1861
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1862
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1863
|
+
#
|
1864
|
+
# @param name [::String]
|
1865
|
+
# Required. The name of the enum field value.
|
1866
|
+
# @param new_enum_value_display_name [::String]
|
1867
|
+
# Required. The new display name of the enum value. For example, `my_new_enum_value`.
|
1868
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1869
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1870
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1871
|
+
#
|
1872
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
1873
|
+
#
|
1874
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1875
|
+
def rename_tag_template_field_enum_value request, options = nil
|
1876
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1877
|
+
|
1878
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest
|
1879
|
+
|
1880
|
+
# Converts hash and nil to an options object
|
1881
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1882
|
+
|
1883
|
+
# Customize the options with defaults
|
1884
|
+
call_metadata = @config.rpcs.rename_tag_template_field_enum_value.metadata.to_h
|
1885
|
+
|
1886
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1887
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1888
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1889
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1890
|
+
transports_version_send: [:rest]
|
1891
|
+
|
1892
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1893
|
+
|
1894
|
+
options.apply_defaults timeout: @config.rpcs.rename_tag_template_field_enum_value.timeout,
|
1895
|
+
metadata: call_metadata,
|
1896
|
+
retry_policy: @config.rpcs.rename_tag_template_field_enum_value.retry_policy
|
1897
|
+
|
1898
|
+
options.apply_defaults timeout: @config.timeout,
|
1899
|
+
metadata: @config.metadata,
|
1900
|
+
retry_policy: @config.retry_policy
|
1901
|
+
|
1902
|
+
@data_catalog_stub.rename_tag_template_field_enum_value request, options do |result, operation|
|
1903
|
+
yield result, operation if block_given?
|
1904
|
+
return result
|
1905
|
+
end
|
1906
|
+
rescue ::Gapic::Rest::Error => e
|
1907
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1908
|
+
end
|
1909
|
+
|
1910
|
+
##
|
1911
|
+
# Deletes a field in a tag template and all uses of this field from the tags
|
1912
|
+
# based on this template.
|
1913
|
+
#
|
1914
|
+
# You must enable the Data Catalog API in the project identified by
|
1915
|
+
# the `name` parameter. For more information, see [Data Catalog resource
|
1916
|
+
# project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
|
1917
|
+
#
|
1918
|
+
# @overload delete_tag_template_field(request, options = nil)
|
1919
|
+
# Pass arguments to `delete_tag_template_field` via a request object, either of type
|
1920
|
+
# {::Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest} or an equivalent Hash.
|
1921
|
+
#
|
1922
|
+
# @param request [::Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest, ::Hash]
|
1923
|
+
# A request object representing the call parameters. Required. To specify no
|
1924
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1925
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1926
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1927
|
+
#
|
1928
|
+
# @overload delete_tag_template_field(name: nil, force: nil)
|
1929
|
+
# Pass arguments to `delete_tag_template_field` via keyword arguments. Note that at
|
1930
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1931
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1932
|
+
#
|
1933
|
+
# @param name [::String]
|
1934
|
+
# Required. The name of the tag template field to delete.
|
1935
|
+
# @param force [::Boolean]
|
1936
|
+
# Required. If true, deletes this field from any tags that use it.
|
1937
|
+
#
|
1938
|
+
# Currently, `true` is the only supported value.
|
1939
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1940
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
1941
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1942
|
+
#
|
1943
|
+
# @return [::Google::Protobuf::Empty]
|
1944
|
+
#
|
1945
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1946
|
+
def delete_tag_template_field request, options = nil
|
1947
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1948
|
+
|
1949
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest
|
1950
|
+
|
1951
|
+
# Converts hash and nil to an options object
|
1952
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1953
|
+
|
1954
|
+
# Customize the options with defaults
|
1955
|
+
call_metadata = @config.rpcs.delete_tag_template_field.metadata.to_h
|
1956
|
+
|
1957
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1958
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1959
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1960
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
1961
|
+
transports_version_send: [:rest]
|
1962
|
+
|
1963
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1964
|
+
|
1965
|
+
options.apply_defaults timeout: @config.rpcs.delete_tag_template_field.timeout,
|
1966
|
+
metadata: call_metadata,
|
1967
|
+
retry_policy: @config.rpcs.delete_tag_template_field.retry_policy
|
1968
|
+
|
1969
|
+
options.apply_defaults timeout: @config.timeout,
|
1970
|
+
metadata: @config.metadata,
|
1971
|
+
retry_policy: @config.retry_policy
|
1972
|
+
|
1973
|
+
@data_catalog_stub.delete_tag_template_field request, options do |result, operation|
|
1974
|
+
yield result, operation if block_given?
|
1975
|
+
return result
|
1976
|
+
end
|
1977
|
+
rescue ::Gapic::Rest::Error => e
|
1978
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1979
|
+
end
|
1980
|
+
|
1981
|
+
##
|
1982
|
+
# Creates a tag and assigns it to:
|
1983
|
+
#
|
1984
|
+
# * An {::Google::Cloud::DataCatalog::V1::Entry Entry} if the method name is
|
1985
|
+
# `projects.locations.entryGroups.entries.tags.create`.
|
1986
|
+
# * Or {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}if the method
|
1987
|
+
# name is `projects.locations.entryGroups.tags.create`.
|
1988
|
+
#
|
1989
|
+
# Note: The project identified by the `parent` parameter for the [tag]
|
1990
|
+
# (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
|
1991
|
+
# and the [tag template]
|
1992
|
+
# (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
|
1993
|
+
# used to create the tag must be in the same organization.
|
1994
|
+
#
|
1995
|
+
# @overload create_tag(request, options = nil)
|
1996
|
+
# Pass arguments to `create_tag` via a request object, either of type
|
1997
|
+
# {::Google::Cloud::DataCatalog::V1::CreateTagRequest} or an equivalent Hash.
|
1998
|
+
#
|
1999
|
+
# @param request [::Google::Cloud::DataCatalog::V1::CreateTagRequest, ::Hash]
|
2000
|
+
# A request object representing the call parameters. Required. To specify no
|
2001
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2002
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2003
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2004
|
+
#
|
2005
|
+
# @overload create_tag(parent: nil, tag: nil)
|
2006
|
+
# Pass arguments to `create_tag` via keyword arguments. Note that at
|
2007
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2008
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2009
|
+
#
|
2010
|
+
# @param parent [::String]
|
2011
|
+
# Required. The name of the resource to attach this tag to.
|
2012
|
+
#
|
2013
|
+
# Tags can be attached to entries or entry groups. An entry can have up to
|
2014
|
+
# 1000 attached tags.
|
2015
|
+
#
|
2016
|
+
# Note: The tag and its child resources might not be stored in
|
2017
|
+
# the location specified in its name.
|
2018
|
+
# @param tag [::Google::Cloud::DataCatalog::V1::Tag, ::Hash]
|
2019
|
+
# Required. The tag to create.
|
2020
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2021
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Tag]
|
2022
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2023
|
+
#
|
2024
|
+
# @return [::Google::Cloud::DataCatalog::V1::Tag]
|
2025
|
+
#
|
2026
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2027
|
+
def create_tag request, options = nil
|
2028
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2029
|
+
|
2030
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateTagRequest
|
2031
|
+
|
2032
|
+
# Converts hash and nil to an options object
|
2033
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2034
|
+
|
2035
|
+
# Customize the options with defaults
|
2036
|
+
call_metadata = @config.rpcs.create_tag.metadata.to_h
|
2037
|
+
|
2038
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2039
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2040
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2041
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2042
|
+
transports_version_send: [:rest]
|
2043
|
+
|
2044
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2045
|
+
|
2046
|
+
options.apply_defaults timeout: @config.rpcs.create_tag.timeout,
|
2047
|
+
metadata: call_metadata,
|
2048
|
+
retry_policy: @config.rpcs.create_tag.retry_policy
|
2049
|
+
|
2050
|
+
options.apply_defaults timeout: @config.timeout,
|
2051
|
+
metadata: @config.metadata,
|
2052
|
+
retry_policy: @config.retry_policy
|
2053
|
+
|
2054
|
+
@data_catalog_stub.create_tag request, options do |result, operation|
|
2055
|
+
yield result, operation if block_given?
|
2056
|
+
return result
|
2057
|
+
end
|
2058
|
+
rescue ::Gapic::Rest::Error => e
|
2059
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2060
|
+
end
|
2061
|
+
|
2062
|
+
##
|
2063
|
+
# Updates an existing tag.
|
2064
|
+
#
|
2065
|
+
# @overload update_tag(request, options = nil)
|
2066
|
+
# Pass arguments to `update_tag` via a request object, either of type
|
2067
|
+
# {::Google::Cloud::DataCatalog::V1::UpdateTagRequest} or an equivalent Hash.
|
2068
|
+
#
|
2069
|
+
# @param request [::Google::Cloud::DataCatalog::V1::UpdateTagRequest, ::Hash]
|
2070
|
+
# A request object representing the call parameters. Required. To specify no
|
2071
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2072
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2073
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2074
|
+
#
|
2075
|
+
# @overload update_tag(tag: nil, update_mask: nil)
|
2076
|
+
# Pass arguments to `update_tag` via keyword arguments. Note that at
|
2077
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2078
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2079
|
+
#
|
2080
|
+
# @param tag [::Google::Cloud::DataCatalog::V1::Tag, ::Hash]
|
2081
|
+
# Required. The updated tag. The "name" field must be set.
|
2082
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2083
|
+
# Names of fields whose values to overwrite on a tag. Currently, a tag has
|
2084
|
+
# the only modifiable field with the name `fields`.
|
2085
|
+
#
|
2086
|
+
# In general, if this parameter is absent or empty, all modifiable fields
|
2087
|
+
# are overwritten. If such fields are non-required and omitted in the
|
2088
|
+
# request body, their values are emptied.
|
2089
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2090
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::Tag]
|
2091
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2092
|
+
#
|
2093
|
+
# @return [::Google::Cloud::DataCatalog::V1::Tag]
|
2094
|
+
#
|
2095
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2096
|
+
def update_tag request, options = nil
|
2097
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2098
|
+
|
2099
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateTagRequest
|
2100
|
+
|
2101
|
+
# Converts hash and nil to an options object
|
2102
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2103
|
+
|
2104
|
+
# Customize the options with defaults
|
2105
|
+
call_metadata = @config.rpcs.update_tag.metadata.to_h
|
2106
|
+
|
2107
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2108
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2109
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2110
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2111
|
+
transports_version_send: [:rest]
|
2112
|
+
|
2113
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2114
|
+
|
2115
|
+
options.apply_defaults timeout: @config.rpcs.update_tag.timeout,
|
2116
|
+
metadata: call_metadata,
|
2117
|
+
retry_policy: @config.rpcs.update_tag.retry_policy
|
2118
|
+
|
2119
|
+
options.apply_defaults timeout: @config.timeout,
|
2120
|
+
metadata: @config.metadata,
|
2121
|
+
retry_policy: @config.retry_policy
|
2122
|
+
|
2123
|
+
@data_catalog_stub.update_tag request, options do |result, operation|
|
2124
|
+
yield result, operation if block_given?
|
2125
|
+
return result
|
2126
|
+
end
|
2127
|
+
rescue ::Gapic::Rest::Error => e
|
2128
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2129
|
+
end
|
2130
|
+
|
2131
|
+
##
|
2132
|
+
# Deletes a tag.
|
2133
|
+
#
|
2134
|
+
# @overload delete_tag(request, options = nil)
|
2135
|
+
# Pass arguments to `delete_tag` via a request object, either of type
|
2136
|
+
# {::Google::Cloud::DataCatalog::V1::DeleteTagRequest} or an equivalent Hash.
|
2137
|
+
#
|
2138
|
+
# @param request [::Google::Cloud::DataCatalog::V1::DeleteTagRequest, ::Hash]
|
2139
|
+
# A request object representing the call parameters. Required. To specify no
|
2140
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2141
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2142
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2143
|
+
#
|
2144
|
+
# @overload delete_tag(name: nil)
|
2145
|
+
# Pass arguments to `delete_tag` via keyword arguments. Note that at
|
2146
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2147
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2148
|
+
#
|
2149
|
+
# @param name [::String]
|
2150
|
+
# Required. The name of the tag to delete.
|
2151
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2152
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
2153
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2154
|
+
#
|
2155
|
+
# @return [::Google::Protobuf::Empty]
|
2156
|
+
#
|
2157
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2158
|
+
def delete_tag request, options = nil
|
2159
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2160
|
+
|
2161
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteTagRequest
|
2162
|
+
|
2163
|
+
# Converts hash and nil to an options object
|
2164
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2165
|
+
|
2166
|
+
# Customize the options with defaults
|
2167
|
+
call_metadata = @config.rpcs.delete_tag.metadata.to_h
|
2168
|
+
|
2169
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2170
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2171
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2172
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2173
|
+
transports_version_send: [:rest]
|
2174
|
+
|
2175
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2176
|
+
|
2177
|
+
options.apply_defaults timeout: @config.rpcs.delete_tag.timeout,
|
2178
|
+
metadata: call_metadata,
|
2179
|
+
retry_policy: @config.rpcs.delete_tag.retry_policy
|
2180
|
+
|
2181
|
+
options.apply_defaults timeout: @config.timeout,
|
2182
|
+
metadata: @config.metadata,
|
2183
|
+
retry_policy: @config.retry_policy
|
2184
|
+
|
2185
|
+
@data_catalog_stub.delete_tag request, options do |result, operation|
|
2186
|
+
yield result, operation if block_given?
|
2187
|
+
return result
|
2188
|
+
end
|
2189
|
+
rescue ::Gapic::Rest::Error => e
|
2190
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2191
|
+
end
|
2192
|
+
|
2193
|
+
##
|
2194
|
+
# Lists tags assigned to an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
|
2195
|
+
# The {::Google::Cloud::DataCatalog::V1::Tag#column columns} in the response are
|
2196
|
+
# lowercased.
|
2197
|
+
#
|
2198
|
+
# @overload list_tags(request, options = nil)
|
2199
|
+
# Pass arguments to `list_tags` via a request object, either of type
|
2200
|
+
# {::Google::Cloud::DataCatalog::V1::ListTagsRequest} or an equivalent Hash.
|
2201
|
+
#
|
2202
|
+
# @param request [::Google::Cloud::DataCatalog::V1::ListTagsRequest, ::Hash]
|
2203
|
+
# A request object representing the call parameters. Required. To specify no
|
2204
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2205
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2206
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2207
|
+
#
|
2208
|
+
# @overload list_tags(parent: nil, page_size: nil, page_token: nil)
|
2209
|
+
# Pass arguments to `list_tags` via keyword arguments. Note that at
|
2210
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2211
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2212
|
+
#
|
2213
|
+
# @param parent [::String]
|
2214
|
+
# Required. The name of the Data Catalog resource to list the tags of.
|
2215
|
+
#
|
2216
|
+
# The resource can be an {::Google::Cloud::DataCatalog::V1::Entry Entry}
|
2217
|
+
# or an {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}
|
2218
|
+
# (without `/entries/{entries}` at the end).
|
2219
|
+
# @param page_size [::Integer]
|
2220
|
+
# The maximum number of tags to return. Default is 10. Maximum limit is 1000.
|
2221
|
+
# @param page_token [::String]
|
2222
|
+
# Pagination token that specifies the next page to return. If empty, the
|
2223
|
+
# first page is returned.
|
2224
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2225
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>]
|
2226
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2227
|
+
#
|
2228
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>]
|
2229
|
+
#
|
2230
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2231
|
+
def list_tags request, options = nil
|
2232
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2233
|
+
|
2234
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ListTagsRequest
|
2235
|
+
|
2236
|
+
# Converts hash and nil to an options object
|
2237
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2238
|
+
|
2239
|
+
# Customize the options with defaults
|
2240
|
+
call_metadata = @config.rpcs.list_tags.metadata.to_h
|
2241
|
+
|
2242
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2243
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2244
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2245
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2246
|
+
transports_version_send: [:rest]
|
2247
|
+
|
2248
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2249
|
+
|
2250
|
+
options.apply_defaults timeout: @config.rpcs.list_tags.timeout,
|
2251
|
+
metadata: call_metadata,
|
2252
|
+
retry_policy: @config.rpcs.list_tags.retry_policy
|
2253
|
+
|
2254
|
+
options.apply_defaults timeout: @config.timeout,
|
2255
|
+
metadata: @config.metadata,
|
2256
|
+
retry_policy: @config.retry_policy
|
2257
|
+
|
2258
|
+
@data_catalog_stub.list_tags request, options do |result, operation|
|
2259
|
+
result = ::Gapic::Rest::PagedEnumerable.new @data_catalog_stub, :list_tags, "tags", request, result, options
|
2260
|
+
yield result, operation if block_given?
|
2261
|
+
return result
|
2262
|
+
end
|
2263
|
+
rescue ::Gapic::Rest::Error => e
|
2264
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2265
|
+
end
|
2266
|
+
|
2267
|
+
##
|
2268
|
+
# Marks an {::Google::Cloud::DataCatalog::V1::Entry Entry} as starred by
|
2269
|
+
# the current user. Starring information is private to each user.
|
2270
|
+
#
|
2271
|
+
# @overload star_entry(request, options = nil)
|
2272
|
+
# Pass arguments to `star_entry` via a request object, either of type
|
2273
|
+
# {::Google::Cloud::DataCatalog::V1::StarEntryRequest} or an equivalent Hash.
|
2274
|
+
#
|
2275
|
+
# @param request [::Google::Cloud::DataCatalog::V1::StarEntryRequest, ::Hash]
|
2276
|
+
# A request object representing the call parameters. Required. To specify no
|
2277
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2278
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2279
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2280
|
+
#
|
2281
|
+
# @overload star_entry(name: nil)
|
2282
|
+
# Pass arguments to `star_entry` via keyword arguments. Note that at
|
2283
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2284
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2285
|
+
#
|
2286
|
+
# @param name [::String]
|
2287
|
+
# Required. The name of the entry to mark as starred.
|
2288
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2289
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::StarEntryResponse]
|
2290
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2291
|
+
#
|
2292
|
+
# @return [::Google::Cloud::DataCatalog::V1::StarEntryResponse]
|
2293
|
+
#
|
2294
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2295
|
+
def star_entry request, options = nil
|
2296
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2297
|
+
|
2298
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::StarEntryRequest
|
2299
|
+
|
2300
|
+
# Converts hash and nil to an options object
|
2301
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2302
|
+
|
2303
|
+
# Customize the options with defaults
|
2304
|
+
call_metadata = @config.rpcs.star_entry.metadata.to_h
|
2305
|
+
|
2306
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2307
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2308
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2309
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2310
|
+
transports_version_send: [:rest]
|
2311
|
+
|
2312
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2313
|
+
|
2314
|
+
options.apply_defaults timeout: @config.rpcs.star_entry.timeout,
|
2315
|
+
metadata: call_metadata,
|
2316
|
+
retry_policy: @config.rpcs.star_entry.retry_policy
|
2317
|
+
|
2318
|
+
options.apply_defaults timeout: @config.timeout,
|
2319
|
+
metadata: @config.metadata,
|
2320
|
+
retry_policy: @config.retry_policy
|
2321
|
+
|
2322
|
+
@data_catalog_stub.star_entry request, options do |result, operation|
|
2323
|
+
yield result, operation if block_given?
|
2324
|
+
return result
|
2325
|
+
end
|
2326
|
+
rescue ::Gapic::Rest::Error => e
|
2327
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2328
|
+
end
|
2329
|
+
|
2330
|
+
##
|
2331
|
+
# Marks an {::Google::Cloud::DataCatalog::V1::Entry Entry} as NOT starred by
|
2332
|
+
# the current user. Starring information is private to each user.
|
2333
|
+
#
|
2334
|
+
# @overload unstar_entry(request, options = nil)
|
2335
|
+
# Pass arguments to `unstar_entry` via a request object, either of type
|
2336
|
+
# {::Google::Cloud::DataCatalog::V1::UnstarEntryRequest} or an equivalent Hash.
|
2337
|
+
#
|
2338
|
+
# @param request [::Google::Cloud::DataCatalog::V1::UnstarEntryRequest, ::Hash]
|
2339
|
+
# A request object representing the call parameters. Required. To specify no
|
2340
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2341
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2342
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2343
|
+
#
|
2344
|
+
# @overload unstar_entry(name: nil)
|
2345
|
+
# Pass arguments to `unstar_entry` via keyword arguments. Note that at
|
2346
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2347
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2348
|
+
#
|
2349
|
+
# @param name [::String]
|
2350
|
+
# Required. The name of the entry to mark as **not** starred.
|
2351
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2352
|
+
# @yieldparam result [::Google::Cloud::DataCatalog::V1::UnstarEntryResponse]
|
2353
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2354
|
+
#
|
2355
|
+
# @return [::Google::Cloud::DataCatalog::V1::UnstarEntryResponse]
|
2356
|
+
#
|
2357
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2358
|
+
def unstar_entry request, options = nil
|
2359
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2360
|
+
|
2361
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UnstarEntryRequest
|
2362
|
+
|
2363
|
+
# Converts hash and nil to an options object
|
2364
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2365
|
+
|
2366
|
+
# Customize the options with defaults
|
2367
|
+
call_metadata = @config.rpcs.unstar_entry.metadata.to_h
|
2368
|
+
|
2369
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2370
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2371
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2372
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2373
|
+
transports_version_send: [:rest]
|
2374
|
+
|
2375
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2376
|
+
|
2377
|
+
options.apply_defaults timeout: @config.rpcs.unstar_entry.timeout,
|
2378
|
+
metadata: call_metadata,
|
2379
|
+
retry_policy: @config.rpcs.unstar_entry.retry_policy
|
2380
|
+
|
2381
|
+
options.apply_defaults timeout: @config.timeout,
|
2382
|
+
metadata: @config.metadata,
|
2383
|
+
retry_policy: @config.retry_policy
|
2384
|
+
|
2385
|
+
@data_catalog_stub.unstar_entry request, options do |result, operation|
|
2386
|
+
yield result, operation if block_given?
|
2387
|
+
return result
|
2388
|
+
end
|
2389
|
+
rescue ::Gapic::Rest::Error => e
|
2390
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2391
|
+
end
|
2392
|
+
|
2393
|
+
##
|
2394
|
+
# Sets an access control policy for a resource. Replaces any existing
|
2395
|
+
# policy.
|
2396
|
+
#
|
2397
|
+
# Supported resources are:
|
2398
|
+
#
|
2399
|
+
# - Tag templates
|
2400
|
+
# - Entry groups
|
2401
|
+
#
|
2402
|
+
# Note: This method sets policies only within Data Catalog and can't be
|
2403
|
+
# used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
|
2404
|
+
# external Google Cloud Platform resources synced with the Data Catalog.
|
2405
|
+
#
|
2406
|
+
# To call this method, you must have the following Google IAM permissions:
|
2407
|
+
#
|
2408
|
+
# - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
|
2409
|
+
# templates.
|
2410
|
+
# - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
|
2411
|
+
#
|
2412
|
+
# @overload set_iam_policy(request, options = nil)
|
2413
|
+
# Pass arguments to `set_iam_policy` via a request object, either of type
|
2414
|
+
# {::Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
|
2415
|
+
#
|
2416
|
+
# @param request [::Google::Iam::V1::SetIamPolicyRequest, ::Hash]
|
2417
|
+
# A request object representing the call parameters. Required. To specify no
|
2418
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2419
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2420
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2421
|
+
#
|
2422
|
+
# @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
|
2423
|
+
# Pass arguments to `set_iam_policy` via keyword arguments. Note that at
|
2424
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2425
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2426
|
+
#
|
2427
|
+
# @param resource [::String]
|
2428
|
+
# REQUIRED: The resource for which the policy is being specified.
|
2429
|
+
# See the operation documentation for the appropriate value for this field.
|
2430
|
+
# @param policy [::Google::Iam::V1::Policy, ::Hash]
|
2431
|
+
# REQUIRED: The complete policy to be applied to the `resource`. The size of
|
2432
|
+
# the policy is limited to a few 10s of KB. An empty policy is a
|
2433
|
+
# valid policy but certain Cloud Platform services (such as Projects)
|
2434
|
+
# might reject them.
|
2435
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2436
|
+
# OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
|
2437
|
+
# the fields in the mask will be modified. If no mask is provided, the
|
2438
|
+
# following default mask is used:
|
2439
|
+
#
|
2440
|
+
# `paths: "bindings, etag"`
|
2441
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2442
|
+
# @yieldparam result [::Google::Iam::V1::Policy]
|
2443
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2444
|
+
#
|
2445
|
+
# @return [::Google::Iam::V1::Policy]
|
2446
|
+
#
|
2447
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2448
|
+
def set_iam_policy request, options = nil
|
2449
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2450
|
+
|
2451
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest
|
2452
|
+
|
2453
|
+
# Converts hash and nil to an options object
|
2454
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2455
|
+
|
2456
|
+
# Customize the options with defaults
|
2457
|
+
call_metadata = @config.rpcs.set_iam_policy.metadata.to_h
|
2458
|
+
|
2459
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2460
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2461
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2462
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2463
|
+
transports_version_send: [:rest]
|
2464
|
+
|
2465
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2466
|
+
|
2467
|
+
options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
|
2468
|
+
metadata: call_metadata,
|
2469
|
+
retry_policy: @config.rpcs.set_iam_policy.retry_policy
|
2470
|
+
|
2471
|
+
options.apply_defaults timeout: @config.timeout,
|
2472
|
+
metadata: @config.metadata,
|
2473
|
+
retry_policy: @config.retry_policy
|
2474
|
+
|
2475
|
+
@data_catalog_stub.set_iam_policy request, options do |result, operation|
|
2476
|
+
yield result, operation if block_given?
|
2477
|
+
return result
|
2478
|
+
end
|
2479
|
+
rescue ::Gapic::Rest::Error => e
|
2480
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2481
|
+
end
|
2482
|
+
|
2483
|
+
##
|
2484
|
+
# Gets the access control policy for a resource.
|
2485
|
+
#
|
2486
|
+
# May return:
|
2487
|
+
#
|
2488
|
+
# * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
|
2489
|
+
# permission to view it.
|
2490
|
+
# * An empty policy if the resource exists but doesn't have a set policy.
|
2491
|
+
#
|
2492
|
+
# Supported resources are:
|
2493
|
+
#
|
2494
|
+
# - Tag templates
|
2495
|
+
# - Entry groups
|
2496
|
+
#
|
2497
|
+
# Note: This method doesn't get policies from Google Cloud Platform
|
2498
|
+
# resources ingested into Data Catalog.
|
2499
|
+
#
|
2500
|
+
# To call this method, you must have the following Google IAM permissions:
|
2501
|
+
#
|
2502
|
+
# - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
|
2503
|
+
# templates.
|
2504
|
+
# - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
|
2505
|
+
#
|
2506
|
+
# @overload get_iam_policy(request, options = nil)
|
2507
|
+
# Pass arguments to `get_iam_policy` via a request object, either of type
|
2508
|
+
# {::Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
|
2509
|
+
#
|
2510
|
+
# @param request [::Google::Iam::V1::GetIamPolicyRequest, ::Hash]
|
2511
|
+
# A request object representing the call parameters. Required. To specify no
|
2512
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2513
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2514
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2515
|
+
#
|
2516
|
+
# @overload get_iam_policy(resource: nil, options: nil)
|
2517
|
+
# Pass arguments to `get_iam_policy` via keyword arguments. Note that at
|
2518
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2519
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2520
|
+
#
|
2521
|
+
# @param resource [::String]
|
2522
|
+
# REQUIRED: The resource for which the policy is being requested.
|
2523
|
+
# See the operation documentation for the appropriate value for this field.
|
2524
|
+
# @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
|
2525
|
+
# OPTIONAL: A `GetPolicyOptions` object for specifying options to
|
2526
|
+
# `GetIamPolicy`.
|
2527
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2528
|
+
# @yieldparam result [::Google::Iam::V1::Policy]
|
2529
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2530
|
+
#
|
2531
|
+
# @return [::Google::Iam::V1::Policy]
|
2532
|
+
#
|
2533
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2534
|
+
def get_iam_policy request, options = nil
|
2535
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2536
|
+
|
2537
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest
|
2538
|
+
|
2539
|
+
# Converts hash and nil to an options object
|
2540
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2541
|
+
|
2542
|
+
# Customize the options with defaults
|
2543
|
+
call_metadata = @config.rpcs.get_iam_policy.metadata.to_h
|
2544
|
+
|
2545
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2546
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2547
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2548
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2549
|
+
transports_version_send: [:rest]
|
2550
|
+
|
2551
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2552
|
+
|
2553
|
+
options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
|
2554
|
+
metadata: call_metadata,
|
2555
|
+
retry_policy: @config.rpcs.get_iam_policy.retry_policy
|
2556
|
+
|
2557
|
+
options.apply_defaults timeout: @config.timeout,
|
2558
|
+
metadata: @config.metadata,
|
2559
|
+
retry_policy: @config.retry_policy
|
2560
|
+
|
2561
|
+
@data_catalog_stub.get_iam_policy request, options do |result, operation|
|
2562
|
+
yield result, operation if block_given?
|
2563
|
+
return result
|
2564
|
+
end
|
2565
|
+
rescue ::Gapic::Rest::Error => e
|
2566
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2567
|
+
end
|
2568
|
+
|
2569
|
+
##
|
2570
|
+
# Gets your permissions on a resource.
|
2571
|
+
#
|
2572
|
+
# Returns an empty set of permissions if the resource doesn't exist.
|
2573
|
+
#
|
2574
|
+
# Supported resources are:
|
2575
|
+
#
|
2576
|
+
# - Tag templates
|
2577
|
+
# - Entry groups
|
2578
|
+
#
|
2579
|
+
# Note: This method gets policies only within Data Catalog and can't be
|
2580
|
+
# used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
|
2581
|
+
# external Google Cloud Platform resources ingested into Data Catalog.
|
2582
|
+
#
|
2583
|
+
# No Google IAM permissions are required to call this method.
|
2584
|
+
#
|
2585
|
+
# @overload test_iam_permissions(request, options = nil)
|
2586
|
+
# Pass arguments to `test_iam_permissions` via a request object, either of type
|
2587
|
+
# {::Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash.
|
2588
|
+
#
|
2589
|
+
# @param request [::Google::Iam::V1::TestIamPermissionsRequest, ::Hash]
|
2590
|
+
# A request object representing the call parameters. Required. To specify no
|
2591
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2592
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2593
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2594
|
+
#
|
2595
|
+
# @overload test_iam_permissions(resource: nil, permissions: nil)
|
2596
|
+
# Pass arguments to `test_iam_permissions` via keyword arguments. Note that at
|
2597
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2598
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2599
|
+
#
|
2600
|
+
# @param resource [::String]
|
2601
|
+
# REQUIRED: The resource for which the policy detail is being requested.
|
2602
|
+
# See the operation documentation for the appropriate value for this field.
|
2603
|
+
# @param permissions [::Array<::String>]
|
2604
|
+
# The set of permissions to check for the `resource`. Permissions with
|
2605
|
+
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
2606
|
+
# information see
|
2607
|
+
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
2608
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2609
|
+
# @yieldparam result [::Google::Iam::V1::TestIamPermissionsResponse]
|
2610
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2611
|
+
#
|
2612
|
+
# @return [::Google::Iam::V1::TestIamPermissionsResponse]
|
2613
|
+
#
|
2614
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2615
|
+
def test_iam_permissions request, options = nil
|
2616
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2617
|
+
|
2618
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest
|
2619
|
+
|
2620
|
+
# Converts hash and nil to an options object
|
2621
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2622
|
+
|
2623
|
+
# Customize the options with defaults
|
2624
|
+
call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h
|
2625
|
+
|
2626
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2627
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2628
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2629
|
+
gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION,
|
2630
|
+
transports_version_send: [:rest]
|
2631
|
+
|
2632
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2633
|
+
|
2634
|
+
options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
|
2635
|
+
metadata: call_metadata,
|
2636
|
+
retry_policy: @config.rpcs.test_iam_permissions.retry_policy
|
2637
|
+
|
2638
|
+
options.apply_defaults timeout: @config.timeout,
|
2639
|
+
metadata: @config.metadata,
|
2640
|
+
retry_policy: @config.retry_policy
|
2641
|
+
|
2642
|
+
@data_catalog_stub.test_iam_permissions request, options do |result, operation|
|
2643
|
+
yield result, operation if block_given?
|
2644
|
+
return result
|
2645
|
+
end
|
2646
|
+
rescue ::Gapic::Rest::Error => e
|
2647
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2648
|
+
end
|
2649
|
+
|
2650
|
+
##
|
2651
|
+
# Configuration class for the DataCatalog REST API.
|
2652
|
+
#
|
2653
|
+
# This class represents the configuration for DataCatalog REST,
|
2654
|
+
# providing control over timeouts, retry behavior, logging, transport
|
2655
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
2656
|
+
# applied individually to specific RPCs. See
|
2657
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client::Configuration::Rpcs}
|
2658
|
+
# for a list of RPCs that can be configured independently.
|
2659
|
+
#
|
2660
|
+
# Configuration can be applied globally to all clients, or to a single client
|
2661
|
+
# on construction.
|
2662
|
+
#
|
2663
|
+
# @example
|
2664
|
+
#
|
2665
|
+
# # Modify the global config, setting the timeout for
|
2666
|
+
# # search_catalog to 20 seconds,
|
2667
|
+
# # and all remaining timeouts to 10 seconds.
|
2668
|
+
# ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.configure do |config|
|
2669
|
+
# config.timeout = 10.0
|
2670
|
+
# config.rpcs.search_catalog.timeout = 20.0
|
2671
|
+
# end
|
2672
|
+
#
|
2673
|
+
# # Apply the above configuration only to a new client.
|
2674
|
+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new do |config|
|
2675
|
+
# config.timeout = 10.0
|
2676
|
+
# config.rpcs.search_catalog.timeout = 20.0
|
2677
|
+
# end
|
2678
|
+
#
|
2679
|
+
# @!attribute [rw] endpoint
|
2680
|
+
# The hostname or hostname:port of the service endpoint.
|
2681
|
+
# Defaults to `"datacatalog.googleapis.com"`.
|
2682
|
+
# @return [::String]
|
2683
|
+
# @!attribute [rw] credentials
|
2684
|
+
# Credentials to send with calls. You may provide any of the following types:
|
2685
|
+
# * (`String`) The path to a service account key file in JSON format
|
2686
|
+
# * (`Hash`) A service account key as a Hash
|
2687
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
2688
|
+
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
2689
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
2690
|
+
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
2691
|
+
# * (`nil`) indicating no credentials
|
2692
|
+
# @return [::Object]
|
2693
|
+
# @!attribute [rw] scope
|
2694
|
+
# The OAuth scopes
|
2695
|
+
# @return [::Array<::String>]
|
2696
|
+
# @!attribute [rw] lib_name
|
2697
|
+
# The library name as recorded in instrumentation and logging
|
2698
|
+
# @return [::String]
|
2699
|
+
# @!attribute [rw] lib_version
|
2700
|
+
# The library version as recorded in instrumentation and logging
|
2701
|
+
# @return [::String]
|
2702
|
+
# @!attribute [rw] timeout
|
2703
|
+
# The call timeout in seconds.
|
2704
|
+
# @return [::Numeric]
|
2705
|
+
# @!attribute [rw] metadata
|
2706
|
+
# Additional headers to be sent with the call.
|
2707
|
+
# @return [::Hash{::Symbol=>::String}]
|
2708
|
+
# @!attribute [rw] retry_policy
|
2709
|
+
# The retry policy. The value is a hash with the following keys:
|
2710
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
2711
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
2712
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
2713
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
2714
|
+
# trigger a retry.
|
2715
|
+
# @return [::Hash]
|
2716
|
+
# @!attribute [rw] quota_project
|
2717
|
+
# A separate project against which to charge quota.
|
2718
|
+
# @return [::String]
|
2719
|
+
#
|
2720
|
+
class Configuration
|
2721
|
+
extend ::Gapic::Config
|
2722
|
+
|
2723
|
+
config_attr :endpoint, "datacatalog.googleapis.com", ::String
|
2724
|
+
config_attr :credentials, nil do |value|
|
2725
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2726
|
+
allowed.any? { |klass| klass === value }
|
2727
|
+
end
|
2728
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
2729
|
+
config_attr :lib_name, nil, ::String, nil
|
2730
|
+
config_attr :lib_version, nil, ::String, nil
|
2731
|
+
config_attr :timeout, nil, ::Numeric, nil
|
2732
|
+
config_attr :metadata, nil, ::Hash, nil
|
2733
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2734
|
+
config_attr :quota_project, nil, ::String, nil
|
2735
|
+
|
2736
|
+
# @private
|
2737
|
+
def initialize parent_config = nil
|
2738
|
+
@parent_config = parent_config unless parent_config.nil?
|
2739
|
+
|
2740
|
+
yield self if block_given?
|
2741
|
+
end
|
2742
|
+
|
2743
|
+
##
|
2744
|
+
# Configurations for individual RPCs
|
2745
|
+
# @return [Rpcs]
|
2746
|
+
#
|
2747
|
+
def rpcs
|
2748
|
+
@rpcs ||= begin
|
2749
|
+
parent_rpcs = nil
|
2750
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
2751
|
+
Rpcs.new parent_rpcs
|
2752
|
+
end
|
2753
|
+
end
|
2754
|
+
|
2755
|
+
##
|
2756
|
+
# Configuration RPC class for the DataCatalog API.
|
2757
|
+
#
|
2758
|
+
# Includes fields providing the configuration for each RPC in this service.
|
2759
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
2760
|
+
# the following configuration fields:
|
2761
|
+
#
|
2762
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
2763
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
|
2764
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
2765
|
+
# include the following keys:
|
2766
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
2767
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
2768
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
2769
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
2770
|
+
# trigger a retry.
|
2771
|
+
#
|
2772
|
+
class Rpcs
|
2773
|
+
##
|
2774
|
+
# RPC-specific configuration for `search_catalog`
|
2775
|
+
# @return [::Gapic::Config::Method]
|
2776
|
+
#
|
2777
|
+
attr_reader :search_catalog
|
2778
|
+
##
|
2779
|
+
# RPC-specific configuration for `create_entry_group`
|
2780
|
+
# @return [::Gapic::Config::Method]
|
2781
|
+
#
|
2782
|
+
attr_reader :create_entry_group
|
2783
|
+
##
|
2784
|
+
# RPC-specific configuration for `get_entry_group`
|
2785
|
+
# @return [::Gapic::Config::Method]
|
2786
|
+
#
|
2787
|
+
attr_reader :get_entry_group
|
2788
|
+
##
|
2789
|
+
# RPC-specific configuration for `update_entry_group`
|
2790
|
+
# @return [::Gapic::Config::Method]
|
2791
|
+
#
|
2792
|
+
attr_reader :update_entry_group
|
2793
|
+
##
|
2794
|
+
# RPC-specific configuration for `delete_entry_group`
|
2795
|
+
# @return [::Gapic::Config::Method]
|
2796
|
+
#
|
2797
|
+
attr_reader :delete_entry_group
|
2798
|
+
##
|
2799
|
+
# RPC-specific configuration for `list_entry_groups`
|
2800
|
+
# @return [::Gapic::Config::Method]
|
2801
|
+
#
|
2802
|
+
attr_reader :list_entry_groups
|
2803
|
+
##
|
2804
|
+
# RPC-specific configuration for `create_entry`
|
2805
|
+
# @return [::Gapic::Config::Method]
|
2806
|
+
#
|
2807
|
+
attr_reader :create_entry
|
2808
|
+
##
|
2809
|
+
# RPC-specific configuration for `update_entry`
|
2810
|
+
# @return [::Gapic::Config::Method]
|
2811
|
+
#
|
2812
|
+
attr_reader :update_entry
|
2813
|
+
##
|
2814
|
+
# RPC-specific configuration for `delete_entry`
|
2815
|
+
# @return [::Gapic::Config::Method]
|
2816
|
+
#
|
2817
|
+
attr_reader :delete_entry
|
2818
|
+
##
|
2819
|
+
# RPC-specific configuration for `get_entry`
|
2820
|
+
# @return [::Gapic::Config::Method]
|
2821
|
+
#
|
2822
|
+
attr_reader :get_entry
|
2823
|
+
##
|
2824
|
+
# RPC-specific configuration for `lookup_entry`
|
2825
|
+
# @return [::Gapic::Config::Method]
|
2826
|
+
#
|
2827
|
+
attr_reader :lookup_entry
|
2828
|
+
##
|
2829
|
+
# RPC-specific configuration for `list_entries`
|
2830
|
+
# @return [::Gapic::Config::Method]
|
2831
|
+
#
|
2832
|
+
attr_reader :list_entries
|
2833
|
+
##
|
2834
|
+
# RPC-specific configuration for `modify_entry_overview`
|
2835
|
+
# @return [::Gapic::Config::Method]
|
2836
|
+
#
|
2837
|
+
attr_reader :modify_entry_overview
|
2838
|
+
##
|
2839
|
+
# RPC-specific configuration for `modify_entry_contacts`
|
2840
|
+
# @return [::Gapic::Config::Method]
|
2841
|
+
#
|
2842
|
+
attr_reader :modify_entry_contacts
|
2843
|
+
##
|
2844
|
+
# RPC-specific configuration for `create_tag_template`
|
2845
|
+
# @return [::Gapic::Config::Method]
|
2846
|
+
#
|
2847
|
+
attr_reader :create_tag_template
|
2848
|
+
##
|
2849
|
+
# RPC-specific configuration for `get_tag_template`
|
2850
|
+
# @return [::Gapic::Config::Method]
|
2851
|
+
#
|
2852
|
+
attr_reader :get_tag_template
|
2853
|
+
##
|
2854
|
+
# RPC-specific configuration for `update_tag_template`
|
2855
|
+
# @return [::Gapic::Config::Method]
|
2856
|
+
#
|
2857
|
+
attr_reader :update_tag_template
|
2858
|
+
##
|
2859
|
+
# RPC-specific configuration for `delete_tag_template`
|
2860
|
+
# @return [::Gapic::Config::Method]
|
2861
|
+
#
|
2862
|
+
attr_reader :delete_tag_template
|
2863
|
+
##
|
2864
|
+
# RPC-specific configuration for `create_tag_template_field`
|
2865
|
+
# @return [::Gapic::Config::Method]
|
2866
|
+
#
|
2867
|
+
attr_reader :create_tag_template_field
|
2868
|
+
##
|
2869
|
+
# RPC-specific configuration for `update_tag_template_field`
|
2870
|
+
# @return [::Gapic::Config::Method]
|
2871
|
+
#
|
2872
|
+
attr_reader :update_tag_template_field
|
2873
|
+
##
|
2874
|
+
# RPC-specific configuration for `rename_tag_template_field`
|
2875
|
+
# @return [::Gapic::Config::Method]
|
2876
|
+
#
|
2877
|
+
attr_reader :rename_tag_template_field
|
2878
|
+
##
|
2879
|
+
# RPC-specific configuration for `rename_tag_template_field_enum_value`
|
2880
|
+
# @return [::Gapic::Config::Method]
|
2881
|
+
#
|
2882
|
+
attr_reader :rename_tag_template_field_enum_value
|
2883
|
+
##
|
2884
|
+
# RPC-specific configuration for `delete_tag_template_field`
|
2885
|
+
# @return [::Gapic::Config::Method]
|
2886
|
+
#
|
2887
|
+
attr_reader :delete_tag_template_field
|
2888
|
+
##
|
2889
|
+
# RPC-specific configuration for `create_tag`
|
2890
|
+
# @return [::Gapic::Config::Method]
|
2891
|
+
#
|
2892
|
+
attr_reader :create_tag
|
2893
|
+
##
|
2894
|
+
# RPC-specific configuration for `update_tag`
|
2895
|
+
# @return [::Gapic::Config::Method]
|
2896
|
+
#
|
2897
|
+
attr_reader :update_tag
|
2898
|
+
##
|
2899
|
+
# RPC-specific configuration for `delete_tag`
|
2900
|
+
# @return [::Gapic::Config::Method]
|
2901
|
+
#
|
2902
|
+
attr_reader :delete_tag
|
2903
|
+
##
|
2904
|
+
# RPC-specific configuration for `list_tags`
|
2905
|
+
# @return [::Gapic::Config::Method]
|
2906
|
+
#
|
2907
|
+
attr_reader :list_tags
|
2908
|
+
##
|
2909
|
+
# RPC-specific configuration for `star_entry`
|
2910
|
+
# @return [::Gapic::Config::Method]
|
2911
|
+
#
|
2912
|
+
attr_reader :star_entry
|
2913
|
+
##
|
2914
|
+
# RPC-specific configuration for `unstar_entry`
|
2915
|
+
# @return [::Gapic::Config::Method]
|
2916
|
+
#
|
2917
|
+
attr_reader :unstar_entry
|
2918
|
+
##
|
2919
|
+
# RPC-specific configuration for `set_iam_policy`
|
2920
|
+
# @return [::Gapic::Config::Method]
|
2921
|
+
#
|
2922
|
+
attr_reader :set_iam_policy
|
2923
|
+
##
|
2924
|
+
# RPC-specific configuration for `get_iam_policy`
|
2925
|
+
# @return [::Gapic::Config::Method]
|
2926
|
+
#
|
2927
|
+
attr_reader :get_iam_policy
|
2928
|
+
##
|
2929
|
+
# RPC-specific configuration for `test_iam_permissions`
|
2930
|
+
# @return [::Gapic::Config::Method]
|
2931
|
+
#
|
2932
|
+
attr_reader :test_iam_permissions
|
2933
|
+
|
2934
|
+
# @private
|
2935
|
+
def initialize parent_rpcs = nil
|
2936
|
+
search_catalog_config = parent_rpcs.search_catalog if parent_rpcs.respond_to? :search_catalog
|
2937
|
+
@search_catalog = ::Gapic::Config::Method.new search_catalog_config
|
2938
|
+
create_entry_group_config = parent_rpcs.create_entry_group if parent_rpcs.respond_to? :create_entry_group
|
2939
|
+
@create_entry_group = ::Gapic::Config::Method.new create_entry_group_config
|
2940
|
+
get_entry_group_config = parent_rpcs.get_entry_group if parent_rpcs.respond_to? :get_entry_group
|
2941
|
+
@get_entry_group = ::Gapic::Config::Method.new get_entry_group_config
|
2942
|
+
update_entry_group_config = parent_rpcs.update_entry_group if parent_rpcs.respond_to? :update_entry_group
|
2943
|
+
@update_entry_group = ::Gapic::Config::Method.new update_entry_group_config
|
2944
|
+
delete_entry_group_config = parent_rpcs.delete_entry_group if parent_rpcs.respond_to? :delete_entry_group
|
2945
|
+
@delete_entry_group = ::Gapic::Config::Method.new delete_entry_group_config
|
2946
|
+
list_entry_groups_config = parent_rpcs.list_entry_groups if parent_rpcs.respond_to? :list_entry_groups
|
2947
|
+
@list_entry_groups = ::Gapic::Config::Method.new list_entry_groups_config
|
2948
|
+
create_entry_config = parent_rpcs.create_entry if parent_rpcs.respond_to? :create_entry
|
2949
|
+
@create_entry = ::Gapic::Config::Method.new create_entry_config
|
2950
|
+
update_entry_config = parent_rpcs.update_entry if parent_rpcs.respond_to? :update_entry
|
2951
|
+
@update_entry = ::Gapic::Config::Method.new update_entry_config
|
2952
|
+
delete_entry_config = parent_rpcs.delete_entry if parent_rpcs.respond_to? :delete_entry
|
2953
|
+
@delete_entry = ::Gapic::Config::Method.new delete_entry_config
|
2954
|
+
get_entry_config = parent_rpcs.get_entry if parent_rpcs.respond_to? :get_entry
|
2955
|
+
@get_entry = ::Gapic::Config::Method.new get_entry_config
|
2956
|
+
lookup_entry_config = parent_rpcs.lookup_entry if parent_rpcs.respond_to? :lookup_entry
|
2957
|
+
@lookup_entry = ::Gapic::Config::Method.new lookup_entry_config
|
2958
|
+
list_entries_config = parent_rpcs.list_entries if parent_rpcs.respond_to? :list_entries
|
2959
|
+
@list_entries = ::Gapic::Config::Method.new list_entries_config
|
2960
|
+
modify_entry_overview_config = parent_rpcs.modify_entry_overview if parent_rpcs.respond_to? :modify_entry_overview
|
2961
|
+
@modify_entry_overview = ::Gapic::Config::Method.new modify_entry_overview_config
|
2962
|
+
modify_entry_contacts_config = parent_rpcs.modify_entry_contacts if parent_rpcs.respond_to? :modify_entry_contacts
|
2963
|
+
@modify_entry_contacts = ::Gapic::Config::Method.new modify_entry_contacts_config
|
2964
|
+
create_tag_template_config = parent_rpcs.create_tag_template if parent_rpcs.respond_to? :create_tag_template
|
2965
|
+
@create_tag_template = ::Gapic::Config::Method.new create_tag_template_config
|
2966
|
+
get_tag_template_config = parent_rpcs.get_tag_template if parent_rpcs.respond_to? :get_tag_template
|
2967
|
+
@get_tag_template = ::Gapic::Config::Method.new get_tag_template_config
|
2968
|
+
update_tag_template_config = parent_rpcs.update_tag_template if parent_rpcs.respond_to? :update_tag_template
|
2969
|
+
@update_tag_template = ::Gapic::Config::Method.new update_tag_template_config
|
2970
|
+
delete_tag_template_config = parent_rpcs.delete_tag_template if parent_rpcs.respond_to? :delete_tag_template
|
2971
|
+
@delete_tag_template = ::Gapic::Config::Method.new delete_tag_template_config
|
2972
|
+
create_tag_template_field_config = parent_rpcs.create_tag_template_field if parent_rpcs.respond_to? :create_tag_template_field
|
2973
|
+
@create_tag_template_field = ::Gapic::Config::Method.new create_tag_template_field_config
|
2974
|
+
update_tag_template_field_config = parent_rpcs.update_tag_template_field if parent_rpcs.respond_to? :update_tag_template_field
|
2975
|
+
@update_tag_template_field = ::Gapic::Config::Method.new update_tag_template_field_config
|
2976
|
+
rename_tag_template_field_config = parent_rpcs.rename_tag_template_field if parent_rpcs.respond_to? :rename_tag_template_field
|
2977
|
+
@rename_tag_template_field = ::Gapic::Config::Method.new rename_tag_template_field_config
|
2978
|
+
rename_tag_template_field_enum_value_config = parent_rpcs.rename_tag_template_field_enum_value if parent_rpcs.respond_to? :rename_tag_template_field_enum_value
|
2979
|
+
@rename_tag_template_field_enum_value = ::Gapic::Config::Method.new rename_tag_template_field_enum_value_config
|
2980
|
+
delete_tag_template_field_config = parent_rpcs.delete_tag_template_field if parent_rpcs.respond_to? :delete_tag_template_field
|
2981
|
+
@delete_tag_template_field = ::Gapic::Config::Method.new delete_tag_template_field_config
|
2982
|
+
create_tag_config = parent_rpcs.create_tag if parent_rpcs.respond_to? :create_tag
|
2983
|
+
@create_tag = ::Gapic::Config::Method.new create_tag_config
|
2984
|
+
update_tag_config = parent_rpcs.update_tag if parent_rpcs.respond_to? :update_tag
|
2985
|
+
@update_tag = ::Gapic::Config::Method.new update_tag_config
|
2986
|
+
delete_tag_config = parent_rpcs.delete_tag if parent_rpcs.respond_to? :delete_tag
|
2987
|
+
@delete_tag = ::Gapic::Config::Method.new delete_tag_config
|
2988
|
+
list_tags_config = parent_rpcs.list_tags if parent_rpcs.respond_to? :list_tags
|
2989
|
+
@list_tags = ::Gapic::Config::Method.new list_tags_config
|
2990
|
+
star_entry_config = parent_rpcs.star_entry if parent_rpcs.respond_to? :star_entry
|
2991
|
+
@star_entry = ::Gapic::Config::Method.new star_entry_config
|
2992
|
+
unstar_entry_config = parent_rpcs.unstar_entry if parent_rpcs.respond_to? :unstar_entry
|
2993
|
+
@unstar_entry = ::Gapic::Config::Method.new unstar_entry_config
|
2994
|
+
set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
|
2995
|
+
@set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
|
2996
|
+
get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
|
2997
|
+
@get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
|
2998
|
+
test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
|
2999
|
+
@test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
|
3000
|
+
|
3001
|
+
yield self if block_given?
|
3002
|
+
end
|
3003
|
+
end
|
3004
|
+
end
|
3005
|
+
end
|
3006
|
+
end
|
3007
|
+
end
|
3008
|
+
end
|
3009
|
+
end
|
3010
|
+
end
|
3011
|
+
end
|