google-cloud-dataplex-v1 0.10.1 → 0.12.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.
@@ -136,6 +136,26 @@ module Google
136
136
  # @return [::Gapic::Operation]
137
137
  #
138
138
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
139
+ #
140
+ # @example Basic example
141
+ # require "google/longrunning"
142
+ #
143
+ # # Create a client object. The client can be reused for multiple calls.
144
+ # client = Google::Longrunning::Operations::Rest::Client.new
145
+ #
146
+ # # Create a request. To set request fields, pass in keyword arguments.
147
+ # request = Google::Longrunning::ListOperationsRequest.new
148
+ #
149
+ # # Call the list_operations method.
150
+ # result = client.list_operations request
151
+ #
152
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
153
+ # # over elements, and API calls will be issued to fetch pages as needed.
154
+ # result.each do |item|
155
+ # # Each element is of type ::Google::Longrunning::Operation.
156
+ # p item
157
+ # end
158
+ #
139
159
  def list_operations request, options = nil
140
160
  raise ::ArgumentError, "request must be provided" if request.nil?
141
161
 
@@ -201,6 +221,29 @@ module Google
201
221
  # @return [::Gapic::Operation]
202
222
  #
203
223
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
224
+ #
225
+ # @example Basic example
226
+ # require "google/longrunning"
227
+ #
228
+ # # Create a client object. The client can be reused for multiple calls.
229
+ # client = Google::Longrunning::Operations::Rest::Client.new
230
+ #
231
+ # # Create a request. To set request fields, pass in keyword arguments.
232
+ # request = Google::Longrunning::GetOperationRequest.new
233
+ #
234
+ # # Call the get_operation method.
235
+ # result = client.get_operation request
236
+ #
237
+ # # The returned object is of type Gapic::Operation. You can use it to
238
+ # # check the status of an operation, cancel it, or wait for results.
239
+ # # Here is how to wait for a response.
240
+ # result.wait_until_done! timeout: 60
241
+ # if result.response?
242
+ # p result.response
243
+ # else
244
+ # puts "No response received."
245
+ # end
246
+ #
204
247
  def get_operation request, options = nil
205
248
  raise ::ArgumentError, "request must be provided" if request.nil?
206
249
 
@@ -267,6 +310,22 @@ module Google
267
310
  # @return [::Google::Protobuf::Empty]
268
311
  #
269
312
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
313
+ #
314
+ # @example Basic example
315
+ # require "google/longrunning"
316
+ #
317
+ # # Create a client object. The client can be reused for multiple calls.
318
+ # client = Google::Longrunning::Operations::Rest::Client.new
319
+ #
320
+ # # Create a request. To set request fields, pass in keyword arguments.
321
+ # request = Google::Longrunning::DeleteOperationRequest.new
322
+ #
323
+ # # Call the delete_operation method.
324
+ # result = client.delete_operation request
325
+ #
326
+ # # The returned object is of type Google::Protobuf::Empty.
327
+ # p result
328
+ #
270
329
  def delete_operation request, options = nil
271
330
  raise ::ArgumentError, "request must be provided" if request.nil?
272
331
 
@@ -338,6 +397,22 @@ module Google
338
397
  # @return [::Google::Protobuf::Empty]
339
398
  #
340
399
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
400
+ #
401
+ # @example Basic example
402
+ # require "google/longrunning"
403
+ #
404
+ # # Create a client object. The client can be reused for multiple calls.
405
+ # client = Google::Longrunning::Operations::Rest::Client.new
406
+ #
407
+ # # Create a request. To set request fields, pass in keyword arguments.
408
+ # request = Google::Longrunning::CancelOperationRequest.new
409
+ #
410
+ # # Call the cancel_operation method.
411
+ # result = client.cancel_operation request
412
+ #
413
+ # # The returned object is of type Google::Protobuf::Empty.
414
+ # p result
415
+ #
341
416
  def cancel_operation request, options = nil
342
417
  raise ::ArgumentError, "request must be provided" if request.nil?
343
418
 
@@ -183,7 +183,8 @@ module Google
183
183
  credentials: credentials,
184
184
  endpoint: @config.endpoint,
185
185
  channel_args: @config.channel_args,
186
- interceptors: @config.interceptors
186
+ interceptors: @config.interceptors,
187
+ channel_pool_config: @config.channel_pool
187
188
  )
188
189
  end
189
190
 
@@ -1182,6 +1183,14 @@ module Google
1182
1183
  end
1183
1184
  end
1184
1185
 
1186
+ ##
1187
+ # Configuration for the channel pool
1188
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1189
+ #
1190
+ def channel_pool
1191
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1192
+ end
1193
+
1185
1194
  ##
1186
1195
  # Configuration RPC class for the MetadataService API.
1187
1196
  #
@@ -229,6 +229,22 @@ module Google
229
229
  # @return [::Google::Cloud::Dataplex::V1::Entity]
230
230
  #
231
231
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
232
+ #
233
+ # @example Basic example
234
+ # require "google/cloud/dataplex/v1"
235
+ #
236
+ # # Create a client object. The client can be reused for multiple calls.
237
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
238
+ #
239
+ # # Create a request. To set request fields, pass in keyword arguments.
240
+ # request = Google::Cloud::Dataplex::V1::CreateEntityRequest.new
241
+ #
242
+ # # Call the create_entity method.
243
+ # result = client.create_entity request
244
+ #
245
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entity.
246
+ # p result
247
+ #
232
248
  def create_entity request, options = nil
233
249
  raise ::ArgumentError, "request must be provided" if request.nil?
234
250
 
@@ -294,6 +310,22 @@ module Google
294
310
  # @return [::Google::Cloud::Dataplex::V1::Entity]
295
311
  #
296
312
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
313
+ #
314
+ # @example Basic example
315
+ # require "google/cloud/dataplex/v1"
316
+ #
317
+ # # Create a client object. The client can be reused for multiple calls.
318
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
319
+ #
320
+ # # Create a request. To set request fields, pass in keyword arguments.
321
+ # request = Google::Cloud::Dataplex::V1::UpdateEntityRequest.new
322
+ #
323
+ # # Call the update_entity method.
324
+ # result = client.update_entity request
325
+ #
326
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entity.
327
+ # p result
328
+ #
297
329
  def update_entity request, options = nil
298
330
  raise ::ArgumentError, "request must be provided" if request.nil?
299
331
 
@@ -360,6 +392,22 @@ module Google
360
392
  # @return [::Google::Protobuf::Empty]
361
393
  #
362
394
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
395
+ #
396
+ # @example Basic example
397
+ # require "google/cloud/dataplex/v1"
398
+ #
399
+ # # Create a client object. The client can be reused for multiple calls.
400
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
401
+ #
402
+ # # Create a request. To set request fields, pass in keyword arguments.
403
+ # request = Google::Cloud::Dataplex::V1::DeleteEntityRequest.new
404
+ #
405
+ # # Call the delete_entity method.
406
+ # result = client.delete_entity request
407
+ #
408
+ # # The returned object is of type Google::Protobuf::Empty.
409
+ # p result
410
+ #
363
411
  def delete_entity request, options = nil
364
412
  raise ::ArgumentError, "request must be provided" if request.nil?
365
413
 
@@ -426,6 +474,22 @@ module Google
426
474
  # @return [::Google::Cloud::Dataplex::V1::Entity]
427
475
  #
428
476
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
477
+ #
478
+ # @example Basic example
479
+ # require "google/cloud/dataplex/v1"
480
+ #
481
+ # # Create a client object. The client can be reused for multiple calls.
482
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
483
+ #
484
+ # # Create a request. To set request fields, pass in keyword arguments.
485
+ # request = Google::Cloud::Dataplex::V1::GetEntityRequest.new
486
+ #
487
+ # # Call the get_entity method.
488
+ # result = client.get_entity request
489
+ #
490
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Entity.
491
+ # p result
492
+ #
429
493
  def get_entity request, options = nil
430
494
  raise ::ArgumentError, "request must be provided" if request.nil?
431
495
 
@@ -510,6 +574,26 @@ module Google
510
574
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entity>]
511
575
  #
512
576
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
577
+ #
578
+ # @example Basic example
579
+ # require "google/cloud/dataplex/v1"
580
+ #
581
+ # # Create a client object. The client can be reused for multiple calls.
582
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
583
+ #
584
+ # # Create a request. To set request fields, pass in keyword arguments.
585
+ # request = Google::Cloud::Dataplex::V1::ListEntitiesRequest.new
586
+ #
587
+ # # Call the list_entities method.
588
+ # result = client.list_entities request
589
+ #
590
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
591
+ # # over elements, and API calls will be issued to fetch pages as needed.
592
+ # result.each do |item|
593
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::Entity.
594
+ # p item
595
+ # end
596
+ #
513
597
  def list_entities request, options = nil
514
598
  raise ::ArgumentError, "request must be provided" if request.nil?
515
599
 
@@ -579,6 +663,22 @@ module Google
579
663
  # @return [::Google::Cloud::Dataplex::V1::Partition]
580
664
  #
581
665
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
666
+ #
667
+ # @example Basic example
668
+ # require "google/cloud/dataplex/v1"
669
+ #
670
+ # # Create a client object. The client can be reused for multiple calls.
671
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
672
+ #
673
+ # # Create a request. To set request fields, pass in keyword arguments.
674
+ # request = Google::Cloud::Dataplex::V1::CreatePartitionRequest.new
675
+ #
676
+ # # Call the create_partition method.
677
+ # result = client.create_partition request
678
+ #
679
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Partition.
680
+ # p result
681
+ #
582
682
  def create_partition request, options = nil
583
683
  raise ::ArgumentError, "request must be provided" if request.nil?
584
684
 
@@ -647,6 +747,22 @@ module Google
647
747
  # @return [::Google::Protobuf::Empty]
648
748
  #
649
749
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
750
+ #
751
+ # @example Basic example
752
+ # require "google/cloud/dataplex/v1"
753
+ #
754
+ # # Create a client object. The client can be reused for multiple calls.
755
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
756
+ #
757
+ # # Create a request. To set request fields, pass in keyword arguments.
758
+ # request = Google::Cloud::Dataplex::V1::DeletePartitionRequest.new
759
+ #
760
+ # # Call the delete_partition method.
761
+ # result = client.delete_partition request
762
+ #
763
+ # # The returned object is of type Google::Protobuf::Empty.
764
+ # p result
765
+ #
650
766
  def delete_partition request, options = nil
651
767
  raise ::ArgumentError, "request must be provided" if request.nil?
652
768
 
@@ -712,6 +828,22 @@ module Google
712
828
  # @return [::Google::Cloud::Dataplex::V1::Partition]
713
829
  #
714
830
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
831
+ #
832
+ # @example Basic example
833
+ # require "google/cloud/dataplex/v1"
834
+ #
835
+ # # Create a client object. The client can be reused for multiple calls.
836
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
837
+ #
838
+ # # Create a request. To set request fields, pass in keyword arguments.
839
+ # request = Google::Cloud::Dataplex::V1::GetPartitionRequest.new
840
+ #
841
+ # # Call the get_partition method.
842
+ # result = client.get_partition request
843
+ #
844
+ # # The returned object is of type Google::Cloud::Dataplex::V1::Partition.
845
+ # p result
846
+ #
715
847
  def get_partition request, options = nil
716
848
  raise ::ArgumentError, "request must be provided" if request.nil?
717
849
 
@@ -805,6 +937,26 @@ module Google
805
937
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Partition>]
806
938
  #
807
939
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
940
+ #
941
+ # @example Basic example
942
+ # require "google/cloud/dataplex/v1"
943
+ #
944
+ # # Create a client object. The client can be reused for multiple calls.
945
+ # client = Google::Cloud::Dataplex::V1::MetadataService::Rest::Client.new
946
+ #
947
+ # # Create a request. To set request fields, pass in keyword arguments.
948
+ # request = Google::Cloud::Dataplex::V1::ListPartitionsRequest.new
949
+ #
950
+ # # Call the list_partitions method.
951
+ # result = client.list_partitions request
952
+ #
953
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
954
+ # # over elements, and API calls will be issued to fetch pages as needed.
955
+ # result.each do |item|
956
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::Partition.
957
+ # p item
958
+ # end
959
+ #
808
960
  def list_partitions request, options = nil
809
961
  raise ::ArgumentError, "request must be provided" if request.nil?
810
962
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dataplex
23
23
  module V1
24
- VERSION = "0.10.1"
24
+ VERSION = "0.12.0"
25
25
  end
26
26
  end
27
27
  end
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dataplex-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.1
4
+ version: 0.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-15 00:00:00.000000000 Z
11
+ date: 2023-09-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.20.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.20.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
320
320
  - !ruby/object:Gem::Version
321
321
  version: '0'
322
322
  requirements: []
323
- rubygems_version: 3.4.2
323
+ rubygems_version: 3.4.19
324
324
  signing_key:
325
325
  specification_version: 4
326
326
  summary: Dataplex API is used to manage the lifecycle of data lakes.