google-cloud-dataplex-v1 0.19.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +3 -3
  4. data/lib/google/cloud/dataplex/v1/bindings_override.rb +1 -1
  5. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +101 -0
  6. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +2795 -0
  7. data/lib/google/cloud/dataplex/v1/catalog_service/credentials.rb +47 -0
  8. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +801 -0
  9. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +128 -0
  10. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +2620 -0
  11. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +895 -0
  12. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +1375 -0
  13. data/lib/google/cloud/dataplex/v1/catalog_service/rest.rb +58 -0
  14. data/lib/google/cloud/dataplex/v1/catalog_service.rb +60 -0
  15. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +91 -0
  16. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +6 -1
  17. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +95 -0
  18. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +88 -0
  19. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +68 -0
  20. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +4 -2
  21. data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
  22. data/lib/google/cloud/dataplex/v1/rest.rb +3 -2
  23. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  24. data/lib/google/cloud/dataplex/v1.rb +4 -3
  25. data/proto_docs/google/api/client.rb +4 -0
  26. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +1115 -0
  27. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +57 -0
  28. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +21 -0
  29. data/proto_docs/google/protobuf/struct.rb +96 -0
  30. metadata +15 -2
@@ -0,0 +1,2620 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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/dataplex/v1/catalog_pb"
21
+ require "google/cloud/dataplex/v1/catalog_service/rest/service_stub"
22
+ require "google/cloud/location/rest"
23
+ require "google/iam/v1/rest"
24
+
25
+ module Google
26
+ module Cloud
27
+ module Dataplex
28
+ module V1
29
+ module CatalogService
30
+ module Rest
31
+ ##
32
+ # REST client for the CatalogService service.
33
+ #
34
+ # The primary resources offered by this service are EntryGroups, EntryTypes,
35
+ # AspectTypes, Entry and Aspect which collectively allow a data administrator
36
+ # to organize, manage, secure and catalog data across their organization
37
+ # located across cloud projects in a variety of storage systems including Cloud
38
+ # Storage and BigQuery.
39
+ #
40
+ class Client
41
+ # @private
42
+ DEFAULT_ENDPOINT_TEMPLATE = "dataplex.$UNIVERSE_DOMAIN$"
43
+
44
+ include Paths
45
+
46
+ # @private
47
+ attr_reader :catalog_service_stub
48
+
49
+ ##
50
+ # Configure the CatalogService Client class.
51
+ #
52
+ # See {::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client::Configuration}
53
+ # for a description of the configuration fields.
54
+ #
55
+ # @example
56
+ #
57
+ # # Modify the configuration for all CatalogService clients
58
+ # ::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.configure do |config|
59
+ # config.timeout = 10.0
60
+ # end
61
+ #
62
+ # @yield [config] Configure the Client client.
63
+ # @yieldparam config [Client::Configuration]
64
+ #
65
+ # @return [Client::Configuration]
66
+ #
67
+ def self.configure
68
+ @configure ||= begin
69
+ namespace = ["Google", "Cloud", "Dataplex", "V1"]
70
+ parent_config = while namespace.any?
71
+ parent_name = namespace.join "::"
72
+ parent_const = const_get parent_name
73
+ break parent_const.configure if parent_const.respond_to? :configure
74
+ namespace.pop
75
+ end
76
+ default_config = Client::Configuration.new parent_config
77
+
78
+ default_config.rpcs.create_entry_type.timeout = 60.0
79
+
80
+ default_config.rpcs.update_entry_type.timeout = 60.0
81
+
82
+ default_config.rpcs.delete_entry_type.timeout = 60.0
83
+
84
+ default_config.rpcs.list_entry_types.timeout = 60.0
85
+ default_config.rpcs.list_entry_types.retry_policy = {
86
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
87
+ }
88
+
89
+ default_config.rpcs.get_entry_type.timeout = 60.0
90
+ default_config.rpcs.get_entry_type.retry_policy = {
91
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
92
+ }
93
+
94
+ default_config.rpcs.create_aspect_type.timeout = 60.0
95
+
96
+ default_config.rpcs.update_aspect_type.timeout = 60.0
97
+
98
+ default_config.rpcs.delete_aspect_type.timeout = 60.0
99
+
100
+ default_config.rpcs.list_aspect_types.timeout = 60.0
101
+ default_config.rpcs.list_aspect_types.retry_policy = {
102
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
103
+ }
104
+
105
+ default_config.rpcs.get_aspect_type.timeout = 60.0
106
+ default_config.rpcs.get_aspect_type.retry_policy = {
107
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
108
+ }
109
+
110
+ default_config.rpcs.create_entry_group.timeout = 60.0
111
+
112
+ default_config.rpcs.update_entry_group.timeout = 60.0
113
+
114
+ default_config.rpcs.delete_entry_group.timeout = 60.0
115
+
116
+ default_config.rpcs.list_entry_groups.timeout = 60.0
117
+ default_config.rpcs.list_entry_groups.retry_policy = {
118
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
119
+ }
120
+
121
+ default_config.rpcs.get_entry_group.timeout = 60.0
122
+ default_config.rpcs.get_entry_group.retry_policy = {
123
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
124
+ }
125
+
126
+ default_config.rpcs.create_entry.timeout = 60.0
127
+
128
+ default_config.rpcs.update_entry.timeout = 60.0
129
+ default_config.rpcs.update_entry.retry_policy = {
130
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
131
+ }
132
+
133
+ default_config.rpcs.delete_entry.timeout = 60.0
134
+
135
+ default_config.rpcs.list_entries.timeout = 20.0
136
+ default_config.rpcs.list_entries.retry_policy = {
137
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
138
+ }
139
+
140
+ default_config.rpcs.get_entry.timeout = 20.0
141
+ default_config.rpcs.get_entry.retry_policy = {
142
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
143
+ }
144
+
145
+ default_config.rpcs.lookup_entry.timeout = 20.0
146
+ default_config.rpcs.lookup_entry.retry_policy = {
147
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
148
+ }
149
+
150
+ default_config.rpcs.search_entries.timeout = 60.0
151
+ default_config.rpcs.search_entries.retry_policy = {
152
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 8]
153
+ }
154
+
155
+ default_config
156
+ end
157
+ yield @configure if block_given?
158
+ @configure
159
+ end
160
+
161
+ ##
162
+ # Configure the CatalogService Client instance.
163
+ #
164
+ # The configuration is set to the derived mode, meaning that values can be changed,
165
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
166
+ # should be made on {Client.configure}.
167
+ #
168
+ # See {::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client::Configuration}
169
+ # for a description of the configuration fields.
170
+ #
171
+ # @yield [config] Configure the Client client.
172
+ # @yieldparam config [Client::Configuration]
173
+ #
174
+ # @return [Client::Configuration]
175
+ #
176
+ def configure
177
+ yield @config if block_given?
178
+ @config
179
+ end
180
+
181
+ ##
182
+ # The effective universe domain
183
+ #
184
+ # @return [String]
185
+ #
186
+ def universe_domain
187
+ @catalog_service_stub.universe_domain
188
+ end
189
+
190
+ ##
191
+ # Create a new CatalogService REST client object.
192
+ #
193
+ # @example
194
+ #
195
+ # # Create a client using the default configuration
196
+ # client = ::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
197
+ #
198
+ # # Create a client using a custom configuration
199
+ # client = ::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new do |config|
200
+ # config.timeout = 10.0
201
+ # end
202
+ #
203
+ # @yield [config] Configure the CatalogService client.
204
+ # @yieldparam config [Client::Configuration]
205
+ #
206
+ def initialize
207
+ # Create the configuration object
208
+ @config = Configuration.new Client.configure
209
+
210
+ # Yield the configuration if needed
211
+ yield @config if block_given?
212
+
213
+ # Create credentials
214
+ credentials = @config.credentials
215
+ # Use self-signed JWT if the endpoint is unchanged from default,
216
+ # but only if the default endpoint does not have a region prefix.
217
+ enable_self_signed_jwt = @config.endpoint.nil? ||
218
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
219
+ !@config.endpoint.split(".").first.include?("-"))
220
+ credentials ||= Credentials.default scope: @config.scope,
221
+ enable_self_signed_jwt: enable_self_signed_jwt
222
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
223
+ credentials = Credentials.new credentials, scope: @config.scope
224
+ end
225
+
226
+ @quota_project_id = @config.quota_project
227
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
228
+
229
+ @operations_client = ::Google::Cloud::Dataplex::V1::CatalogService::Rest::Operations.new do |config|
230
+ config.credentials = credentials
231
+ config.quota_project = @quota_project_id
232
+ config.endpoint = @config.endpoint
233
+ config.universe_domain = @config.universe_domain
234
+ end
235
+
236
+ @catalog_service_stub = ::Google::Cloud::Dataplex::V1::CatalogService::Rest::ServiceStub.new(
237
+ endpoint: @config.endpoint,
238
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
239
+ universe_domain: @config.universe_domain,
240
+ credentials: credentials
241
+ )
242
+
243
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
244
+ config.credentials = credentials
245
+ config.quota_project = @quota_project_id
246
+ config.endpoint = @catalog_service_stub.endpoint
247
+ config.universe_domain = @catalog_service_stub.universe_domain
248
+ config.bindings_override = @config.bindings_override
249
+ end
250
+
251
+ @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
252
+ config.credentials = credentials
253
+ config.quota_project = @quota_project_id
254
+ config.endpoint = @catalog_service_stub.endpoint
255
+ config.universe_domain = @catalog_service_stub.universe_domain
256
+ config.bindings_override = @config.bindings_override
257
+ end
258
+ end
259
+
260
+ ##
261
+ # Get the associated client for long-running operations.
262
+ #
263
+ # @return [::Google::Cloud::Dataplex::V1::CatalogService::Rest::Operations]
264
+ #
265
+ attr_reader :operations_client
266
+
267
+ ##
268
+ # Get the associated client for mix-in of the Locations.
269
+ #
270
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
271
+ #
272
+ attr_reader :location_client
273
+
274
+ ##
275
+ # Get the associated client for mix-in of the IAMPolicy.
276
+ #
277
+ # @return [Google::Iam::V1::IAMPolicy::Rest::Client]
278
+ #
279
+ attr_reader :iam_policy_client
280
+
281
+ # Service calls
282
+
283
+ ##
284
+ # Creates an EntryType
285
+ #
286
+ # @overload create_entry_type(request, options = nil)
287
+ # Pass arguments to `create_entry_type` via a request object, either of type
288
+ # {::Google::Cloud::Dataplex::V1::CreateEntryTypeRequest} or an equivalent Hash.
289
+ #
290
+ # @param request [::Google::Cloud::Dataplex::V1::CreateEntryTypeRequest, ::Hash]
291
+ # A request object representing the call parameters. Required. To specify no
292
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
293
+ # @param options [::Gapic::CallOptions, ::Hash]
294
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
295
+ #
296
+ # @overload create_entry_type(parent: nil, entry_type_id: nil, entry_type: nil, validate_only: nil)
297
+ # Pass arguments to `create_entry_type` via keyword arguments. Note that at
298
+ # least one keyword argument is required. To specify no parameters, or to keep all
299
+ # the default parameter values, pass an empty Hash as a request object (see above).
300
+ #
301
+ # @param parent [::String]
302
+ # Required. The resource name of the EntryType, of the form:
303
+ # projects/\\{project_number}/locations/\\{location_id}
304
+ # where `location_id` refers to a GCP region.
305
+ # @param entry_type_id [::String]
306
+ # Required. EntryType identifier.
307
+ # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
308
+ # Required. EntryType Resource
309
+ # @param validate_only [::Boolean]
310
+ # Optional. Only validate the request, but do not perform mutations.
311
+ # The default is false.
312
+ # @yield [result, operation] Access the result along with the TransportOperation object
313
+ # @yieldparam result [::Gapic::Operation]
314
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
315
+ #
316
+ # @return [::Gapic::Operation]
317
+ #
318
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
319
+ #
320
+ # @example Basic example
321
+ # require "google/cloud/dataplex/v1"
322
+ #
323
+ # # Create a client object. The client can be reused for multiple calls.
324
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
325
+ #
326
+ # # Create a request. To set request fields, pass in keyword arguments.
327
+ # request = Google::Cloud::Dataplex::V1::CreateEntryTypeRequest.new
328
+ #
329
+ # # Call the create_entry_type method.
330
+ # result = client.create_entry_type request
331
+ #
332
+ # # The returned object is of type Gapic::Operation. You can use it to
333
+ # # check the status of an operation, cancel it, or wait for results.
334
+ # # Here is how to wait for a response.
335
+ # result.wait_until_done! timeout: 60
336
+ # if result.response?
337
+ # p result.response
338
+ # else
339
+ # puts "No response received."
340
+ # end
341
+ #
342
+ def create_entry_type request, options = nil
343
+ raise ::ArgumentError, "request must be provided" if request.nil?
344
+
345
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateEntryTypeRequest
346
+
347
+ # Converts hash and nil to an options object
348
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
349
+
350
+ # Customize the options with defaults
351
+ call_metadata = @config.rpcs.create_entry_type.metadata.to_h
352
+
353
+ # Set x-goog-api-client and x-goog-user-project headers
354
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
355
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
356
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
357
+ transports_version_send: [:rest]
358
+
359
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
360
+
361
+ options.apply_defaults timeout: @config.rpcs.create_entry_type.timeout,
362
+ metadata: call_metadata,
363
+ retry_policy: @config.rpcs.create_entry_type.retry_policy
364
+
365
+ options.apply_defaults timeout: @config.timeout,
366
+ metadata: @config.metadata,
367
+ retry_policy: @config.retry_policy
368
+
369
+ @catalog_service_stub.create_entry_type request, options do |result, operation|
370
+ result = ::Gapic::Operation.new result, @operations_client, options: options
371
+ yield result, operation if block_given?
372
+ return result
373
+ end
374
+ rescue ::Gapic::Rest::Error => e
375
+ raise ::Google::Cloud::Error.from_error(e)
376
+ end
377
+
378
+ ##
379
+ # Updates a EntryType resource.
380
+ #
381
+ # @overload update_entry_type(request, options = nil)
382
+ # Pass arguments to `update_entry_type` via a request object, either of type
383
+ # {::Google::Cloud::Dataplex::V1::UpdateEntryTypeRequest} or an equivalent Hash.
384
+ #
385
+ # @param request [::Google::Cloud::Dataplex::V1::UpdateEntryTypeRequest, ::Hash]
386
+ # A request object representing the call parameters. Required. To specify no
387
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
388
+ # @param options [::Gapic::CallOptions, ::Hash]
389
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
390
+ #
391
+ # @overload update_entry_type(entry_type: nil, update_mask: nil, validate_only: nil)
392
+ # Pass arguments to `update_entry_type` via keyword arguments. Note that at
393
+ # least one keyword argument is required. To specify no parameters, or to keep all
394
+ # the default parameter values, pass an empty Hash as a request object (see above).
395
+ #
396
+ # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
397
+ # Required. EntryType Resource
398
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
399
+ # Required. Mask of fields to update.
400
+ # @param validate_only [::Boolean]
401
+ # Optional. Only validate the request, but do not perform mutations.
402
+ # The default is false.
403
+ # @yield [result, operation] Access the result along with the TransportOperation object
404
+ # @yieldparam result [::Gapic::Operation]
405
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
406
+ #
407
+ # @return [::Gapic::Operation]
408
+ #
409
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
410
+ #
411
+ # @example Basic example
412
+ # require "google/cloud/dataplex/v1"
413
+ #
414
+ # # Create a client object. The client can be reused for multiple calls.
415
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
416
+ #
417
+ # # Create a request. To set request fields, pass in keyword arguments.
418
+ # request = Google::Cloud::Dataplex::V1::UpdateEntryTypeRequest.new
419
+ #
420
+ # # Call the update_entry_type method.
421
+ # result = client.update_entry_type request
422
+ #
423
+ # # The returned object is of type Gapic::Operation. You can use it to
424
+ # # check the status of an operation, cancel it, or wait for results.
425
+ # # Here is how to wait for a response.
426
+ # result.wait_until_done! timeout: 60
427
+ # if result.response?
428
+ # p result.response
429
+ # else
430
+ # puts "No response received."
431
+ # end
432
+ #
433
+ def update_entry_type request, options = nil
434
+ raise ::ArgumentError, "request must be provided" if request.nil?
435
+
436
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateEntryTypeRequest
437
+
438
+ # Converts hash and nil to an options object
439
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
440
+
441
+ # Customize the options with defaults
442
+ call_metadata = @config.rpcs.update_entry_type.metadata.to_h
443
+
444
+ # Set x-goog-api-client and x-goog-user-project headers
445
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
446
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
447
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
448
+ transports_version_send: [:rest]
449
+
450
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
451
+
452
+ options.apply_defaults timeout: @config.rpcs.update_entry_type.timeout,
453
+ metadata: call_metadata,
454
+ retry_policy: @config.rpcs.update_entry_type.retry_policy
455
+
456
+ options.apply_defaults timeout: @config.timeout,
457
+ metadata: @config.metadata,
458
+ retry_policy: @config.retry_policy
459
+
460
+ @catalog_service_stub.update_entry_type request, options do |result, operation|
461
+ result = ::Gapic::Operation.new result, @operations_client, options: options
462
+ yield result, operation if block_given?
463
+ return result
464
+ end
465
+ rescue ::Gapic::Rest::Error => e
466
+ raise ::Google::Cloud::Error.from_error(e)
467
+ end
468
+
469
+ ##
470
+ # Deletes a EntryType resource.
471
+ #
472
+ # @overload delete_entry_type(request, options = nil)
473
+ # Pass arguments to `delete_entry_type` via a request object, either of type
474
+ # {::Google::Cloud::Dataplex::V1::DeleteEntryTypeRequest} or an equivalent Hash.
475
+ #
476
+ # @param request [::Google::Cloud::Dataplex::V1::DeleteEntryTypeRequest, ::Hash]
477
+ # A request object representing the call parameters. Required. To specify no
478
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
479
+ # @param options [::Gapic::CallOptions, ::Hash]
480
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
481
+ #
482
+ # @overload delete_entry_type(name: nil, etag: nil)
483
+ # Pass arguments to `delete_entry_type` via keyword arguments. Note that at
484
+ # least one keyword argument is required. To specify no parameters, or to keep all
485
+ # the default parameter values, pass an empty Hash as a request object (see above).
486
+ #
487
+ # @param name [::String]
488
+ # Required. The resource name of the EntryType:
489
+ # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
490
+ # @param etag [::String]
491
+ # Optional. If the client provided etag value does not match the current etag
492
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response
493
+ # @yield [result, operation] Access the result along with the TransportOperation object
494
+ # @yieldparam result [::Gapic::Operation]
495
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
496
+ #
497
+ # @return [::Gapic::Operation]
498
+ #
499
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
500
+ #
501
+ # @example Basic example
502
+ # require "google/cloud/dataplex/v1"
503
+ #
504
+ # # Create a client object. The client can be reused for multiple calls.
505
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
506
+ #
507
+ # # Create a request. To set request fields, pass in keyword arguments.
508
+ # request = Google::Cloud::Dataplex::V1::DeleteEntryTypeRequest.new
509
+ #
510
+ # # Call the delete_entry_type method.
511
+ # result = client.delete_entry_type request
512
+ #
513
+ # # The returned object is of type Gapic::Operation. You can use it to
514
+ # # check the status of an operation, cancel it, or wait for results.
515
+ # # Here is how to wait for a response.
516
+ # result.wait_until_done! timeout: 60
517
+ # if result.response?
518
+ # p result.response
519
+ # else
520
+ # puts "No response received."
521
+ # end
522
+ #
523
+ def delete_entry_type request, options = nil
524
+ raise ::ArgumentError, "request must be provided" if request.nil?
525
+
526
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteEntryTypeRequest
527
+
528
+ # Converts hash and nil to an options object
529
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
530
+
531
+ # Customize the options with defaults
532
+ call_metadata = @config.rpcs.delete_entry_type.metadata.to_h
533
+
534
+ # Set x-goog-api-client and x-goog-user-project headers
535
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
536
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
537
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
538
+ transports_version_send: [:rest]
539
+
540
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
541
+
542
+ options.apply_defaults timeout: @config.rpcs.delete_entry_type.timeout,
543
+ metadata: call_metadata,
544
+ retry_policy: @config.rpcs.delete_entry_type.retry_policy
545
+
546
+ options.apply_defaults timeout: @config.timeout,
547
+ metadata: @config.metadata,
548
+ retry_policy: @config.retry_policy
549
+
550
+ @catalog_service_stub.delete_entry_type request, options do |result, operation|
551
+ result = ::Gapic::Operation.new result, @operations_client, options: options
552
+ yield result, operation if block_given?
553
+ return result
554
+ end
555
+ rescue ::Gapic::Rest::Error => e
556
+ raise ::Google::Cloud::Error.from_error(e)
557
+ end
558
+
559
+ ##
560
+ # Lists EntryType resources in a project and location.
561
+ #
562
+ # @overload list_entry_types(request, options = nil)
563
+ # Pass arguments to `list_entry_types` via a request object, either of type
564
+ # {::Google::Cloud::Dataplex::V1::ListEntryTypesRequest} or an equivalent Hash.
565
+ #
566
+ # @param request [::Google::Cloud::Dataplex::V1::ListEntryTypesRequest, ::Hash]
567
+ # A request object representing the call parameters. Required. To specify no
568
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
569
+ # @param options [::Gapic::CallOptions, ::Hash]
570
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
571
+ #
572
+ # @overload list_entry_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
573
+ # Pass arguments to `list_entry_types` via keyword arguments. Note that at
574
+ # least one keyword argument is required. To specify no parameters, or to keep all
575
+ # the default parameter values, pass an empty Hash as a request object (see above).
576
+ #
577
+ # @param parent [::String]
578
+ # Required. The resource name of the EntryType location, of the form:
579
+ # `projects/{project_number}/locations/{location_id}`
580
+ # where `location_id` refers to a GCP region.
581
+ # @param page_size [::Integer]
582
+ # Optional. Maximum number of EntryTypes to return. The service may return
583
+ # fewer than this value. If unspecified, at most 10 EntryTypes will be
584
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
585
+ # 1000.
586
+ # @param page_token [::String]
587
+ # Optional. Page token received from a previous `ListEntryTypes` call.
588
+ # Provide this to retrieve the subsequent page. When paginating, all other
589
+ # parameters provided to `ListEntryTypes` must match the call that provided
590
+ # the page token.
591
+ # @param filter [::String]
592
+ # Optional. Filter request. Filters are case-sensitive.
593
+ # The following formats are supported:
594
+ #
595
+ # labels.key1 = "value1"
596
+ # labels:key1
597
+ # name = "value"
598
+ # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
599
+ # @param order_by [::String]
600
+ # Optional. Order by fields (`name` or `create_time`) for the result.
601
+ # If not specified, the ordering is undefined.
602
+ # @yield [result, operation] Access the result along with the TransportOperation object
603
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::ListEntryTypesResponse]
604
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
605
+ #
606
+ # @return [::Google::Cloud::Dataplex::V1::ListEntryTypesResponse]
607
+ #
608
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
609
+ #
610
+ # @example Basic example
611
+ # require "google/cloud/dataplex/v1"
612
+ #
613
+ # # Create a client object. The client can be reused for multiple calls.
614
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
615
+ #
616
+ # # Create a request. To set request fields, pass in keyword arguments.
617
+ # request = Google::Cloud::Dataplex::V1::ListEntryTypesRequest.new
618
+ #
619
+ # # Call the list_entry_types method.
620
+ # result = client.list_entry_types request
621
+ #
622
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
623
+ # # over elements, and API calls will be issued to fetch pages as needed.
624
+ # result.each do |item|
625
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::EntryType.
626
+ # p item
627
+ # end
628
+ #
629
+ def list_entry_types request, options = nil
630
+ raise ::ArgumentError, "request must be provided" if request.nil?
631
+
632
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListEntryTypesRequest
633
+
634
+ # Converts hash and nil to an options object
635
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
636
+
637
+ # Customize the options with defaults
638
+ call_metadata = @config.rpcs.list_entry_types.metadata.to_h
639
+
640
+ # Set x-goog-api-client and x-goog-user-project headers
641
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
642
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
643
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
644
+ transports_version_send: [:rest]
645
+
646
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
647
+
648
+ options.apply_defaults timeout: @config.rpcs.list_entry_types.timeout,
649
+ metadata: call_metadata,
650
+ retry_policy: @config.rpcs.list_entry_types.retry_policy
651
+
652
+ options.apply_defaults timeout: @config.timeout,
653
+ metadata: @config.metadata,
654
+ retry_policy: @config.retry_policy
655
+
656
+ @catalog_service_stub.list_entry_types request, options do |result, operation|
657
+ yield result, operation if block_given?
658
+ return result
659
+ end
660
+ rescue ::Gapic::Rest::Error => e
661
+ raise ::Google::Cloud::Error.from_error(e)
662
+ end
663
+
664
+ ##
665
+ # Retrieves a EntryType resource.
666
+ #
667
+ # @overload get_entry_type(request, options = nil)
668
+ # Pass arguments to `get_entry_type` via a request object, either of type
669
+ # {::Google::Cloud::Dataplex::V1::GetEntryTypeRequest} or an equivalent Hash.
670
+ #
671
+ # @param request [::Google::Cloud::Dataplex::V1::GetEntryTypeRequest, ::Hash]
672
+ # A request object representing the call parameters. Required. To specify no
673
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
674
+ # @param options [::Gapic::CallOptions, ::Hash]
675
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
676
+ #
677
+ # @overload get_entry_type(name: nil)
678
+ # Pass arguments to `get_entry_type` via keyword arguments. Note that at
679
+ # least one keyword argument is required. To specify no parameters, or to keep all
680
+ # the default parameter values, pass an empty Hash as a request object (see above).
681
+ #
682
+ # @param name [::String]
683
+ # Required. The resource name of the EntryType:
684
+ # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
685
+ # @yield [result, operation] Access the result along with the TransportOperation object
686
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::EntryType]
687
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
688
+ #
689
+ # @return [::Google::Cloud::Dataplex::V1::EntryType]
690
+ #
691
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
692
+ #
693
+ # @example Basic example
694
+ # require "google/cloud/dataplex/v1"
695
+ #
696
+ # # Create a client object. The client can be reused for multiple calls.
697
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
698
+ #
699
+ # # Create a request. To set request fields, pass in keyword arguments.
700
+ # request = Google::Cloud::Dataplex::V1::GetEntryTypeRequest.new
701
+ #
702
+ # # Call the get_entry_type method.
703
+ # result = client.get_entry_type request
704
+ #
705
+ # # The returned object is of type Google::Cloud::Dataplex::V1::EntryType.
706
+ # p result
707
+ #
708
+ def get_entry_type request, options = nil
709
+ raise ::ArgumentError, "request must be provided" if request.nil?
710
+
711
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetEntryTypeRequest
712
+
713
+ # Converts hash and nil to an options object
714
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
715
+
716
+ # Customize the options with defaults
717
+ call_metadata = @config.rpcs.get_entry_type.metadata.to_h
718
+
719
+ # Set x-goog-api-client and x-goog-user-project headers
720
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
721
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
722
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
723
+ transports_version_send: [:rest]
724
+
725
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
726
+
727
+ options.apply_defaults timeout: @config.rpcs.get_entry_type.timeout,
728
+ metadata: call_metadata,
729
+ retry_policy: @config.rpcs.get_entry_type.retry_policy
730
+
731
+ options.apply_defaults timeout: @config.timeout,
732
+ metadata: @config.metadata,
733
+ retry_policy: @config.retry_policy
734
+
735
+ @catalog_service_stub.get_entry_type request, options do |result, operation|
736
+ yield result, operation if block_given?
737
+ return result
738
+ end
739
+ rescue ::Gapic::Rest::Error => e
740
+ raise ::Google::Cloud::Error.from_error(e)
741
+ end
742
+
743
+ ##
744
+ # Creates an AspectType
745
+ #
746
+ # @overload create_aspect_type(request, options = nil)
747
+ # Pass arguments to `create_aspect_type` via a request object, either of type
748
+ # {::Google::Cloud::Dataplex::V1::CreateAspectTypeRequest} or an equivalent Hash.
749
+ #
750
+ # @param request [::Google::Cloud::Dataplex::V1::CreateAspectTypeRequest, ::Hash]
751
+ # A request object representing the call parameters. Required. To specify no
752
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
753
+ # @param options [::Gapic::CallOptions, ::Hash]
754
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
755
+ #
756
+ # @overload create_aspect_type(parent: nil, aspect_type_id: nil, aspect_type: nil, validate_only: nil)
757
+ # Pass arguments to `create_aspect_type` via keyword arguments. Note that at
758
+ # least one keyword argument is required. To specify no parameters, or to keep all
759
+ # the default parameter values, pass an empty Hash as a request object (see above).
760
+ #
761
+ # @param parent [::String]
762
+ # Required. The resource name of the AspectType, of the form:
763
+ # projects/\\{project_number}/locations/\\{location_id}
764
+ # where `location_id` refers to a GCP region.
765
+ # @param aspect_type_id [::String]
766
+ # Required. AspectType identifier.
767
+ # @param aspect_type [::Google::Cloud::Dataplex::V1::AspectType, ::Hash]
768
+ # Required. AspectType Resource
769
+ # @param validate_only [::Boolean]
770
+ # Optional. Only validate the request, but do not perform mutations.
771
+ # The default is false.
772
+ # @yield [result, operation] Access the result along with the TransportOperation object
773
+ # @yieldparam result [::Gapic::Operation]
774
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
775
+ #
776
+ # @return [::Gapic::Operation]
777
+ #
778
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
779
+ #
780
+ # @example Basic example
781
+ # require "google/cloud/dataplex/v1"
782
+ #
783
+ # # Create a client object. The client can be reused for multiple calls.
784
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
785
+ #
786
+ # # Create a request. To set request fields, pass in keyword arguments.
787
+ # request = Google::Cloud::Dataplex::V1::CreateAspectTypeRequest.new
788
+ #
789
+ # # Call the create_aspect_type method.
790
+ # result = client.create_aspect_type request
791
+ #
792
+ # # The returned object is of type Gapic::Operation. You can use it to
793
+ # # check the status of an operation, cancel it, or wait for results.
794
+ # # Here is how to wait for a response.
795
+ # result.wait_until_done! timeout: 60
796
+ # if result.response?
797
+ # p result.response
798
+ # else
799
+ # puts "No response received."
800
+ # end
801
+ #
802
+ def create_aspect_type request, options = nil
803
+ raise ::ArgumentError, "request must be provided" if request.nil?
804
+
805
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateAspectTypeRequest
806
+
807
+ # Converts hash and nil to an options object
808
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
809
+
810
+ # Customize the options with defaults
811
+ call_metadata = @config.rpcs.create_aspect_type.metadata.to_h
812
+
813
+ # Set x-goog-api-client and x-goog-user-project headers
814
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
815
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
816
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
817
+ transports_version_send: [:rest]
818
+
819
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
820
+
821
+ options.apply_defaults timeout: @config.rpcs.create_aspect_type.timeout,
822
+ metadata: call_metadata,
823
+ retry_policy: @config.rpcs.create_aspect_type.retry_policy
824
+
825
+ options.apply_defaults timeout: @config.timeout,
826
+ metadata: @config.metadata,
827
+ retry_policy: @config.retry_policy
828
+
829
+ @catalog_service_stub.create_aspect_type request, options do |result, operation|
830
+ result = ::Gapic::Operation.new result, @operations_client, options: options
831
+ yield result, operation if block_given?
832
+ return result
833
+ end
834
+ rescue ::Gapic::Rest::Error => e
835
+ raise ::Google::Cloud::Error.from_error(e)
836
+ end
837
+
838
+ ##
839
+ # Updates a AspectType resource.
840
+ #
841
+ # @overload update_aspect_type(request, options = nil)
842
+ # Pass arguments to `update_aspect_type` via a request object, either of type
843
+ # {::Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest} or an equivalent Hash.
844
+ #
845
+ # @param request [::Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest, ::Hash]
846
+ # A request object representing the call parameters. Required. To specify no
847
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
848
+ # @param options [::Gapic::CallOptions, ::Hash]
849
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
850
+ #
851
+ # @overload update_aspect_type(aspect_type: nil, update_mask: nil, validate_only: nil)
852
+ # Pass arguments to `update_aspect_type` via keyword arguments. Note that at
853
+ # least one keyword argument is required. To specify no parameters, or to keep all
854
+ # the default parameter values, pass an empty Hash as a request object (see above).
855
+ #
856
+ # @param aspect_type [::Google::Cloud::Dataplex::V1::AspectType, ::Hash]
857
+ # Required. AspectType Resource
858
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
859
+ # Required. Mask of fields to update.
860
+ # @param validate_only [::Boolean]
861
+ # Optional. Only validate the request, but do not perform mutations.
862
+ # The default is false.
863
+ # @yield [result, operation] Access the result along with the TransportOperation object
864
+ # @yieldparam result [::Gapic::Operation]
865
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
866
+ #
867
+ # @return [::Gapic::Operation]
868
+ #
869
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
870
+ #
871
+ # @example Basic example
872
+ # require "google/cloud/dataplex/v1"
873
+ #
874
+ # # Create a client object. The client can be reused for multiple calls.
875
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
876
+ #
877
+ # # Create a request. To set request fields, pass in keyword arguments.
878
+ # request = Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest.new
879
+ #
880
+ # # Call the update_aspect_type method.
881
+ # result = client.update_aspect_type request
882
+ #
883
+ # # The returned object is of type Gapic::Operation. You can use it to
884
+ # # check the status of an operation, cancel it, or wait for results.
885
+ # # Here is how to wait for a response.
886
+ # result.wait_until_done! timeout: 60
887
+ # if result.response?
888
+ # p result.response
889
+ # else
890
+ # puts "No response received."
891
+ # end
892
+ #
893
+ def update_aspect_type request, options = nil
894
+ raise ::ArgumentError, "request must be provided" if request.nil?
895
+
896
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest
897
+
898
+ # Converts hash and nil to an options object
899
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
900
+
901
+ # Customize the options with defaults
902
+ call_metadata = @config.rpcs.update_aspect_type.metadata.to_h
903
+
904
+ # Set x-goog-api-client and x-goog-user-project headers
905
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
906
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
907
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
908
+ transports_version_send: [:rest]
909
+
910
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
911
+
912
+ options.apply_defaults timeout: @config.rpcs.update_aspect_type.timeout,
913
+ metadata: call_metadata,
914
+ retry_policy: @config.rpcs.update_aspect_type.retry_policy
915
+
916
+ options.apply_defaults timeout: @config.timeout,
917
+ metadata: @config.metadata,
918
+ retry_policy: @config.retry_policy
919
+
920
+ @catalog_service_stub.update_aspect_type request, options do |result, operation|
921
+ result = ::Gapic::Operation.new result, @operations_client, options: options
922
+ yield result, operation if block_given?
923
+ return result
924
+ end
925
+ rescue ::Gapic::Rest::Error => e
926
+ raise ::Google::Cloud::Error.from_error(e)
927
+ end
928
+
929
+ ##
930
+ # Deletes a AspectType resource.
931
+ #
932
+ # @overload delete_aspect_type(request, options = nil)
933
+ # Pass arguments to `delete_aspect_type` via a request object, either of type
934
+ # {::Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest} or an equivalent Hash.
935
+ #
936
+ # @param request [::Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest, ::Hash]
937
+ # A request object representing the call parameters. Required. To specify no
938
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
939
+ # @param options [::Gapic::CallOptions, ::Hash]
940
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
941
+ #
942
+ # @overload delete_aspect_type(name: nil, etag: nil)
943
+ # Pass arguments to `delete_aspect_type` via keyword arguments. Note that at
944
+ # least one keyword argument is required. To specify no parameters, or to keep all
945
+ # the default parameter values, pass an empty Hash as a request object (see above).
946
+ #
947
+ # @param name [::String]
948
+ # Required. The resource name of the AspectType:
949
+ # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
950
+ # @param etag [::String]
951
+ # Optional. If the client provided etag value does not match the current etag
952
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error response
953
+ # @yield [result, operation] Access the result along with the TransportOperation object
954
+ # @yieldparam result [::Gapic::Operation]
955
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
956
+ #
957
+ # @return [::Gapic::Operation]
958
+ #
959
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
960
+ #
961
+ # @example Basic example
962
+ # require "google/cloud/dataplex/v1"
963
+ #
964
+ # # Create a client object. The client can be reused for multiple calls.
965
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
966
+ #
967
+ # # Create a request. To set request fields, pass in keyword arguments.
968
+ # request = Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest.new
969
+ #
970
+ # # Call the delete_aspect_type method.
971
+ # result = client.delete_aspect_type request
972
+ #
973
+ # # The returned object is of type Gapic::Operation. You can use it to
974
+ # # check the status of an operation, cancel it, or wait for results.
975
+ # # Here is how to wait for a response.
976
+ # result.wait_until_done! timeout: 60
977
+ # if result.response?
978
+ # p result.response
979
+ # else
980
+ # puts "No response received."
981
+ # end
982
+ #
983
+ def delete_aspect_type request, options = nil
984
+ raise ::ArgumentError, "request must be provided" if request.nil?
985
+
986
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest
987
+
988
+ # Converts hash and nil to an options object
989
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
990
+
991
+ # Customize the options with defaults
992
+ call_metadata = @config.rpcs.delete_aspect_type.metadata.to_h
993
+
994
+ # Set x-goog-api-client and x-goog-user-project headers
995
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
996
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
997
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
998
+ transports_version_send: [:rest]
999
+
1000
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1001
+
1002
+ options.apply_defaults timeout: @config.rpcs.delete_aspect_type.timeout,
1003
+ metadata: call_metadata,
1004
+ retry_policy: @config.rpcs.delete_aspect_type.retry_policy
1005
+
1006
+ options.apply_defaults timeout: @config.timeout,
1007
+ metadata: @config.metadata,
1008
+ retry_policy: @config.retry_policy
1009
+
1010
+ @catalog_service_stub.delete_aspect_type request, options do |result, operation|
1011
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1012
+ yield result, operation if block_given?
1013
+ return result
1014
+ end
1015
+ rescue ::Gapic::Rest::Error => e
1016
+ raise ::Google::Cloud::Error.from_error(e)
1017
+ end
1018
+
1019
+ ##
1020
+ # Lists AspectType resources in a project and location.
1021
+ #
1022
+ # @overload list_aspect_types(request, options = nil)
1023
+ # Pass arguments to `list_aspect_types` via a request object, either of type
1024
+ # {::Google::Cloud::Dataplex::V1::ListAspectTypesRequest} or an equivalent Hash.
1025
+ #
1026
+ # @param request [::Google::Cloud::Dataplex::V1::ListAspectTypesRequest, ::Hash]
1027
+ # A request object representing the call parameters. Required. To specify no
1028
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1029
+ # @param options [::Gapic::CallOptions, ::Hash]
1030
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1031
+ #
1032
+ # @overload list_aspect_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
1033
+ # Pass arguments to `list_aspect_types` via keyword arguments. Note that at
1034
+ # least one keyword argument is required. To specify no parameters, or to keep all
1035
+ # the default parameter values, pass an empty Hash as a request object (see above).
1036
+ #
1037
+ # @param parent [::String]
1038
+ # Required. The resource name of the AspectType location, of the form:
1039
+ # `projects/{project_number}/locations/{location_id}`
1040
+ # where `location_id` refers to a GCP region.
1041
+ # @param page_size [::Integer]
1042
+ # Optional. Maximum number of AspectTypes to return. The service may return
1043
+ # fewer than this value. If unspecified, at most 10 AspectTypes will be
1044
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
1045
+ # 1000.
1046
+ # @param page_token [::String]
1047
+ # Optional. Page token received from a previous `ListAspectTypes` call.
1048
+ # Provide this to retrieve the subsequent page. When paginating, all other
1049
+ # parameters provided to `ListAspectTypes` must match the call that provided
1050
+ # the page token.
1051
+ # @param filter [::String]
1052
+ # Optional. Filter request. Filters are case-sensitive.
1053
+ # The following formats are supported:
1054
+ #
1055
+ # labels.key1 = "value1"
1056
+ # labels:key1
1057
+ # name = "value"
1058
+ # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
1059
+ # @param order_by [::String]
1060
+ # Optional. Order by fields (`name` or `create_time`) for the result.
1061
+ # If not specified, the ordering is undefined.
1062
+ # @yield [result, operation] Access the result along with the TransportOperation object
1063
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::ListAspectTypesResponse]
1064
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1065
+ #
1066
+ # @return [::Google::Cloud::Dataplex::V1::ListAspectTypesResponse]
1067
+ #
1068
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1069
+ #
1070
+ # @example Basic example
1071
+ # require "google/cloud/dataplex/v1"
1072
+ #
1073
+ # # Create a client object. The client can be reused for multiple calls.
1074
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1075
+ #
1076
+ # # Create a request. To set request fields, pass in keyword arguments.
1077
+ # request = Google::Cloud::Dataplex::V1::ListAspectTypesRequest.new
1078
+ #
1079
+ # # Call the list_aspect_types method.
1080
+ # result = client.list_aspect_types request
1081
+ #
1082
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1083
+ # # over elements, and API calls will be issued to fetch pages as needed.
1084
+ # result.each do |item|
1085
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::AspectType.
1086
+ # p item
1087
+ # end
1088
+ #
1089
+ def list_aspect_types request, options = nil
1090
+ raise ::ArgumentError, "request must be provided" if request.nil?
1091
+
1092
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListAspectTypesRequest
1093
+
1094
+ # Converts hash and nil to an options object
1095
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1096
+
1097
+ # Customize the options with defaults
1098
+ call_metadata = @config.rpcs.list_aspect_types.metadata.to_h
1099
+
1100
+ # Set x-goog-api-client and x-goog-user-project headers
1101
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1102
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1103
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1104
+ transports_version_send: [:rest]
1105
+
1106
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1107
+
1108
+ options.apply_defaults timeout: @config.rpcs.list_aspect_types.timeout,
1109
+ metadata: call_metadata,
1110
+ retry_policy: @config.rpcs.list_aspect_types.retry_policy
1111
+
1112
+ options.apply_defaults timeout: @config.timeout,
1113
+ metadata: @config.metadata,
1114
+ retry_policy: @config.retry_policy
1115
+
1116
+ @catalog_service_stub.list_aspect_types request, options do |result, operation|
1117
+ yield result, operation if block_given?
1118
+ return result
1119
+ end
1120
+ rescue ::Gapic::Rest::Error => e
1121
+ raise ::Google::Cloud::Error.from_error(e)
1122
+ end
1123
+
1124
+ ##
1125
+ # Retrieves a AspectType resource.
1126
+ #
1127
+ # @overload get_aspect_type(request, options = nil)
1128
+ # Pass arguments to `get_aspect_type` via a request object, either of type
1129
+ # {::Google::Cloud::Dataplex::V1::GetAspectTypeRequest} or an equivalent Hash.
1130
+ #
1131
+ # @param request [::Google::Cloud::Dataplex::V1::GetAspectTypeRequest, ::Hash]
1132
+ # A request object representing the call parameters. Required. To specify no
1133
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1134
+ # @param options [::Gapic::CallOptions, ::Hash]
1135
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1136
+ #
1137
+ # @overload get_aspect_type(name: nil)
1138
+ # Pass arguments to `get_aspect_type` via keyword arguments. Note that at
1139
+ # least one keyword argument is required. To specify no parameters, or to keep all
1140
+ # the default parameter values, pass an empty Hash as a request object (see above).
1141
+ #
1142
+ # @param name [::String]
1143
+ # Required. The resource name of the AspectType:
1144
+ # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
1145
+ # @yield [result, operation] Access the result along with the TransportOperation object
1146
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::AspectType]
1147
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1148
+ #
1149
+ # @return [::Google::Cloud::Dataplex::V1::AspectType]
1150
+ #
1151
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1152
+ #
1153
+ # @example Basic example
1154
+ # require "google/cloud/dataplex/v1"
1155
+ #
1156
+ # # Create a client object. The client can be reused for multiple calls.
1157
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1158
+ #
1159
+ # # Create a request. To set request fields, pass in keyword arguments.
1160
+ # request = Google::Cloud::Dataplex::V1::GetAspectTypeRequest.new
1161
+ #
1162
+ # # Call the get_aspect_type method.
1163
+ # result = client.get_aspect_type request
1164
+ #
1165
+ # # The returned object is of type Google::Cloud::Dataplex::V1::AspectType.
1166
+ # p result
1167
+ #
1168
+ def get_aspect_type request, options = nil
1169
+ raise ::ArgumentError, "request must be provided" if request.nil?
1170
+
1171
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetAspectTypeRequest
1172
+
1173
+ # Converts hash and nil to an options object
1174
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1175
+
1176
+ # Customize the options with defaults
1177
+ call_metadata = @config.rpcs.get_aspect_type.metadata.to_h
1178
+
1179
+ # Set x-goog-api-client and x-goog-user-project headers
1180
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1181
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1182
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1183
+ transports_version_send: [:rest]
1184
+
1185
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1186
+
1187
+ options.apply_defaults timeout: @config.rpcs.get_aspect_type.timeout,
1188
+ metadata: call_metadata,
1189
+ retry_policy: @config.rpcs.get_aspect_type.retry_policy
1190
+
1191
+ options.apply_defaults timeout: @config.timeout,
1192
+ metadata: @config.metadata,
1193
+ retry_policy: @config.retry_policy
1194
+
1195
+ @catalog_service_stub.get_aspect_type request, options do |result, operation|
1196
+ yield result, operation if block_given?
1197
+ return result
1198
+ end
1199
+ rescue ::Gapic::Rest::Error => e
1200
+ raise ::Google::Cloud::Error.from_error(e)
1201
+ end
1202
+
1203
+ ##
1204
+ # Creates an EntryGroup
1205
+ #
1206
+ # @overload create_entry_group(request, options = nil)
1207
+ # Pass arguments to `create_entry_group` via a request object, either of type
1208
+ # {::Google::Cloud::Dataplex::V1::CreateEntryGroupRequest} or an equivalent Hash.
1209
+ #
1210
+ # @param request [::Google::Cloud::Dataplex::V1::CreateEntryGroupRequest, ::Hash]
1211
+ # A request object representing the call parameters. Required. To specify no
1212
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1213
+ # @param options [::Gapic::CallOptions, ::Hash]
1214
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1215
+ #
1216
+ # @overload create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil, validate_only: nil)
1217
+ # Pass arguments to `create_entry_group` via keyword arguments. Note that at
1218
+ # least one keyword argument is required. To specify no parameters, or to keep all
1219
+ # the default parameter values, pass an empty Hash as a request object (see above).
1220
+ #
1221
+ # @param parent [::String]
1222
+ # Required. The resource name of the entryGroup, of the form:
1223
+ # projects/\\{project_number}/locations/\\{location_id}
1224
+ # where `location_id` refers to a GCP region.
1225
+ # @param entry_group_id [::String]
1226
+ # Required. EntryGroup identifier.
1227
+ # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1228
+ # Required. EntryGroup Resource
1229
+ # @param validate_only [::Boolean]
1230
+ # Optional. Only validate the request, but do not perform mutations.
1231
+ # The default is false.
1232
+ # @yield [result, operation] Access the result along with the TransportOperation object
1233
+ # @yieldparam result [::Gapic::Operation]
1234
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1235
+ #
1236
+ # @return [::Gapic::Operation]
1237
+ #
1238
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1239
+ #
1240
+ # @example Basic example
1241
+ # require "google/cloud/dataplex/v1"
1242
+ #
1243
+ # # Create a client object. The client can be reused for multiple calls.
1244
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1245
+ #
1246
+ # # Create a request. To set request fields, pass in keyword arguments.
1247
+ # request = Google::Cloud::Dataplex::V1::CreateEntryGroupRequest.new
1248
+ #
1249
+ # # Call the create_entry_group method.
1250
+ # result = client.create_entry_group request
1251
+ #
1252
+ # # The returned object is of type Gapic::Operation. You can use it to
1253
+ # # check the status of an operation, cancel it, or wait for results.
1254
+ # # Here is how to wait for a response.
1255
+ # result.wait_until_done! timeout: 60
1256
+ # if result.response?
1257
+ # p result.response
1258
+ # else
1259
+ # puts "No response received."
1260
+ # end
1261
+ #
1262
+ def create_entry_group request, options = nil
1263
+ raise ::ArgumentError, "request must be provided" if request.nil?
1264
+
1265
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateEntryGroupRequest
1266
+
1267
+ # Converts hash and nil to an options object
1268
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1269
+
1270
+ # Customize the options with defaults
1271
+ call_metadata = @config.rpcs.create_entry_group.metadata.to_h
1272
+
1273
+ # Set x-goog-api-client and x-goog-user-project headers
1274
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1275
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1276
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1277
+ transports_version_send: [:rest]
1278
+
1279
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1280
+
1281
+ options.apply_defaults timeout: @config.rpcs.create_entry_group.timeout,
1282
+ metadata: call_metadata,
1283
+ retry_policy: @config.rpcs.create_entry_group.retry_policy
1284
+
1285
+ options.apply_defaults timeout: @config.timeout,
1286
+ metadata: @config.metadata,
1287
+ retry_policy: @config.retry_policy
1288
+
1289
+ @catalog_service_stub.create_entry_group request, options do |result, operation|
1290
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1291
+ yield result, operation if block_given?
1292
+ return result
1293
+ end
1294
+ rescue ::Gapic::Rest::Error => e
1295
+ raise ::Google::Cloud::Error.from_error(e)
1296
+ end
1297
+
1298
+ ##
1299
+ # Updates a EntryGroup resource.
1300
+ #
1301
+ # @overload update_entry_group(request, options = nil)
1302
+ # Pass arguments to `update_entry_group` via a request object, either of type
1303
+ # {::Google::Cloud::Dataplex::V1::UpdateEntryGroupRequest} or an equivalent Hash.
1304
+ #
1305
+ # @param request [::Google::Cloud::Dataplex::V1::UpdateEntryGroupRequest, ::Hash]
1306
+ # A request object representing the call parameters. Required. To specify no
1307
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1308
+ # @param options [::Gapic::CallOptions, ::Hash]
1309
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1310
+ #
1311
+ # @overload update_entry_group(entry_group: nil, update_mask: nil, validate_only: nil)
1312
+ # Pass arguments to `update_entry_group` via keyword arguments. Note that at
1313
+ # least one keyword argument is required. To specify no parameters, or to keep all
1314
+ # the default parameter values, pass an empty Hash as a request object (see above).
1315
+ #
1316
+ # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1317
+ # Required. EntryGroup Resource
1318
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1319
+ # Required. Mask of fields to update.
1320
+ # @param validate_only [::Boolean]
1321
+ # Optional. Only validate the request, but do not perform mutations.
1322
+ # The default is false.
1323
+ # @yield [result, operation] Access the result along with the TransportOperation object
1324
+ # @yieldparam result [::Gapic::Operation]
1325
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1326
+ #
1327
+ # @return [::Gapic::Operation]
1328
+ #
1329
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1330
+ #
1331
+ # @example Basic example
1332
+ # require "google/cloud/dataplex/v1"
1333
+ #
1334
+ # # Create a client object. The client can be reused for multiple calls.
1335
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1336
+ #
1337
+ # # Create a request. To set request fields, pass in keyword arguments.
1338
+ # request = Google::Cloud::Dataplex::V1::UpdateEntryGroupRequest.new
1339
+ #
1340
+ # # Call the update_entry_group method.
1341
+ # result = client.update_entry_group request
1342
+ #
1343
+ # # The returned object is of type Gapic::Operation. You can use it to
1344
+ # # check the status of an operation, cancel it, or wait for results.
1345
+ # # Here is how to wait for a response.
1346
+ # result.wait_until_done! timeout: 60
1347
+ # if result.response?
1348
+ # p result.response
1349
+ # else
1350
+ # puts "No response received."
1351
+ # end
1352
+ #
1353
+ def update_entry_group request, options = nil
1354
+ raise ::ArgumentError, "request must be provided" if request.nil?
1355
+
1356
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateEntryGroupRequest
1357
+
1358
+ # Converts hash and nil to an options object
1359
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1360
+
1361
+ # Customize the options with defaults
1362
+ call_metadata = @config.rpcs.update_entry_group.metadata.to_h
1363
+
1364
+ # Set x-goog-api-client and x-goog-user-project headers
1365
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1366
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1367
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1368
+ transports_version_send: [:rest]
1369
+
1370
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1371
+
1372
+ options.apply_defaults timeout: @config.rpcs.update_entry_group.timeout,
1373
+ metadata: call_metadata,
1374
+ retry_policy: @config.rpcs.update_entry_group.retry_policy
1375
+
1376
+ options.apply_defaults timeout: @config.timeout,
1377
+ metadata: @config.metadata,
1378
+ retry_policy: @config.retry_policy
1379
+
1380
+ @catalog_service_stub.update_entry_group request, options do |result, operation|
1381
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1382
+ yield result, operation if block_given?
1383
+ return result
1384
+ end
1385
+ rescue ::Gapic::Rest::Error => e
1386
+ raise ::Google::Cloud::Error.from_error(e)
1387
+ end
1388
+
1389
+ ##
1390
+ # Deletes a EntryGroup resource.
1391
+ #
1392
+ # @overload delete_entry_group(request, options = nil)
1393
+ # Pass arguments to `delete_entry_group` via a request object, either of type
1394
+ # {::Google::Cloud::Dataplex::V1::DeleteEntryGroupRequest} or an equivalent Hash.
1395
+ #
1396
+ # @param request [::Google::Cloud::Dataplex::V1::DeleteEntryGroupRequest, ::Hash]
1397
+ # A request object representing the call parameters. Required. To specify no
1398
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1399
+ # @param options [::Gapic::CallOptions, ::Hash]
1400
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1401
+ #
1402
+ # @overload delete_entry_group(name: nil, etag: nil)
1403
+ # Pass arguments to `delete_entry_group` via keyword arguments. Note that at
1404
+ # least one keyword argument is required. To specify no parameters, or to keep all
1405
+ # the default parameter values, pass an empty Hash as a request object (see above).
1406
+ #
1407
+ # @param name [::String]
1408
+ # Required. The resource name of the EntryGroup:
1409
+ # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
1410
+ # @param etag [::String]
1411
+ # Optional. If the client provided etag value does not match the current etag
1412
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error response
1413
+ # @yield [result, operation] Access the result along with the TransportOperation object
1414
+ # @yieldparam result [::Gapic::Operation]
1415
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1416
+ #
1417
+ # @return [::Gapic::Operation]
1418
+ #
1419
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1420
+ #
1421
+ # @example Basic example
1422
+ # require "google/cloud/dataplex/v1"
1423
+ #
1424
+ # # Create a client object. The client can be reused for multiple calls.
1425
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1426
+ #
1427
+ # # Create a request. To set request fields, pass in keyword arguments.
1428
+ # request = Google::Cloud::Dataplex::V1::DeleteEntryGroupRequest.new
1429
+ #
1430
+ # # Call the delete_entry_group method.
1431
+ # result = client.delete_entry_group request
1432
+ #
1433
+ # # The returned object is of type Gapic::Operation. You can use it to
1434
+ # # check the status of an operation, cancel it, or wait for results.
1435
+ # # Here is how to wait for a response.
1436
+ # result.wait_until_done! timeout: 60
1437
+ # if result.response?
1438
+ # p result.response
1439
+ # else
1440
+ # puts "No response received."
1441
+ # end
1442
+ #
1443
+ def delete_entry_group request, options = nil
1444
+ raise ::ArgumentError, "request must be provided" if request.nil?
1445
+
1446
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteEntryGroupRequest
1447
+
1448
+ # Converts hash and nil to an options object
1449
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1450
+
1451
+ # Customize the options with defaults
1452
+ call_metadata = @config.rpcs.delete_entry_group.metadata.to_h
1453
+
1454
+ # Set x-goog-api-client and x-goog-user-project headers
1455
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1456
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1457
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1458
+ transports_version_send: [:rest]
1459
+
1460
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1461
+
1462
+ options.apply_defaults timeout: @config.rpcs.delete_entry_group.timeout,
1463
+ metadata: call_metadata,
1464
+ retry_policy: @config.rpcs.delete_entry_group.retry_policy
1465
+
1466
+ options.apply_defaults timeout: @config.timeout,
1467
+ metadata: @config.metadata,
1468
+ retry_policy: @config.retry_policy
1469
+
1470
+ @catalog_service_stub.delete_entry_group request, options do |result, operation|
1471
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1472
+ yield result, operation if block_given?
1473
+ return result
1474
+ end
1475
+ rescue ::Gapic::Rest::Error => e
1476
+ raise ::Google::Cloud::Error.from_error(e)
1477
+ end
1478
+
1479
+ ##
1480
+ # Lists EntryGroup resources in a project and location.
1481
+ #
1482
+ # @overload list_entry_groups(request, options = nil)
1483
+ # Pass arguments to `list_entry_groups` via a request object, either of type
1484
+ # {::Google::Cloud::Dataplex::V1::ListEntryGroupsRequest} or an equivalent Hash.
1485
+ #
1486
+ # @param request [::Google::Cloud::Dataplex::V1::ListEntryGroupsRequest, ::Hash]
1487
+ # A request object representing the call parameters. Required. To specify no
1488
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1489
+ # @param options [::Gapic::CallOptions, ::Hash]
1490
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1491
+ #
1492
+ # @overload list_entry_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
1493
+ # Pass arguments to `list_entry_groups` via keyword arguments. Note that at
1494
+ # least one keyword argument is required. To specify no parameters, or to keep all
1495
+ # the default parameter values, pass an empty Hash as a request object (see above).
1496
+ #
1497
+ # @param parent [::String]
1498
+ # Required. The resource name of the entryGroup location, of the form:
1499
+ # `projects/{project_number}/locations/{location_id}`
1500
+ # where `location_id` refers to a GCP region.
1501
+ # @param page_size [::Integer]
1502
+ # Optional. Maximum number of EntryGroups to return. The service may return
1503
+ # fewer than this value. If unspecified, at most 10 EntryGroups will be
1504
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
1505
+ # 1000.
1506
+ # @param page_token [::String]
1507
+ # Optional. Page token received from a previous `ListEntryGroups` call.
1508
+ # Provide this to retrieve the subsequent page. When paginating, all other
1509
+ # parameters provided to `ListEntryGroups` must match the call that provided
1510
+ # the page token.
1511
+ # @param filter [::String]
1512
+ # Optional. Filter request.
1513
+ # @param order_by [::String]
1514
+ # Optional. Order by fields for the result.
1515
+ # @yield [result, operation] Access the result along with the TransportOperation object
1516
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::ListEntryGroupsResponse]
1517
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1518
+ #
1519
+ # @return [::Google::Cloud::Dataplex::V1::ListEntryGroupsResponse]
1520
+ #
1521
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1522
+ #
1523
+ # @example Basic example
1524
+ # require "google/cloud/dataplex/v1"
1525
+ #
1526
+ # # Create a client object. The client can be reused for multiple calls.
1527
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1528
+ #
1529
+ # # Create a request. To set request fields, pass in keyword arguments.
1530
+ # request = Google::Cloud::Dataplex::V1::ListEntryGroupsRequest.new
1531
+ #
1532
+ # # Call the list_entry_groups method.
1533
+ # result = client.list_entry_groups request
1534
+ #
1535
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1536
+ # # over elements, and API calls will be issued to fetch pages as needed.
1537
+ # result.each do |item|
1538
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::EntryGroup.
1539
+ # p item
1540
+ # end
1541
+ #
1542
+ def list_entry_groups request, options = nil
1543
+ raise ::ArgumentError, "request must be provided" if request.nil?
1544
+
1545
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListEntryGroupsRequest
1546
+
1547
+ # Converts hash and nil to an options object
1548
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1549
+
1550
+ # Customize the options with defaults
1551
+ call_metadata = @config.rpcs.list_entry_groups.metadata.to_h
1552
+
1553
+ # Set x-goog-api-client and x-goog-user-project headers
1554
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1555
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1556
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1557
+ transports_version_send: [:rest]
1558
+
1559
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1560
+
1561
+ options.apply_defaults timeout: @config.rpcs.list_entry_groups.timeout,
1562
+ metadata: call_metadata,
1563
+ retry_policy: @config.rpcs.list_entry_groups.retry_policy
1564
+
1565
+ options.apply_defaults timeout: @config.timeout,
1566
+ metadata: @config.metadata,
1567
+ retry_policy: @config.retry_policy
1568
+
1569
+ @catalog_service_stub.list_entry_groups request, options do |result, operation|
1570
+ yield result, operation if block_given?
1571
+ return result
1572
+ end
1573
+ rescue ::Gapic::Rest::Error => e
1574
+ raise ::Google::Cloud::Error.from_error(e)
1575
+ end
1576
+
1577
+ ##
1578
+ # Retrieves a EntryGroup resource.
1579
+ #
1580
+ # @overload get_entry_group(request, options = nil)
1581
+ # Pass arguments to `get_entry_group` via a request object, either of type
1582
+ # {::Google::Cloud::Dataplex::V1::GetEntryGroupRequest} or an equivalent Hash.
1583
+ #
1584
+ # @param request [::Google::Cloud::Dataplex::V1::GetEntryGroupRequest, ::Hash]
1585
+ # A request object representing the call parameters. Required. To specify no
1586
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1587
+ # @param options [::Gapic::CallOptions, ::Hash]
1588
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1589
+ #
1590
+ # @overload get_entry_group(name: nil)
1591
+ # Pass arguments to `get_entry_group` via keyword arguments. Note that at
1592
+ # least one keyword argument is required. To specify no parameters, or to keep all
1593
+ # the default parameter values, pass an empty Hash as a request object (see above).
1594
+ #
1595
+ # @param name [::String]
1596
+ # Required. The resource name of the EntryGroup:
1597
+ # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
1598
+ # @yield [result, operation] Access the result along with the TransportOperation object
1599
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::EntryGroup]
1600
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1601
+ #
1602
+ # @return [::Google::Cloud::Dataplex::V1::EntryGroup]
1603
+ #
1604
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1605
+ #
1606
+ # @example Basic example
1607
+ # require "google/cloud/dataplex/v1"
1608
+ #
1609
+ # # Create a client object. The client can be reused for multiple calls.
1610
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1611
+ #
1612
+ # # Create a request. To set request fields, pass in keyword arguments.
1613
+ # request = Google::Cloud::Dataplex::V1::GetEntryGroupRequest.new
1614
+ #
1615
+ # # Call the get_entry_group method.
1616
+ # result = client.get_entry_group request
1617
+ #
1618
+ # # The returned object is of type Google::Cloud::Dataplex::V1::EntryGroup.
1619
+ # p result
1620
+ #
1621
+ def get_entry_group request, options = nil
1622
+ raise ::ArgumentError, "request must be provided" if request.nil?
1623
+
1624
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetEntryGroupRequest
1625
+
1626
+ # Converts hash and nil to an options object
1627
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1628
+
1629
+ # Customize the options with defaults
1630
+ call_metadata = @config.rpcs.get_entry_group.metadata.to_h
1631
+
1632
+ # Set x-goog-api-client and x-goog-user-project headers
1633
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1634
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1635
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1636
+ transports_version_send: [:rest]
1637
+
1638
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1639
+
1640
+ options.apply_defaults timeout: @config.rpcs.get_entry_group.timeout,
1641
+ metadata: call_metadata,
1642
+ retry_policy: @config.rpcs.get_entry_group.retry_policy
1643
+
1644
+ options.apply_defaults timeout: @config.timeout,
1645
+ metadata: @config.metadata,
1646
+ retry_policy: @config.retry_policy
1647
+
1648
+ @catalog_service_stub.get_entry_group request, options do |result, operation|
1649
+ yield result, operation if block_given?
1650
+ return result
1651
+ end
1652
+ rescue ::Gapic::Rest::Error => e
1653
+ raise ::Google::Cloud::Error.from_error(e)
1654
+ end
1655
+
1656
+ ##
1657
+ # Creates an Entry.
1658
+ #
1659
+ # @overload create_entry(request, options = nil)
1660
+ # Pass arguments to `create_entry` via a request object, either of type
1661
+ # {::Google::Cloud::Dataplex::V1::CreateEntryRequest} or an equivalent Hash.
1662
+ #
1663
+ # @param request [::Google::Cloud::Dataplex::V1::CreateEntryRequest, ::Hash]
1664
+ # A request object representing the call parameters. Required. To specify no
1665
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1666
+ # @param options [::Gapic::CallOptions, ::Hash]
1667
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1668
+ #
1669
+ # @overload create_entry(parent: nil, entry_id: nil, entry: nil)
1670
+ # Pass arguments to `create_entry` via keyword arguments. Note that at
1671
+ # least one keyword argument is required. To specify no parameters, or to keep all
1672
+ # the default parameter values, pass an empty Hash as a request object (see above).
1673
+ #
1674
+ # @param parent [::String]
1675
+ # Required. The resource name of the parent Entry Group:
1676
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
1677
+ # @param entry_id [::String]
1678
+ # Required. Entry identifier. It has to be unique within an Entry Group.
1679
+ #
1680
+ # Entries corresponding to Google Cloud resources use Entry ID format based
1681
+ # on Full Resource Names
1682
+ # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
1683
+ # The format is a Full Resource Name of the resource without the
1684
+ # prefix double slashes in the API Service Name part of Full Resource Name.
1685
+ # This allows retrieval of entries using their associated resource name.
1686
+ #
1687
+ # For example if the Full Resource Name of a resource is
1688
+ # `//library.googleapis.com/shelves/shelf1/books/book2`,
1689
+ # then the suggested entry_id is
1690
+ # `library.googleapis.com/shelves/shelf1/books/book2`.
1691
+ #
1692
+ # It is also suggested to follow the same convention for entries
1693
+ # corresponding to resources from other providers or systems than Google
1694
+ # Cloud.
1695
+ #
1696
+ # The maximum size of the field is 4000 characters.
1697
+ # @param entry [::Google::Cloud::Dataplex::V1::Entry, ::Hash]
1698
+ # Required. Entry resource.
1699
+ # @yield [result, operation] Access the result along with the TransportOperation object
1700
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
1701
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1702
+ #
1703
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1704
+ #
1705
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1706
+ #
1707
+ # @example Basic example
1708
+ # require "google/cloud/dataplex/v1"
1709
+ #
1710
+ # # Create a client object. The client can be reused for multiple calls.
1711
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1712
+ #
1713
+ # # Create a request. To set request fields, pass in keyword arguments.
1714
+ # request = Google::Cloud::Dataplex::V1::CreateEntryRequest.new
1715
+ #
1716
+ # # Call the create_entry method.
1717
+ # result = client.create_entry request
1718
+ #
1719
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
1720
+ # p result
1721
+ #
1722
+ def create_entry request, options = nil
1723
+ raise ::ArgumentError, "request must be provided" if request.nil?
1724
+
1725
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateEntryRequest
1726
+
1727
+ # Converts hash and nil to an options object
1728
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1729
+
1730
+ # Customize the options with defaults
1731
+ call_metadata = @config.rpcs.create_entry.metadata.to_h
1732
+
1733
+ # Set x-goog-api-client and x-goog-user-project headers
1734
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1735
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1736
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1737
+ transports_version_send: [:rest]
1738
+
1739
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1740
+
1741
+ options.apply_defaults timeout: @config.rpcs.create_entry.timeout,
1742
+ metadata: call_metadata,
1743
+ retry_policy: @config.rpcs.create_entry.retry_policy
1744
+
1745
+ options.apply_defaults timeout: @config.timeout,
1746
+ metadata: @config.metadata,
1747
+ retry_policy: @config.retry_policy
1748
+
1749
+ @catalog_service_stub.create_entry request, options do |result, operation|
1750
+ yield result, operation if block_given?
1751
+ return result
1752
+ end
1753
+ rescue ::Gapic::Rest::Error => e
1754
+ raise ::Google::Cloud::Error.from_error(e)
1755
+ end
1756
+
1757
+ ##
1758
+ # Updates an Entry.
1759
+ #
1760
+ # @overload update_entry(request, options = nil)
1761
+ # Pass arguments to `update_entry` via a request object, either of type
1762
+ # {::Google::Cloud::Dataplex::V1::UpdateEntryRequest} or an equivalent Hash.
1763
+ #
1764
+ # @param request [::Google::Cloud::Dataplex::V1::UpdateEntryRequest, ::Hash]
1765
+ # A request object representing the call parameters. Required. To specify no
1766
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1767
+ # @param options [::Gapic::CallOptions, ::Hash]
1768
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1769
+ #
1770
+ # @overload update_entry(entry: nil, update_mask: nil, allow_missing: nil, delete_missing_aspects: nil, aspect_keys: nil)
1771
+ # Pass arguments to `update_entry` via keyword arguments. Note that at
1772
+ # least one keyword argument is required. To specify no parameters, or to keep all
1773
+ # the default parameter values, pass an empty Hash as a request object (see above).
1774
+ #
1775
+ # @param entry [::Google::Cloud::Dataplex::V1::Entry, ::Hash]
1776
+ # Required. Entry resource.
1777
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1778
+ # Optional. Mask of fields to update. To update Aspects, the update_mask must
1779
+ # contain the value "aspects".
1780
+ #
1781
+ # If the update_mask is empty, all modifiable fields present in the request
1782
+ # will be updated.
1783
+ # @param allow_missing [::Boolean]
1784
+ # Optional. If set to true and the entry does not exist, it will be created.
1785
+ # @param delete_missing_aspects [::Boolean]
1786
+ # Optional. If set to true and the aspect_keys specify aspect ranges, any
1787
+ # existing aspects from that range not provided in the request will be
1788
+ # deleted.
1789
+ # @param aspect_keys [::Array<::String>]
1790
+ # Optional. The map keys of the Aspects which should be modified. Supports
1791
+ # the following syntaxes:
1792
+ # * <aspect_type_reference> - matches aspect on given type and empty path
1793
+ # * <aspect_type_reference>@path - matches aspect on given type and specified
1794
+ # path
1795
+ # * <aspect_type_reference>* - matches aspects on given type for all paths
1796
+ # * *@path - matches aspects of all types on the given path
1797
+ #
1798
+ # Existing aspects matching the syntax will not be removed unless
1799
+ # `delete_missing_aspects` is set to true.
1800
+ #
1801
+ # If this field is left empty, it will be treated as specifying exactly those
1802
+ # Aspects present in the request.
1803
+ # @yield [result, operation] Access the result along with the TransportOperation object
1804
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
1805
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1806
+ #
1807
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1808
+ #
1809
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1810
+ #
1811
+ # @example Basic example
1812
+ # require "google/cloud/dataplex/v1"
1813
+ #
1814
+ # # Create a client object. The client can be reused for multiple calls.
1815
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1816
+ #
1817
+ # # Create a request. To set request fields, pass in keyword arguments.
1818
+ # request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new
1819
+ #
1820
+ # # Call the update_entry method.
1821
+ # result = client.update_entry request
1822
+ #
1823
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
1824
+ # p result
1825
+ #
1826
+ def update_entry request, options = nil
1827
+ raise ::ArgumentError, "request must be provided" if request.nil?
1828
+
1829
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateEntryRequest
1830
+
1831
+ # Converts hash and nil to an options object
1832
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1833
+
1834
+ # Customize the options with defaults
1835
+ call_metadata = @config.rpcs.update_entry.metadata.to_h
1836
+
1837
+ # Set x-goog-api-client and x-goog-user-project headers
1838
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1839
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1840
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1841
+ transports_version_send: [:rest]
1842
+
1843
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1844
+
1845
+ options.apply_defaults timeout: @config.rpcs.update_entry.timeout,
1846
+ metadata: call_metadata,
1847
+ retry_policy: @config.rpcs.update_entry.retry_policy
1848
+
1849
+ options.apply_defaults timeout: @config.timeout,
1850
+ metadata: @config.metadata,
1851
+ retry_policy: @config.retry_policy
1852
+
1853
+ @catalog_service_stub.update_entry request, options do |result, operation|
1854
+ yield result, operation if block_given?
1855
+ return result
1856
+ end
1857
+ rescue ::Gapic::Rest::Error => e
1858
+ raise ::Google::Cloud::Error.from_error(e)
1859
+ end
1860
+
1861
+ ##
1862
+ # Deletes an Entry.
1863
+ #
1864
+ # @overload delete_entry(request, options = nil)
1865
+ # Pass arguments to `delete_entry` via a request object, either of type
1866
+ # {::Google::Cloud::Dataplex::V1::DeleteEntryRequest} or an equivalent Hash.
1867
+ #
1868
+ # @param request [::Google::Cloud::Dataplex::V1::DeleteEntryRequest, ::Hash]
1869
+ # A request object representing the call parameters. Required. To specify no
1870
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1871
+ # @param options [::Gapic::CallOptions, ::Hash]
1872
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1873
+ #
1874
+ # @overload delete_entry(name: nil)
1875
+ # Pass arguments to `delete_entry` via keyword arguments. Note that at
1876
+ # least one keyword argument is required. To specify no parameters, or to keep all
1877
+ # the default parameter values, pass an empty Hash as a request object (see above).
1878
+ #
1879
+ # @param name [::String]
1880
+ # Required. The resource name of the Entry:
1881
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
1882
+ # @yield [result, operation] Access the result along with the TransportOperation object
1883
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
1884
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1885
+ #
1886
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1887
+ #
1888
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1889
+ #
1890
+ # @example Basic example
1891
+ # require "google/cloud/dataplex/v1"
1892
+ #
1893
+ # # Create a client object. The client can be reused for multiple calls.
1894
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1895
+ #
1896
+ # # Create a request. To set request fields, pass in keyword arguments.
1897
+ # request = Google::Cloud::Dataplex::V1::DeleteEntryRequest.new
1898
+ #
1899
+ # # Call the delete_entry method.
1900
+ # result = client.delete_entry request
1901
+ #
1902
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
1903
+ # p result
1904
+ #
1905
+ def delete_entry request, options = nil
1906
+ raise ::ArgumentError, "request must be provided" if request.nil?
1907
+
1908
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteEntryRequest
1909
+
1910
+ # Converts hash and nil to an options object
1911
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1912
+
1913
+ # Customize the options with defaults
1914
+ call_metadata = @config.rpcs.delete_entry.metadata.to_h
1915
+
1916
+ # Set x-goog-api-client and x-goog-user-project headers
1917
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1918
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1919
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
1920
+ transports_version_send: [:rest]
1921
+
1922
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1923
+
1924
+ options.apply_defaults timeout: @config.rpcs.delete_entry.timeout,
1925
+ metadata: call_metadata,
1926
+ retry_policy: @config.rpcs.delete_entry.retry_policy
1927
+
1928
+ options.apply_defaults timeout: @config.timeout,
1929
+ metadata: @config.metadata,
1930
+ retry_policy: @config.retry_policy
1931
+
1932
+ @catalog_service_stub.delete_entry request, options do |result, operation|
1933
+ yield result, operation if block_given?
1934
+ return result
1935
+ end
1936
+ rescue ::Gapic::Rest::Error => e
1937
+ raise ::Google::Cloud::Error.from_error(e)
1938
+ end
1939
+
1940
+ ##
1941
+ # Lists entries within an entry group.
1942
+ #
1943
+ # @overload list_entries(request, options = nil)
1944
+ # Pass arguments to `list_entries` via a request object, either of type
1945
+ # {::Google::Cloud::Dataplex::V1::ListEntriesRequest} or an equivalent Hash.
1946
+ #
1947
+ # @param request [::Google::Cloud::Dataplex::V1::ListEntriesRequest, ::Hash]
1948
+ # A request object representing the call parameters. Required. To specify no
1949
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1950
+ # @param options [::Gapic::CallOptions, ::Hash]
1951
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1952
+ #
1953
+ # @overload list_entries(parent: nil, page_size: nil, page_token: nil, filter: nil)
1954
+ # Pass arguments to `list_entries` via keyword arguments. Note that at
1955
+ # least one keyword argument is required. To specify no parameters, or to keep all
1956
+ # the default parameter values, pass an empty Hash as a request object (see above).
1957
+ #
1958
+ # @param parent [::String]
1959
+ # Required. The resource name of the parent Entry Group:
1960
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
1961
+ # @param page_size [::Integer]
1962
+ # @param page_token [::String]
1963
+ # Optional. The pagination token returned by a previous request.
1964
+ # @param filter [::String]
1965
+ # Optional. A filter on the entries to return.
1966
+ # Filters are case-sensitive.
1967
+ # The request can be filtered by the following fields:
1968
+ # entry_type, display_name.
1969
+ # The comparison operators are =, !=, <, >, <=, >= (strings are compared
1970
+ # according to lexical order)
1971
+ # The logical operators AND, OR, NOT can be used
1972
+ # in the filter. Example filter expressions:
1973
+ # "display_name=AnExampleDisplayName"
1974
+ # "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
1975
+ # "entry_type=projects/a* OR "entry_type=projects/k*"
1976
+ # "NOT display_name=AnotherExampleDisplayName"
1977
+ # @yield [result, operation] Access the result along with the TransportOperation object
1978
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>]
1979
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1980
+ #
1981
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>]
1982
+ #
1983
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1984
+ #
1985
+ # @example Basic example
1986
+ # require "google/cloud/dataplex/v1"
1987
+ #
1988
+ # # Create a client object. The client can be reused for multiple calls.
1989
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
1990
+ #
1991
+ # # Create a request. To set request fields, pass in keyword arguments.
1992
+ # request = Google::Cloud::Dataplex::V1::ListEntriesRequest.new
1993
+ #
1994
+ # # Call the list_entries method.
1995
+ # result = client.list_entries request
1996
+ #
1997
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1998
+ # # over elements, and API calls will be issued to fetch pages as needed.
1999
+ # result.each do |item|
2000
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::Entry.
2001
+ # p item
2002
+ # end
2003
+ #
2004
+ def list_entries request, options = nil
2005
+ raise ::ArgumentError, "request must be provided" if request.nil?
2006
+
2007
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListEntriesRequest
2008
+
2009
+ # Converts hash and nil to an options object
2010
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2011
+
2012
+ # Customize the options with defaults
2013
+ call_metadata = @config.rpcs.list_entries.metadata.to_h
2014
+
2015
+ # Set x-goog-api-client and x-goog-user-project headers
2016
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2017
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2018
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2019
+ transports_version_send: [:rest]
2020
+
2021
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2022
+
2023
+ options.apply_defaults timeout: @config.rpcs.list_entries.timeout,
2024
+ metadata: call_metadata,
2025
+ retry_policy: @config.rpcs.list_entries.retry_policy
2026
+
2027
+ options.apply_defaults timeout: @config.timeout,
2028
+ metadata: @config.metadata,
2029
+ retry_policy: @config.retry_policy
2030
+
2031
+ @catalog_service_stub.list_entries request, options do |result, operation|
2032
+ result = ::Gapic::Rest::PagedEnumerable.new @catalog_service_stub, :list_entries, "entries", request, result, options
2033
+ yield result, operation if block_given?
2034
+ return result
2035
+ end
2036
+ rescue ::Gapic::Rest::Error => e
2037
+ raise ::Google::Cloud::Error.from_error(e)
2038
+ end
2039
+
2040
+ ##
2041
+ # Gets a single entry.
2042
+ #
2043
+ # @overload get_entry(request, options = nil)
2044
+ # Pass arguments to `get_entry` via a request object, either of type
2045
+ # {::Google::Cloud::Dataplex::V1::GetEntryRequest} or an equivalent Hash.
2046
+ #
2047
+ # @param request [::Google::Cloud::Dataplex::V1::GetEntryRequest, ::Hash]
2048
+ # A request object representing the call parameters. Required. To specify no
2049
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2050
+ # @param options [::Gapic::CallOptions, ::Hash]
2051
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2052
+ #
2053
+ # @overload get_entry(name: nil, view: nil, aspect_types: nil, paths: nil)
2054
+ # Pass arguments to `get_entry` via keyword arguments. Note that at
2055
+ # least one keyword argument is required. To specify no parameters, or to keep all
2056
+ # the default parameter values, pass an empty Hash as a request object (see above).
2057
+ #
2058
+ # @param name [::String]
2059
+ # Required. The resource name of the Entry:
2060
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
2061
+ # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2062
+ # Optional. View for controlling which parts of an entry are to be returned.
2063
+ # @param aspect_types [::Array<::String>]
2064
+ # Optional. Limits the aspects returned to the provided aspect types.
2065
+ # Only works if the CUSTOM view is selected.
2066
+ # @param paths [::Array<::String>]
2067
+ # Optional. Limits the aspects returned to those associated with the provided
2068
+ # paths within the Entry. Only works if the CUSTOM view is selected.
2069
+ # @yield [result, operation] Access the result along with the TransportOperation object
2070
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
2071
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2072
+ #
2073
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
2074
+ #
2075
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2076
+ #
2077
+ # @example Basic example
2078
+ # require "google/cloud/dataplex/v1"
2079
+ #
2080
+ # # Create a client object. The client can be reused for multiple calls.
2081
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2082
+ #
2083
+ # # Create a request. To set request fields, pass in keyword arguments.
2084
+ # request = Google::Cloud::Dataplex::V1::GetEntryRequest.new
2085
+ #
2086
+ # # Call the get_entry method.
2087
+ # result = client.get_entry request
2088
+ #
2089
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
2090
+ # p result
2091
+ #
2092
+ def get_entry request, options = nil
2093
+ raise ::ArgumentError, "request must be provided" if request.nil?
2094
+
2095
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetEntryRequest
2096
+
2097
+ # Converts hash and nil to an options object
2098
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2099
+
2100
+ # Customize the options with defaults
2101
+ call_metadata = @config.rpcs.get_entry.metadata.to_h
2102
+
2103
+ # Set x-goog-api-client and x-goog-user-project headers
2104
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2105
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2106
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2107
+ transports_version_send: [:rest]
2108
+
2109
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2110
+
2111
+ options.apply_defaults timeout: @config.rpcs.get_entry.timeout,
2112
+ metadata: call_metadata,
2113
+ retry_policy: @config.rpcs.get_entry.retry_policy
2114
+
2115
+ options.apply_defaults timeout: @config.timeout,
2116
+ metadata: @config.metadata,
2117
+ retry_policy: @config.retry_policy
2118
+
2119
+ @catalog_service_stub.get_entry request, options do |result, operation|
2120
+ yield result, operation if block_given?
2121
+ return result
2122
+ end
2123
+ rescue ::Gapic::Rest::Error => e
2124
+ raise ::Google::Cloud::Error.from_error(e)
2125
+ end
2126
+
2127
+ ##
2128
+ # Looks up a single entry.
2129
+ #
2130
+ # @overload lookup_entry(request, options = nil)
2131
+ # Pass arguments to `lookup_entry` via a request object, either of type
2132
+ # {::Google::Cloud::Dataplex::V1::LookupEntryRequest} or an equivalent Hash.
2133
+ #
2134
+ # @param request [::Google::Cloud::Dataplex::V1::LookupEntryRequest, ::Hash]
2135
+ # A request object representing the call parameters. Required. To specify no
2136
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2137
+ # @param options [::Gapic::CallOptions, ::Hash]
2138
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2139
+ #
2140
+ # @overload lookup_entry(name: nil, view: nil, aspect_types: nil, paths: nil, entry: nil)
2141
+ # Pass arguments to `lookup_entry` via keyword arguments. Note that at
2142
+ # least one keyword argument is required. To specify no parameters, or to keep all
2143
+ # the default parameter values, pass an empty Hash as a request object (see above).
2144
+ #
2145
+ # @param name [::String]
2146
+ # Required. The project to which the request should be attributed in the
2147
+ # following form: `projects/{project}/locations/{location}`.
2148
+ # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2149
+ # Optional. View for controlling which parts of an entry are to be returned.
2150
+ # @param aspect_types [::Array<::String>]
2151
+ # Optional. Limits the aspects returned to the provided aspect types.
2152
+ # Only works if the CUSTOM view is selected.
2153
+ # @param paths [::Array<::String>]
2154
+ # Optional. Limits the aspects returned to those associated with the provided
2155
+ # paths within the Entry. Only works if the CUSTOM view is selected.
2156
+ # @param entry [::String]
2157
+ # Required. The resource name of the Entry:
2158
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
2159
+ # @yield [result, operation] Access the result along with the TransportOperation object
2160
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
2161
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2162
+ #
2163
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
2164
+ #
2165
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2166
+ #
2167
+ # @example Basic example
2168
+ # require "google/cloud/dataplex/v1"
2169
+ #
2170
+ # # Create a client object. The client can be reused for multiple calls.
2171
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2172
+ #
2173
+ # # Create a request. To set request fields, pass in keyword arguments.
2174
+ # request = Google::Cloud::Dataplex::V1::LookupEntryRequest.new
2175
+ #
2176
+ # # Call the lookup_entry method.
2177
+ # result = client.lookup_entry request
2178
+ #
2179
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
2180
+ # p result
2181
+ #
2182
+ def lookup_entry request, options = nil
2183
+ raise ::ArgumentError, "request must be provided" if request.nil?
2184
+
2185
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::LookupEntryRequest
2186
+
2187
+ # Converts hash and nil to an options object
2188
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2189
+
2190
+ # Customize the options with defaults
2191
+ call_metadata = @config.rpcs.lookup_entry.metadata.to_h
2192
+
2193
+ # Set x-goog-api-client and x-goog-user-project headers
2194
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2195
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2196
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2197
+ transports_version_send: [:rest]
2198
+
2199
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2200
+
2201
+ options.apply_defaults timeout: @config.rpcs.lookup_entry.timeout,
2202
+ metadata: call_metadata,
2203
+ retry_policy: @config.rpcs.lookup_entry.retry_policy
2204
+
2205
+ options.apply_defaults timeout: @config.timeout,
2206
+ metadata: @config.metadata,
2207
+ retry_policy: @config.retry_policy
2208
+
2209
+ @catalog_service_stub.lookup_entry request, options do |result, operation|
2210
+ yield result, operation if block_given?
2211
+ return result
2212
+ end
2213
+ rescue ::Gapic::Rest::Error => e
2214
+ raise ::Google::Cloud::Error.from_error(e)
2215
+ end
2216
+
2217
+ ##
2218
+ # Searches for entries matching given query and scope.
2219
+ #
2220
+ # @overload search_entries(request, options = nil)
2221
+ # Pass arguments to `search_entries` via a request object, either of type
2222
+ # {::Google::Cloud::Dataplex::V1::SearchEntriesRequest} or an equivalent Hash.
2223
+ #
2224
+ # @param request [::Google::Cloud::Dataplex::V1::SearchEntriesRequest, ::Hash]
2225
+ # A request object representing the call parameters. Required. To specify no
2226
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2227
+ # @param options [::Gapic::CallOptions, ::Hash]
2228
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2229
+ #
2230
+ # @overload search_entries(name: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, scope: nil)
2231
+ # Pass arguments to `search_entries` via keyword arguments. Note that at
2232
+ # least one keyword argument is required. To specify no parameters, or to keep all
2233
+ # the default parameter values, pass an empty Hash as a request object (see above).
2234
+ #
2235
+ # @param name [::String]
2236
+ # Required. The project to which the request should be attributed in the
2237
+ # following form: `projects/{project}/locations/{location}`.
2238
+ # @param query [::String]
2239
+ # Required. The query against which entries in scope should be matched.
2240
+ # @param page_size [::Integer]
2241
+ # Optional. Pagination.
2242
+ # @param page_token [::String]
2243
+ # @param order_by [::String]
2244
+ # Optional. Ordering of the results. Supported options to be added later.
2245
+ # @param scope [::String]
2246
+ # Optional. The scope under which the search should be operating. Should
2247
+ # either be organizations/<org_id> or projects/<project_ref>. If left
2248
+ # unspecified, it will default to the organization where the project provided
2249
+ # in `name` is located.
2250
+ # @yield [result, operation] Access the result along with the TransportOperation object
2251
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::SearchEntriesResponse]
2252
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2253
+ #
2254
+ # @return [::Google::Cloud::Dataplex::V1::SearchEntriesResponse]
2255
+ #
2256
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2257
+ #
2258
+ # @example Basic example
2259
+ # require "google/cloud/dataplex/v1"
2260
+ #
2261
+ # # Create a client object. The client can be reused for multiple calls.
2262
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2263
+ #
2264
+ # # Create a request. To set request fields, pass in keyword arguments.
2265
+ # request = Google::Cloud::Dataplex::V1::SearchEntriesRequest.new
2266
+ #
2267
+ # # Call the search_entries method.
2268
+ # result = client.search_entries request
2269
+ #
2270
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2271
+ # # over elements, and API calls will be issued to fetch pages as needed.
2272
+ # result.each do |item|
2273
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::SearchEntriesResult.
2274
+ # p item
2275
+ # end
2276
+ #
2277
+ def search_entries request, options = nil
2278
+ raise ::ArgumentError, "request must be provided" if request.nil?
2279
+
2280
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::SearchEntriesRequest
2281
+
2282
+ # Converts hash and nil to an options object
2283
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2284
+
2285
+ # Customize the options with defaults
2286
+ call_metadata = @config.rpcs.search_entries.metadata.to_h
2287
+
2288
+ # Set x-goog-api-client and x-goog-user-project headers
2289
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2290
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2291
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2292
+ transports_version_send: [:rest]
2293
+
2294
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2295
+
2296
+ options.apply_defaults timeout: @config.rpcs.search_entries.timeout,
2297
+ metadata: call_metadata,
2298
+ retry_policy: @config.rpcs.search_entries.retry_policy
2299
+
2300
+ options.apply_defaults timeout: @config.timeout,
2301
+ metadata: @config.metadata,
2302
+ retry_policy: @config.retry_policy
2303
+
2304
+ @catalog_service_stub.search_entries request, options do |result, operation|
2305
+ yield result, operation if block_given?
2306
+ return result
2307
+ end
2308
+ rescue ::Gapic::Rest::Error => e
2309
+ raise ::Google::Cloud::Error.from_error(e)
2310
+ end
2311
+
2312
+ ##
2313
+ # Configuration class for the CatalogService REST API.
2314
+ #
2315
+ # This class represents the configuration for CatalogService REST,
2316
+ # providing control over timeouts, retry behavior, logging, transport
2317
+ # parameters, and other low-level controls. Certain parameters can also be
2318
+ # applied individually to specific RPCs. See
2319
+ # {::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client::Configuration::Rpcs}
2320
+ # for a list of RPCs that can be configured independently.
2321
+ #
2322
+ # Configuration can be applied globally to all clients, or to a single client
2323
+ # on construction.
2324
+ #
2325
+ # @example
2326
+ #
2327
+ # # Modify the global config, setting the timeout for
2328
+ # # create_entry_type to 20 seconds,
2329
+ # # and all remaining timeouts to 10 seconds.
2330
+ # ::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.configure do |config|
2331
+ # config.timeout = 10.0
2332
+ # config.rpcs.create_entry_type.timeout = 20.0
2333
+ # end
2334
+ #
2335
+ # # Apply the above configuration only to a new client.
2336
+ # client = ::Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new do |config|
2337
+ # config.timeout = 10.0
2338
+ # config.rpcs.create_entry_type.timeout = 20.0
2339
+ # end
2340
+ #
2341
+ # @!attribute [rw] endpoint
2342
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2343
+ # nil, indicating to use the default endpoint in the current universe domain.
2344
+ # @return [::String,nil]
2345
+ # @!attribute [rw] credentials
2346
+ # Credentials to send with calls. You may provide any of the following types:
2347
+ # * (`String`) The path to a service account key file in JSON format
2348
+ # * (`Hash`) A service account key as a Hash
2349
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
2350
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2351
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2352
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2353
+ # * (`nil`) indicating no credentials
2354
+ # @return [::Object]
2355
+ # @!attribute [rw] scope
2356
+ # The OAuth scopes
2357
+ # @return [::Array<::String>]
2358
+ # @!attribute [rw] lib_name
2359
+ # The library name as recorded in instrumentation and logging
2360
+ # @return [::String]
2361
+ # @!attribute [rw] lib_version
2362
+ # The library version as recorded in instrumentation and logging
2363
+ # @return [::String]
2364
+ # @!attribute [rw] timeout
2365
+ # The call timeout in seconds.
2366
+ # @return [::Numeric]
2367
+ # @!attribute [rw] metadata
2368
+ # Additional headers to be sent with the call.
2369
+ # @return [::Hash{::Symbol=>::String}]
2370
+ # @!attribute [rw] retry_policy
2371
+ # The retry policy. The value is a hash with the following keys:
2372
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
2373
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
2374
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
2375
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
2376
+ # trigger a retry.
2377
+ # @return [::Hash]
2378
+ # @!attribute [rw] quota_project
2379
+ # A separate project against which to charge quota.
2380
+ # @return [::String]
2381
+ # @!attribute [rw] universe_domain
2382
+ # The universe domain within which to make requests. This determines the
2383
+ # default endpoint URL. The default value of nil uses the environment
2384
+ # universe (usually the default "googleapis.com" universe).
2385
+ # @return [::String,nil]
2386
+ #
2387
+ class Configuration
2388
+ extend ::Gapic::Config
2389
+
2390
+ # @private
2391
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2392
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
2393
+
2394
+ config_attr :endpoint, nil, ::String, nil
2395
+ config_attr :credentials, nil do |value|
2396
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2397
+ allowed.any? { |klass| klass === value }
2398
+ end
2399
+ config_attr :scope, nil, ::String, ::Array, nil
2400
+ config_attr :lib_name, nil, ::String, nil
2401
+ config_attr :lib_version, nil, ::String, nil
2402
+ config_attr :timeout, nil, ::Numeric, nil
2403
+ config_attr :metadata, nil, ::Hash, nil
2404
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2405
+ config_attr :quota_project, nil, ::String, nil
2406
+ config_attr :universe_domain, nil, ::String, nil
2407
+
2408
+ # @private
2409
+ # Overrides for http bindings for the RPCs of this service
2410
+ # are only used when this service is used as mixin, and only
2411
+ # by the host service.
2412
+ # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
2413
+ config_attr :bindings_override, {}, ::Hash, nil
2414
+
2415
+ # @private
2416
+ def initialize parent_config = nil
2417
+ @parent_config = parent_config unless parent_config.nil?
2418
+
2419
+ yield self if block_given?
2420
+ end
2421
+
2422
+ ##
2423
+ # Configurations for individual RPCs
2424
+ # @return [Rpcs]
2425
+ #
2426
+ def rpcs
2427
+ @rpcs ||= begin
2428
+ parent_rpcs = nil
2429
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
2430
+ Rpcs.new parent_rpcs
2431
+ end
2432
+ end
2433
+
2434
+ ##
2435
+ # Configuration RPC class for the CatalogService API.
2436
+ #
2437
+ # Includes fields providing the configuration for each RPC in this service.
2438
+ # Each configuration object is of type `Gapic::Config::Method` and includes
2439
+ # the following configuration fields:
2440
+ #
2441
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
2442
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
2443
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
2444
+ # include the following keys:
2445
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
2446
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
2447
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
2448
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
2449
+ # trigger a retry.
2450
+ #
2451
+ class Rpcs
2452
+ ##
2453
+ # RPC-specific configuration for `create_entry_type`
2454
+ # @return [::Gapic::Config::Method]
2455
+ #
2456
+ attr_reader :create_entry_type
2457
+ ##
2458
+ # RPC-specific configuration for `update_entry_type`
2459
+ # @return [::Gapic::Config::Method]
2460
+ #
2461
+ attr_reader :update_entry_type
2462
+ ##
2463
+ # RPC-specific configuration for `delete_entry_type`
2464
+ # @return [::Gapic::Config::Method]
2465
+ #
2466
+ attr_reader :delete_entry_type
2467
+ ##
2468
+ # RPC-specific configuration for `list_entry_types`
2469
+ # @return [::Gapic::Config::Method]
2470
+ #
2471
+ attr_reader :list_entry_types
2472
+ ##
2473
+ # RPC-specific configuration for `get_entry_type`
2474
+ # @return [::Gapic::Config::Method]
2475
+ #
2476
+ attr_reader :get_entry_type
2477
+ ##
2478
+ # RPC-specific configuration for `create_aspect_type`
2479
+ # @return [::Gapic::Config::Method]
2480
+ #
2481
+ attr_reader :create_aspect_type
2482
+ ##
2483
+ # RPC-specific configuration for `update_aspect_type`
2484
+ # @return [::Gapic::Config::Method]
2485
+ #
2486
+ attr_reader :update_aspect_type
2487
+ ##
2488
+ # RPC-specific configuration for `delete_aspect_type`
2489
+ # @return [::Gapic::Config::Method]
2490
+ #
2491
+ attr_reader :delete_aspect_type
2492
+ ##
2493
+ # RPC-specific configuration for `list_aspect_types`
2494
+ # @return [::Gapic::Config::Method]
2495
+ #
2496
+ attr_reader :list_aspect_types
2497
+ ##
2498
+ # RPC-specific configuration for `get_aspect_type`
2499
+ # @return [::Gapic::Config::Method]
2500
+ #
2501
+ attr_reader :get_aspect_type
2502
+ ##
2503
+ # RPC-specific configuration for `create_entry_group`
2504
+ # @return [::Gapic::Config::Method]
2505
+ #
2506
+ attr_reader :create_entry_group
2507
+ ##
2508
+ # RPC-specific configuration for `update_entry_group`
2509
+ # @return [::Gapic::Config::Method]
2510
+ #
2511
+ attr_reader :update_entry_group
2512
+ ##
2513
+ # RPC-specific configuration for `delete_entry_group`
2514
+ # @return [::Gapic::Config::Method]
2515
+ #
2516
+ attr_reader :delete_entry_group
2517
+ ##
2518
+ # RPC-specific configuration for `list_entry_groups`
2519
+ # @return [::Gapic::Config::Method]
2520
+ #
2521
+ attr_reader :list_entry_groups
2522
+ ##
2523
+ # RPC-specific configuration for `get_entry_group`
2524
+ # @return [::Gapic::Config::Method]
2525
+ #
2526
+ attr_reader :get_entry_group
2527
+ ##
2528
+ # RPC-specific configuration for `create_entry`
2529
+ # @return [::Gapic::Config::Method]
2530
+ #
2531
+ attr_reader :create_entry
2532
+ ##
2533
+ # RPC-specific configuration for `update_entry`
2534
+ # @return [::Gapic::Config::Method]
2535
+ #
2536
+ attr_reader :update_entry
2537
+ ##
2538
+ # RPC-specific configuration for `delete_entry`
2539
+ # @return [::Gapic::Config::Method]
2540
+ #
2541
+ attr_reader :delete_entry
2542
+ ##
2543
+ # RPC-specific configuration for `list_entries`
2544
+ # @return [::Gapic::Config::Method]
2545
+ #
2546
+ attr_reader :list_entries
2547
+ ##
2548
+ # RPC-specific configuration for `get_entry`
2549
+ # @return [::Gapic::Config::Method]
2550
+ #
2551
+ attr_reader :get_entry
2552
+ ##
2553
+ # RPC-specific configuration for `lookup_entry`
2554
+ # @return [::Gapic::Config::Method]
2555
+ #
2556
+ attr_reader :lookup_entry
2557
+ ##
2558
+ # RPC-specific configuration for `search_entries`
2559
+ # @return [::Gapic::Config::Method]
2560
+ #
2561
+ attr_reader :search_entries
2562
+
2563
+ # @private
2564
+ def initialize parent_rpcs = nil
2565
+ create_entry_type_config = parent_rpcs.create_entry_type if parent_rpcs.respond_to? :create_entry_type
2566
+ @create_entry_type = ::Gapic::Config::Method.new create_entry_type_config
2567
+ update_entry_type_config = parent_rpcs.update_entry_type if parent_rpcs.respond_to? :update_entry_type
2568
+ @update_entry_type = ::Gapic::Config::Method.new update_entry_type_config
2569
+ delete_entry_type_config = parent_rpcs.delete_entry_type if parent_rpcs.respond_to? :delete_entry_type
2570
+ @delete_entry_type = ::Gapic::Config::Method.new delete_entry_type_config
2571
+ list_entry_types_config = parent_rpcs.list_entry_types if parent_rpcs.respond_to? :list_entry_types
2572
+ @list_entry_types = ::Gapic::Config::Method.new list_entry_types_config
2573
+ get_entry_type_config = parent_rpcs.get_entry_type if parent_rpcs.respond_to? :get_entry_type
2574
+ @get_entry_type = ::Gapic::Config::Method.new get_entry_type_config
2575
+ create_aspect_type_config = parent_rpcs.create_aspect_type if parent_rpcs.respond_to? :create_aspect_type
2576
+ @create_aspect_type = ::Gapic::Config::Method.new create_aspect_type_config
2577
+ update_aspect_type_config = parent_rpcs.update_aspect_type if parent_rpcs.respond_to? :update_aspect_type
2578
+ @update_aspect_type = ::Gapic::Config::Method.new update_aspect_type_config
2579
+ delete_aspect_type_config = parent_rpcs.delete_aspect_type if parent_rpcs.respond_to? :delete_aspect_type
2580
+ @delete_aspect_type = ::Gapic::Config::Method.new delete_aspect_type_config
2581
+ list_aspect_types_config = parent_rpcs.list_aspect_types if parent_rpcs.respond_to? :list_aspect_types
2582
+ @list_aspect_types = ::Gapic::Config::Method.new list_aspect_types_config
2583
+ get_aspect_type_config = parent_rpcs.get_aspect_type if parent_rpcs.respond_to? :get_aspect_type
2584
+ @get_aspect_type = ::Gapic::Config::Method.new get_aspect_type_config
2585
+ create_entry_group_config = parent_rpcs.create_entry_group if parent_rpcs.respond_to? :create_entry_group
2586
+ @create_entry_group = ::Gapic::Config::Method.new create_entry_group_config
2587
+ update_entry_group_config = parent_rpcs.update_entry_group if parent_rpcs.respond_to? :update_entry_group
2588
+ @update_entry_group = ::Gapic::Config::Method.new update_entry_group_config
2589
+ delete_entry_group_config = parent_rpcs.delete_entry_group if parent_rpcs.respond_to? :delete_entry_group
2590
+ @delete_entry_group = ::Gapic::Config::Method.new delete_entry_group_config
2591
+ list_entry_groups_config = parent_rpcs.list_entry_groups if parent_rpcs.respond_to? :list_entry_groups
2592
+ @list_entry_groups = ::Gapic::Config::Method.new list_entry_groups_config
2593
+ get_entry_group_config = parent_rpcs.get_entry_group if parent_rpcs.respond_to? :get_entry_group
2594
+ @get_entry_group = ::Gapic::Config::Method.new get_entry_group_config
2595
+ create_entry_config = parent_rpcs.create_entry if parent_rpcs.respond_to? :create_entry
2596
+ @create_entry = ::Gapic::Config::Method.new create_entry_config
2597
+ update_entry_config = parent_rpcs.update_entry if parent_rpcs.respond_to? :update_entry
2598
+ @update_entry = ::Gapic::Config::Method.new update_entry_config
2599
+ delete_entry_config = parent_rpcs.delete_entry if parent_rpcs.respond_to? :delete_entry
2600
+ @delete_entry = ::Gapic::Config::Method.new delete_entry_config
2601
+ list_entries_config = parent_rpcs.list_entries if parent_rpcs.respond_to? :list_entries
2602
+ @list_entries = ::Gapic::Config::Method.new list_entries_config
2603
+ get_entry_config = parent_rpcs.get_entry if parent_rpcs.respond_to? :get_entry
2604
+ @get_entry = ::Gapic::Config::Method.new get_entry_config
2605
+ lookup_entry_config = parent_rpcs.lookup_entry if parent_rpcs.respond_to? :lookup_entry
2606
+ @lookup_entry = ::Gapic::Config::Method.new lookup_entry_config
2607
+ search_entries_config = parent_rpcs.search_entries if parent_rpcs.respond_to? :search_entries
2608
+ @search_entries = ::Gapic::Config::Method.new search_entries_config
2609
+
2610
+ yield self if block_given?
2611
+ end
2612
+ end
2613
+ end
2614
+ end
2615
+ end
2616
+ end
2617
+ end
2618
+ end
2619
+ end
2620
+ end