google-cloud-dataplex-v1 0.7.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dataplex/v1/analyze_pb.rb +26 -81
  4. data/lib/google/cloud/dataplex/v1/content_pb.rb +26 -33
  5. data/lib/google/cloud/dataplex/v1/content_service/client.rb +6 -4
  6. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +6 -4
  7. data/lib/google/cloud/dataplex/v1/content_service/rest/service_stub.rb +8 -8
  8. data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +26 -50
  9. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +25 -74
  10. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +16 -8
  11. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +5 -3
  12. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +16 -8
  13. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +9 -7
  14. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +8 -8
  15. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +99 -4
  16. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +5 -3
  17. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +76 -4
  18. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +9 -7
  19. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +92 -32
  20. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +31 -121
  21. data/lib/google/cloud/dataplex/v1/logs_pb.rb +26 -151
  22. data/lib/google/cloud/dataplex/v1/metadata_pb.rb +27 -191
  23. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +6 -4
  24. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +6 -4
  25. data/lib/google/cloud/dataplex/v1/metadata_service/rest/service_stub.rb +9 -9
  26. data/lib/google/cloud/dataplex/v1/processing_pb.rb +24 -27
  27. data/lib/google/cloud/dataplex/v1/resources_pb.rb +27 -238
  28. data/lib/google/cloud/dataplex/v1/rest.rb +1 -1
  29. data/lib/google/cloud/dataplex/v1/service_pb.rb +31 -196
  30. data/lib/google/cloud/dataplex/v1/service_services_pb.rb +2 -0
  31. data/lib/google/cloud/dataplex/v1/tasks_pb.rb +26 -113
  32. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  33. data/lib/google/cloud/dataplex/v1.rb +1 -1
  34. data/proto_docs/google/api/client.rb +67 -4
  35. data/proto_docs/google/cloud/dataplex/v1/analyze.rb +4 -0
  36. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +64 -87
  37. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +54 -32
  38. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +10 -2
  39. data/proto_docs/google/cloud/dataplex/v1/metadata.rb +31 -2
  40. data/proto_docs/google/cloud/dataplex/v1/processing.rb +23 -13
  41. data/proto_docs/google/cloud/dataplex/v1/resources.rb +24 -6
  42. data/proto_docs/google/cloud/dataplex/v1/service.rb +17 -0
  43. data/proto_docs/google/cloud/dataplex/v1/tasks.rb +2 -3
  44. data/proto_docs/google/protobuf/any.rb +7 -4
  45. data/proto_docs/google/protobuf/timestamp.rb +1 -3
  46. metadata +4 -4
@@ -127,7 +127,7 @@ module Google
127
127
  credentials = @config.credentials
128
128
  # Use self-signed JWT if the endpoint is unchanged from default,
129
129
  # but only if the default endpoint does not have a region prefix.
130
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
130
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
131
131
  !@config.endpoint.split(".").first.include?("-")
132
132
  credentials ||= Credentials.default scope: @config.scope,
133
133
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -200,7 +200,7 @@ module Google
200
200
  # @param options [::Gapic::CallOptions, ::Hash]
201
201
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
202
202
  #
203
- # @overload create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil)
203
+ # @overload create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil, validate_only: nil)
204
204
  # Pass arguments to `create_data_scan` via keyword arguments. Note that at
205
205
  # least one keyword argument is required. To specify no parameters, or to keep all
206
206
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -220,6 +220,9 @@ module Google
220
220
  # * Must end with a number or a letter.
221
221
  # * Must be between 1-63 characters.
222
222
  # * Must be unique within the customer project / location.
223
+ # @param validate_only [::Boolean]
224
+ # Optional. Only validate the request, but do not perform mutations.
225
+ # The default is `false`.
223
226
  #
224
227
  # @yield [response, operation] Access the result along with the RPC operation
225
228
  # @yieldparam response [::Gapic::Operation]
@@ -306,7 +309,7 @@ module Google
306
309
  # @param options [::Gapic::CallOptions, ::Hash]
307
310
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
308
311
  #
309
- # @overload update_data_scan(data_scan: nil, update_mask: nil)
312
+ # @overload update_data_scan(data_scan: nil, update_mask: nil, validate_only: nil)
310
313
  # Pass arguments to `update_data_scan` via keyword arguments. Note that at
311
314
  # least one keyword argument is required. To specify no parameters, or to keep all
312
315
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -317,6 +320,9 @@ module Google
317
320
  # Only fields specified in `update_mask` are updated.
318
321
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
319
322
  # Required. Mask of fields to update.
323
+ # @param validate_only [::Boolean]
324
+ # Optional. Only validate the request, but do not perform mutations.
325
+ # The default is `false`.
320
326
  #
321
327
  # @yield [response, operation] Access the result along with the RPC operation
322
328
  # @yieldparam response [::Gapic::Operation]
@@ -601,7 +607,7 @@ module Google
601
607
  # `location_id` refers to a GCP region.
602
608
  # @param page_size [::Integer]
603
609
  # Optional. Maximum number of dataScans to return. The service may return
604
- # fewer than this value. If unspecified, at most 10 scans will be returned.
610
+ # fewer than this value. If unspecified, at most 500 scans will be returned.
605
611
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
606
612
  # @param page_token [::String]
607
613
  # Optional. Page token received from a previous `ListDataScans` call. Provide
@@ -793,7 +799,7 @@ module Google
793
799
  #
794
800
  # @param name [::String]
795
801
  # Required. The resource name of the DataScanJob:
796
- # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
802
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}`
797
803
  # where `project` refers to a *project_id* or *project_number* and
798
804
  # `location_id` refers to a GCP region.
799
805
  # @param view [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
@@ -1004,9 +1010,9 @@ module Google
1004
1010
  # * (`String`) The path to a service account key file in JSON format
1005
1011
  # * (`Hash`) A service account key as a Hash
1006
1012
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1007
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1013
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1008
1014
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1009
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1015
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1010
1016
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1011
1017
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1012
1018
  # * (`nil`) indicating no credentials
@@ -1048,7 +1054,9 @@ module Google
1048
1054
  class Configuration
1049
1055
  extend ::Gapic::Config
1050
1056
 
1051
- config_attr :endpoint, "dataplex.googleapis.com", ::String
1057
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
1058
+
1059
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1052
1060
  config_attr :credentials, nil do |value|
1053
1061
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1054
1062
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -620,9 +620,9 @@ module Google
620
620
  # * (`String`) The path to a service account key file in JSON format
621
621
  # * (`Hash`) A service account key as a Hash
622
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
623
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
624
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
625
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
626
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
627
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
628
628
  # * (`nil`) indicating no credentials
@@ -664,7 +664,9 @@ module Google
664
664
  class Configuration
665
665
  extend ::Gapic::Config
666
666
 
667
- config_attr :endpoint, "dataplex.googleapis.com", ::String
667
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
668
+
669
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
668
670
  config_attr :credentials, nil do |value|
669
671
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
670
672
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -123,7 +123,7 @@ module Google
123
123
  credentials = @config.credentials
124
124
  # Use self-signed JWT if the endpoint is unchanged from default,
125
125
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
126
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
127
  !@config.endpoint.split(".").first.include?("-")
128
128
  credentials ||= Credentials.default scope: @config.scope,
129
129
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -193,7 +193,7 @@ module Google
193
193
  # @param options [::Gapic::CallOptions, ::Hash]
194
194
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
195
195
  #
196
- # @overload create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil)
196
+ # @overload create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil, validate_only: nil)
197
197
  # Pass arguments to `create_data_scan` via keyword arguments. Note that at
198
198
  # least one keyword argument is required. To specify no parameters, or to keep all
199
199
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -213,6 +213,9 @@ module Google
213
213
  # * Must end with a number or a letter.
214
214
  # * Must be between 1-63 characters.
215
215
  # * Must be unique within the customer project / location.
216
+ # @param validate_only [::Boolean]
217
+ # Optional. Only validate the request, but do not perform mutations.
218
+ # The default is `false`.
216
219
  # @yield [result, operation] Access the result along with the TransportOperation object
217
220
  # @yieldparam result [::Gapic::Operation]
218
221
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -269,7 +272,7 @@ module Google
269
272
  # @param options [::Gapic::CallOptions, ::Hash]
270
273
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
271
274
  #
272
- # @overload update_data_scan(data_scan: nil, update_mask: nil)
275
+ # @overload update_data_scan(data_scan: nil, update_mask: nil, validate_only: nil)
273
276
  # Pass arguments to `update_data_scan` via keyword arguments. Note that at
274
277
  # least one keyword argument is required. To specify no parameters, or to keep all
275
278
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -280,6 +283,9 @@ module Google
280
283
  # Only fields specified in `update_mask` are updated.
281
284
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
282
285
  # Required. Mask of fields to update.
286
+ # @param validate_only [::Boolean]
287
+ # Optional. Only validate the request, but do not perform mutations.
288
+ # The default is `false`.
283
289
  # @yield [result, operation] Access the result along with the TransportOperation object
284
290
  # @yieldparam result [::Gapic::Operation]
285
291
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -481,7 +487,7 @@ module Google
481
487
  # `location_id` refers to a GCP region.
482
488
  # @param page_size [::Integer]
483
489
  # Optional. Maximum number of dataScans to return. The service may return
484
- # fewer than this value. If unspecified, at most 10 scans will be returned.
490
+ # fewer than this value. If unspecified, at most 500 scans will be returned.
485
491
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
486
492
  # @param page_token [::String]
487
493
  # Optional. Page token received from a previous `ListDataScans` call. Provide
@@ -622,7 +628,7 @@ module Google
622
628
  #
623
629
  # @param name [::String]
624
630
  # Required. The resource name of the DataScanJob:
625
- # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
631
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}`
626
632
  # where `project` refers to a *project_id* or *project_number* and
627
633
  # `location_id` refers to a GCP region.
628
634
  # @param view [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
@@ -783,9 +789,9 @@ module Google
783
789
  # * (`String`) The path to a service account key file in JSON format
784
790
  # * (`Hash`) A service account key as a Hash
785
791
  # * (`Google::Auth::Credentials`) A googleauth credentials object
786
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
792
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
787
793
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
788
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
794
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
789
795
  # * (`nil`) indicating no credentials
790
796
  # @return [::Object]
791
797
  # @!attribute [rw] scope
@@ -818,7 +824,9 @@ module Google
818
824
  class Configuration
819
825
  extend ::Gapic::Config
820
826
 
821
- config_attr :endpoint, "dataplex.googleapis.com", ::String
827
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
828
+
829
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
822
830
  config_attr :credentials, nil do |value|
823
831
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
824
832
  allowed.any? { |klass| klass === value }
@@ -411,9 +411,9 @@ module Google
411
411
  # * (`String`) The path to a service account key file in JSON format
412
412
  # * (`Hash`) A service account key as a Hash
413
413
  # * (`Google::Auth::Credentials`) A googleauth credentials object
414
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
414
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
415
415
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
416
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
416
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
417
417
  # * (`nil`) indicating no credentials
418
418
  # @return [::Object]
419
419
  # @!attribute [rw] scope
@@ -446,7 +446,9 @@ module Google
446
446
  class Configuration
447
447
  extend ::Gapic::Config
448
448
 
449
- config_attr :endpoint, "dataplex.googleapis.com", ::String
449
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
450
+
451
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
450
452
  config_attr :credentials, nil do |value|
451
453
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
452
454
  allowed.any? { |klass| klass === value }
@@ -567,7 +569,7 @@ module Google
567
569
 
568
570
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_list_operations_request request_pb
569
571
  query_string_params = if query_string_params.any?
570
- query_string_params.to_h { |p| p.split("=", 2) }
572
+ query_string_params.to_h { |p| p.split "=", 2 }
571
573
  else
572
574
  {}
573
575
  end
@@ -605,7 +607,7 @@ module Google
605
607
 
606
608
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_get_operation_request request_pb
607
609
  query_string_params = if query_string_params.any?
608
- query_string_params.to_h { |p| p.split("=", 2) }
610
+ query_string_params.to_h { |p| p.split "=", 2 }
609
611
  else
610
612
  {}
611
613
  end
@@ -643,7 +645,7 @@ module Google
643
645
 
644
646
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_delete_operation_request request_pb
645
647
  query_string_params = if query_string_params.any?
646
- query_string_params.to_h { |p| p.split("=", 2) }
648
+ query_string_params.to_h { |p| p.split "=", 2 }
647
649
  else
648
650
  {}
649
651
  end
@@ -681,7 +683,7 @@ module Google
681
683
 
682
684
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_cancel_operation_request request_pb
683
685
  query_string_params = if query_string_params.any?
684
- query_string_params.to_h { |p| p.split("=", 2) }
686
+ query_string_params.to_h { |p| p.split "=", 2 }
685
687
  else
686
688
  {}
687
689
  end
@@ -59,7 +59,7 @@ module Google
59
59
 
60
60
  verb, uri, query_string_params, body = ServiceStub.transcode_create_data_scan_request request_pb
61
61
  query_string_params = if query_string_params.any?
62
- query_string_params.to_h { |p| p.split("=", 2) }
62
+ query_string_params.to_h { |p| p.split "=", 2 }
63
63
  else
64
64
  {}
65
65
  end
@@ -97,7 +97,7 @@ module Google
97
97
 
98
98
  verb, uri, query_string_params, body = ServiceStub.transcode_update_data_scan_request request_pb
99
99
  query_string_params = if query_string_params.any?
100
- query_string_params.to_h { |p| p.split("=", 2) }
100
+ query_string_params.to_h { |p| p.split "=", 2 }
101
101
  else
102
102
  {}
103
103
  end
@@ -135,7 +135,7 @@ module Google
135
135
 
136
136
  verb, uri, query_string_params, body = ServiceStub.transcode_delete_data_scan_request request_pb
137
137
  query_string_params = if query_string_params.any?
138
- query_string_params.to_h { |p| p.split("=", 2) }
138
+ query_string_params.to_h { |p| p.split "=", 2 }
139
139
  else
140
140
  {}
141
141
  end
@@ -173,7 +173,7 @@ module Google
173
173
 
174
174
  verb, uri, query_string_params, body = ServiceStub.transcode_get_data_scan_request request_pb
175
175
  query_string_params = if query_string_params.any?
176
- query_string_params.to_h { |p| p.split("=", 2) }
176
+ query_string_params.to_h { |p| p.split "=", 2 }
177
177
  else
178
178
  {}
179
179
  end
@@ -211,7 +211,7 @@ module Google
211
211
 
212
212
  verb, uri, query_string_params, body = ServiceStub.transcode_list_data_scans_request request_pb
213
213
  query_string_params = if query_string_params.any?
214
- query_string_params.to_h { |p| p.split("=", 2) }
214
+ query_string_params.to_h { |p| p.split "=", 2 }
215
215
  else
216
216
  {}
217
217
  end
@@ -249,7 +249,7 @@ module Google
249
249
 
250
250
  verb, uri, query_string_params, body = ServiceStub.transcode_run_data_scan_request request_pb
251
251
  query_string_params = if query_string_params.any?
252
- query_string_params.to_h { |p| p.split("=", 2) }
252
+ query_string_params.to_h { |p| p.split "=", 2 }
253
253
  else
254
254
  {}
255
255
  end
@@ -287,7 +287,7 @@ module Google
287
287
 
288
288
  verb, uri, query_string_params, body = ServiceStub.transcode_get_data_scan_job_request request_pb
289
289
  query_string_params = if query_string_params.any?
290
- query_string_params.to_h { |p| p.split("=", 2) }
290
+ query_string_params.to_h { |p| p.split "=", 2 }
291
291
  else
292
292
  {}
293
293
  end
@@ -325,7 +325,7 @@ module Google
325
325
 
326
326
  verb, uri, query_string_params, body = ServiceStub.transcode_list_data_scan_jobs_request request_pb
327
327
  query_string_params = if query_string_params.any?
328
- query_string_params.to_h { |p| p.split("=", 2) }
328
+ query_string_params.to_h { |p| p.split "=", 2 }
329
329
  else
330
330
  {}
331
331
  end
@@ -236,7 +236,7 @@ module Google
236
236
  credentials = @config.credentials
237
237
  # Use self-signed JWT if the endpoint is unchanged from default,
238
238
  # but only if the default endpoint does not have a region prefix.
239
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
239
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
240
240
  !@config.endpoint.split(".").first.include?("-")
241
241
  credentials ||= Credentials.default scope: @config.scope,
242
242
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -2656,6 +2656,92 @@ module Google
2656
2656
  raise ::Google::Cloud::Error.from_error(e)
2657
2657
  end
2658
2658
 
2659
+ ##
2660
+ # Run an on demand execution of a Task.
2661
+ #
2662
+ # @overload run_task(request, options = nil)
2663
+ # Pass arguments to `run_task` via a request object, either of type
2664
+ # {::Google::Cloud::Dataplex::V1::RunTaskRequest} or an equivalent Hash.
2665
+ #
2666
+ # @param request [::Google::Cloud::Dataplex::V1::RunTaskRequest, ::Hash]
2667
+ # A request object representing the call parameters. Required. To specify no
2668
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2669
+ # @param options [::Gapic::CallOptions, ::Hash]
2670
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2671
+ #
2672
+ # @overload run_task(name: nil)
2673
+ # Pass arguments to `run_task` via keyword arguments. Note that at
2674
+ # least one keyword argument is required. To specify no parameters, or to keep all
2675
+ # the default parameter values, pass an empty Hash as a request object (see above).
2676
+ #
2677
+ # @param name [::String]
2678
+ # Required. The resource name of the task:
2679
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
2680
+ #
2681
+ # @yield [response, operation] Access the result along with the RPC operation
2682
+ # @yieldparam response [::Google::Cloud::Dataplex::V1::RunTaskResponse]
2683
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2684
+ #
2685
+ # @return [::Google::Cloud::Dataplex::V1::RunTaskResponse]
2686
+ #
2687
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2688
+ #
2689
+ # @example Basic example
2690
+ # require "google/cloud/dataplex/v1"
2691
+ #
2692
+ # # Create a client object. The client can be reused for multiple calls.
2693
+ # client = Google::Cloud::Dataplex::V1::DataplexService::Client.new
2694
+ #
2695
+ # # Create a request. To set request fields, pass in keyword arguments.
2696
+ # request = Google::Cloud::Dataplex::V1::RunTaskRequest.new
2697
+ #
2698
+ # # Call the run_task method.
2699
+ # result = client.run_task request
2700
+ #
2701
+ # # The returned object is of type Google::Cloud::Dataplex::V1::RunTaskResponse.
2702
+ # p result
2703
+ #
2704
+ def run_task request, options = nil
2705
+ raise ::ArgumentError, "request must be provided" if request.nil?
2706
+
2707
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::RunTaskRequest
2708
+
2709
+ # Converts hash and nil to an options object
2710
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2711
+
2712
+ # Customize the options with defaults
2713
+ metadata = @config.rpcs.run_task.metadata.to_h
2714
+
2715
+ # Set x-goog-api-client and x-goog-user-project headers
2716
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2717
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2718
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2719
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2720
+
2721
+ header_params = {}
2722
+ if request.name
2723
+ header_params["name"] = request.name
2724
+ end
2725
+
2726
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2727
+ metadata[:"x-goog-request-params"] ||= request_params_header
2728
+
2729
+ options.apply_defaults timeout: @config.rpcs.run_task.timeout,
2730
+ metadata: metadata,
2731
+ retry_policy: @config.rpcs.run_task.retry_policy
2732
+
2733
+ options.apply_defaults timeout: @config.timeout,
2734
+ metadata: @config.metadata,
2735
+ retry_policy: @config.retry_policy
2736
+
2737
+ @dataplex_service_stub.call_rpc :run_task, request, options: options do |response, operation|
2738
+ yield response, operation if block_given?
2739
+ return response
2740
+ end
2741
+ rescue ::GRPC::BadStatus => e
2742
+ raise ::Google::Cloud::Error.from_error(e)
2743
+ end
2744
+
2659
2745
  ##
2660
2746
  # Get job resource.
2661
2747
  #
@@ -3467,9 +3553,9 @@ module Google
3467
3553
  # * (`String`) The path to a service account key file in JSON format
3468
3554
  # * (`Hash`) A service account key as a Hash
3469
3555
  # * (`Google::Auth::Credentials`) A googleauth credentials object
3470
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
3556
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
3471
3557
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
3472
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
3558
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
3473
3559
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
3474
3560
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
3475
3561
  # * (`nil`) indicating no credentials
@@ -3511,7 +3597,9 @@ module Google
3511
3597
  class Configuration
3512
3598
  extend ::Gapic::Config
3513
3599
 
3514
- config_attr :endpoint, "dataplex.googleapis.com", ::String
3600
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
3601
+
3602
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3515
3603
  config_attr :credentials, nil do |value|
3516
3604
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3517
3605
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3685,6 +3773,11 @@ module Google
3685
3773
  #
3686
3774
  attr_reader :list_jobs
3687
3775
  ##
3776
+ # RPC-specific configuration for `run_task`
3777
+ # @return [::Gapic::Config::Method]
3778
+ #
3779
+ attr_reader :run_task
3780
+ ##
3688
3781
  # RPC-specific configuration for `get_job`
3689
3782
  # @return [::Gapic::Config::Method]
3690
3783
  #
@@ -3775,6 +3868,8 @@ module Google
3775
3868
  @get_task = ::Gapic::Config::Method.new get_task_config
3776
3869
  list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
3777
3870
  @list_jobs = ::Gapic::Config::Method.new list_jobs_config
3871
+ run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
3872
+ @run_task = ::Gapic::Config::Method.new run_task_config
3778
3873
  get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
3779
3874
  @get_job = ::Gapic::Config::Method.new get_job_config
3780
3875
  cancel_job_config = parent_rpcs.cancel_job if parent_rpcs.respond_to? :cancel_job
@@ -620,9 +620,9 @@ module Google
620
620
  # * (`String`) The path to a service account key file in JSON format
621
621
  # * (`Hash`) A service account key as a Hash
622
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
623
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
624
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
625
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
626
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
627
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
628
628
  # * (`nil`) indicating no credentials
@@ -664,7 +664,9 @@ module Google
664
664
  class Configuration
665
665
  extend ::Gapic::Config
666
666
 
667
- config_attr :endpoint, "dataplex.googleapis.com", ::String
667
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
668
+
669
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
668
670
  config_attr :credentials, nil do |value|
669
671
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
670
672
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -232,7 +232,7 @@ module Google
232
232
  credentials = @config.credentials
233
233
  # Use self-signed JWT if the endpoint is unchanged from default,
234
234
  # but only if the default endpoint does not have a region prefix.
235
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
235
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
236
236
  !@config.endpoint.split(".").first.include?("-")
237
237
  credentials ||= Credentials.default scope: @config.scope,
238
238
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -1979,6 +1979,69 @@ module Google
1979
1979
  raise ::Google::Cloud::Error.from_error(e)
1980
1980
  end
1981
1981
 
1982
+ ##
1983
+ # Run an on demand execution of a Task.
1984
+ #
1985
+ # @overload run_task(request, options = nil)
1986
+ # Pass arguments to `run_task` via a request object, either of type
1987
+ # {::Google::Cloud::Dataplex::V1::RunTaskRequest} or an equivalent Hash.
1988
+ #
1989
+ # @param request [::Google::Cloud::Dataplex::V1::RunTaskRequest, ::Hash]
1990
+ # A request object representing the call parameters. Required. To specify no
1991
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1992
+ # @param options [::Gapic::CallOptions, ::Hash]
1993
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1994
+ #
1995
+ # @overload run_task(name: nil)
1996
+ # Pass arguments to `run_task` via keyword arguments. Note that at
1997
+ # least one keyword argument is required. To specify no parameters, or to keep all
1998
+ # the default parameter values, pass an empty Hash as a request object (see above).
1999
+ #
2000
+ # @param name [::String]
2001
+ # Required. The resource name of the task:
2002
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
2003
+ # @yield [result, operation] Access the result along with the TransportOperation object
2004
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::RunTaskResponse]
2005
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2006
+ #
2007
+ # @return [::Google::Cloud::Dataplex::V1::RunTaskResponse]
2008
+ #
2009
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2010
+ def run_task request, options = nil
2011
+ raise ::ArgumentError, "request must be provided" if request.nil?
2012
+
2013
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::RunTaskRequest
2014
+
2015
+ # Converts hash and nil to an options object
2016
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2017
+
2018
+ # Customize the options with defaults
2019
+ call_metadata = @config.rpcs.run_task.metadata.to_h
2020
+
2021
+ # Set x-goog-api-client and x-goog-user-project headers
2022
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2023
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2024
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2025
+ transports_version_send: [:rest]
2026
+
2027
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2028
+
2029
+ options.apply_defaults timeout: @config.rpcs.run_task.timeout,
2030
+ metadata: call_metadata,
2031
+ retry_policy: @config.rpcs.run_task.retry_policy
2032
+
2033
+ options.apply_defaults timeout: @config.timeout,
2034
+ metadata: @config.metadata,
2035
+ retry_policy: @config.retry_policy
2036
+
2037
+ @dataplex_service_stub.run_task request, options do |result, operation|
2038
+ yield result, operation if block_given?
2039
+ return result
2040
+ end
2041
+ rescue ::Gapic::Rest::Error => e
2042
+ raise ::Google::Cloud::Error.from_error(e)
2043
+ end
2044
+
1982
2045
  ##
1983
2046
  # Get job resource.
1984
2047
  #
@@ -2577,9 +2640,9 @@ module Google
2577
2640
  # * (`String`) The path to a service account key file in JSON format
2578
2641
  # * (`Hash`) A service account key as a Hash
2579
2642
  # * (`Google::Auth::Credentials`) A googleauth credentials object
2580
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
2643
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2581
2644
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2582
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
2645
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2583
2646
  # * (`nil`) indicating no credentials
2584
2647
  # @return [::Object]
2585
2648
  # @!attribute [rw] scope
@@ -2612,7 +2675,9 @@ module Google
2612
2675
  class Configuration
2613
2676
  extend ::Gapic::Config
2614
2677
 
2615
- config_attr :endpoint, "dataplex.googleapis.com", ::String
2678
+ DEFAULT_ENDPOINT = "dataplex.googleapis.com"
2679
+
2680
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2616
2681
  config_attr :credentials, nil do |value|
2617
2682
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2618
2683
  allowed.any? { |klass| klass === value }
@@ -2790,6 +2855,11 @@ module Google
2790
2855
  #
2791
2856
  attr_reader :list_jobs
2792
2857
  ##
2858
+ # RPC-specific configuration for `run_task`
2859
+ # @return [::Gapic::Config::Method]
2860
+ #
2861
+ attr_reader :run_task
2862
+ ##
2793
2863
  # RPC-specific configuration for `get_job`
2794
2864
  # @return [::Gapic::Config::Method]
2795
2865
  #
@@ -2880,6 +2950,8 @@ module Google
2880
2950
  @get_task = ::Gapic::Config::Method.new get_task_config
2881
2951
  list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
2882
2952
  @list_jobs = ::Gapic::Config::Method.new list_jobs_config
2953
+ run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
2954
+ @run_task = ::Gapic::Config::Method.new run_task_config
2883
2955
  get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
2884
2956
  @get_job = ::Gapic::Config::Method.new get_job_config
2885
2957
  cancel_job_config = parent_rpcs.cancel_job if parent_rpcs.respond_to? :cancel_job