google-cloud-dataplex-v1 1.0.1 → 1.2.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 (51) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -20
  3. data/lib/google/cloud/dataplex/v1/bindings_override.rb +120 -0
  4. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +17 -1
  5. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +626 -144
  6. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +12 -15
  7. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
  8. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +592 -144
  9. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +72 -38
  10. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +435 -133
  11. data/lib/google/cloud/dataplex/v1/catalog_service/rest.rb +4 -4
  12. data/lib/google/cloud/dataplex/v1/catalog_service.rb +4 -4
  13. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +44 -20
  14. data/lib/google/cloud/dataplex/v1/content_service/client.rb +30 -9
  15. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +30 -9
  16. data/lib/google/cloud/dataplex/v1/content_service/rest/service_stub.rb +78 -50
  17. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +52 -0
  18. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +1 -1
  19. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +34 -10
  20. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +12 -15
  21. data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +36 -0
  22. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +33 -10
  23. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +72 -38
  24. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +86 -56
  25. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +41 -16
  26. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +12 -15
  27. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +38 -16
  28. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +72 -38
  29. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/service_stub.rb +134 -92
  30. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +54 -34
  31. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +12 -15
  32. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +52 -34
  33. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +72 -38
  34. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +278 -200
  35. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +3 -1
  36. data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -1
  37. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +31 -10
  38. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +31 -10
  39. data/lib/google/cloud/dataplex/v1/metadata_service/rest/service_stub.rb +86 -56
  40. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  41. data/proto_docs/google/api/client.rb +39 -0
  42. data/proto_docs/google/api/field_info.rb +88 -0
  43. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +710 -234
  44. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +156 -0
  45. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +4 -4
  46. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +7 -2
  47. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +30 -12
  48. data/proto_docs/google/cloud/dataplex/v1/logs.rb +51 -1
  49. data/proto_docs/google/cloud/dataplex/v1/tasks.rb +3 -4
  50. data/proto_docs/google/longrunning/operations.rb +19 -14
  51. metadata +8 -5
@@ -30,10 +30,10 @@ module Google
30
30
  # Client for the CatalogService service.
31
31
  #
32
32
  # The primary resources offered by this service are EntryGroups, EntryTypes,
33
- # AspectTypes, Entry and Aspect which collectively allow a data administrator
34
- # to organize, manage, secure and catalog data across their organization
35
- # located across cloud projects in a variety of storage systems including Cloud
36
- # Storage and BigQuery.
33
+ # AspectTypes, and Entries. They collectively let data administrators organize,
34
+ # manage, secure, and catalog data located across cloud projects in their
35
+ # organization in a variety of storage systems, including Cloud Storage and
36
+ # BigQuery.
37
37
  #
38
38
  class Client
39
39
  # @private
@@ -247,14 +247,26 @@ module Google
247
247
  universe_domain: @config.universe_domain,
248
248
  channel_args: @config.channel_args,
249
249
  interceptors: @config.interceptors,
250
- channel_pool_config: @config.channel_pool
250
+ channel_pool_config: @config.channel_pool,
251
+ logger: @config.logger
251
252
  )
252
253
 
254
+ @catalog_service_stub.stub_logger&.info do |entry|
255
+ entry.set_system_name
256
+ entry.set_service
257
+ entry.message = "Created client for #{entry.service}"
258
+ entry.set_credentials_fields credentials
259
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
260
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
261
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
262
+ end
263
+
253
264
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
254
265
  config.credentials = credentials
255
266
  config.quota_project = @quota_project_id
256
267
  config.endpoint = @catalog_service_stub.endpoint
257
268
  config.universe_domain = @catalog_service_stub.universe_domain
269
+ config.logger = @catalog_service_stub.logger if config.respond_to? :logger=
258
270
  end
259
271
 
260
272
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
@@ -262,6 +274,7 @@ module Google
262
274
  config.quota_project = @quota_project_id
263
275
  config.endpoint = @catalog_service_stub.endpoint
264
276
  config.universe_domain = @catalog_service_stub.universe_domain
277
+ config.logger = @catalog_service_stub.logger if config.respond_to? :logger=
265
278
  end
266
279
  end
267
280
 
@@ -286,10 +299,19 @@ module Google
286
299
  #
287
300
  attr_reader :iam_policy_client
288
301
 
302
+ ##
303
+ # The logger used for request/response debug logging.
304
+ #
305
+ # @return [Logger]
306
+ #
307
+ def logger
308
+ @catalog_service_stub.logger
309
+ end
310
+
289
311
  # Service calls
290
312
 
291
313
  ##
292
- # Creates an EntryType
314
+ # Creates an EntryType.
293
315
  #
294
316
  # @overload create_entry_type(request, options = nil)
295
317
  # Pass arguments to `create_entry_type` via a request object, either of type
@@ -309,14 +331,14 @@ module Google
309
331
  # @param parent [::String]
310
332
  # Required. The resource name of the EntryType, of the form:
311
333
  # projects/\\{project_number}/locations/\\{location_id}
312
- # where `location_id` refers to a GCP region.
334
+ # where `location_id` refers to a Google Cloud region.
313
335
  # @param entry_type_id [::String]
314
336
  # Required. EntryType identifier.
315
337
  # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
316
- # Required. EntryType Resource
338
+ # Required. EntryType Resource.
317
339
  # @param validate_only [::Boolean]
318
- # Optional. Only validate the request, but do not perform mutations.
319
- # The default is false.
340
+ # Optional. The service validates the request without performing any
341
+ # mutations. The default is false.
320
342
  #
321
343
  # @yield [response, operation] Access the result along with the RPC operation
322
344
  # @yieldparam response [::Gapic::Operation]
@@ -385,14 +407,14 @@ module Google
385
407
  @catalog_service_stub.call_rpc :create_entry_type, request, options: options do |response, operation|
386
408
  response = ::Gapic::Operation.new response, @operations_client, options: options
387
409
  yield response, operation if block_given?
388
- return response
410
+ throw :response, response
389
411
  end
390
412
  rescue ::GRPC::BadStatus => e
391
413
  raise ::Google::Cloud::Error.from_error(e)
392
414
  end
393
415
 
394
416
  ##
395
- # Updates a EntryType resource.
417
+ # Updates an EntryType.
396
418
  #
397
419
  # @overload update_entry_type(request, options = nil)
398
420
  # Pass arguments to `update_entry_type` via a request object, either of type
@@ -410,12 +432,12 @@ module Google
410
432
  # the default parameter values, pass an empty Hash as a request object (see above).
411
433
  #
412
434
  # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
413
- # Required. EntryType Resource
435
+ # Required. EntryType Resource.
414
436
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
415
437
  # Required. Mask of fields to update.
416
438
  # @param validate_only [::Boolean]
417
- # Optional. Only validate the request, but do not perform mutations.
418
- # The default is false.
439
+ # Optional. The service validates the request without performing any
440
+ # mutations. The default is false.
419
441
  #
420
442
  # @yield [response, operation] Access the result along with the RPC operation
421
443
  # @yieldparam response [::Gapic::Operation]
@@ -484,14 +506,14 @@ module Google
484
506
  @catalog_service_stub.call_rpc :update_entry_type, request, options: options do |response, operation|
485
507
  response = ::Gapic::Operation.new response, @operations_client, options: options
486
508
  yield response, operation if block_given?
487
- return response
509
+ throw :response, response
488
510
  end
489
511
  rescue ::GRPC::BadStatus => e
490
512
  raise ::Google::Cloud::Error.from_error(e)
491
513
  end
492
514
 
493
515
  ##
494
- # Deletes a EntryType resource.
516
+ # Deletes an EntryType.
495
517
  #
496
518
  # @overload delete_entry_type(request, options = nil)
497
519
  # Pass arguments to `delete_entry_type` via a request object, either of type
@@ -513,7 +535,7 @@ module Google
513
535
  # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
514
536
  # @param etag [::String]
515
537
  # Optional. If the client provided etag value does not match the current etag
516
- # value, the DeleteEntryTypeRequest method returns an ABORTED error response
538
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response.
517
539
  #
518
540
  # @yield [response, operation] Access the result along with the RPC operation
519
541
  # @yieldparam response [::Gapic::Operation]
@@ -582,7 +604,7 @@ module Google
582
604
  @catalog_service_stub.call_rpc :delete_entry_type, request, options: options do |response, operation|
583
605
  response = ::Gapic::Operation.new response, @operations_client, options: options
584
606
  yield response, operation if block_given?
585
- return response
607
+ throw :response, response
586
608
  end
587
609
  rescue ::GRPC::BadStatus => e
588
610
  raise ::Google::Cloud::Error.from_error(e)
@@ -609,27 +631,28 @@ module Google
609
631
  # @param parent [::String]
610
632
  # Required. The resource name of the EntryType location, of the form:
611
633
  # `projects/{project_number}/locations/{location_id}`
612
- # where `location_id` refers to a GCP region.
634
+ # where `location_id` refers to a Google Cloud region.
613
635
  # @param page_size [::Integer]
614
636
  # Optional. Maximum number of EntryTypes to return. The service may return
615
- # fewer than this value. If unspecified, at most 10 EntryTypes will be
616
- # returned. The maximum value is 1000; values above 1000 will be coerced to
637
+ # fewer than this value. If unspecified, the service returns at most 10
638
+ # EntryTypes. The maximum value is 1000; values above 1000 will be coerced to
617
639
  # 1000.
618
640
  # @param page_token [::String]
619
641
  # Optional. Page token received from a previous `ListEntryTypes` call.
620
642
  # Provide this to retrieve the subsequent page. When paginating, all other
621
- # parameters provided to `ListEntryTypes` must match the call that provided
622
- # the page token.
643
+ # parameters you provided to `ListEntryTypes` must match the call that
644
+ # provided the page token.
623
645
  # @param filter [::String]
624
646
  # Optional. Filter request. Filters are case-sensitive.
625
- # The following formats are supported:
647
+ # The service supports the following formats:
648
+ #
649
+ # * labels.key1 = "value1"
650
+ # * labels:key1
651
+ # * name = "value"
626
652
  #
627
- # labels.key1 = "value1"
628
- # labels:key1
629
- # name = "value"
630
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
653
+ # These restrictions can be conjoined with AND, OR, and NOT conjunctions.
631
654
  # @param order_by [::String]
632
- # Optional. Order by fields (`name` or `create_time`) for the result.
655
+ # Optional. Orders the result by `name` or `create_time` fields.
633
656
  # If not specified, the ordering is undefined.
634
657
  #
635
658
  # @yield [response, operation] Access the result along with the RPC operation
@@ -696,14 +719,14 @@ module Google
696
719
  @catalog_service_stub.call_rpc :list_entry_types, request, options: options do |response, operation|
697
720
  response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_entry_types, request, response, operation, options
698
721
  yield response, operation if block_given?
699
- return response
722
+ throw :response, response
700
723
  end
701
724
  rescue ::GRPC::BadStatus => e
702
725
  raise ::Google::Cloud::Error.from_error(e)
703
726
  end
704
727
 
705
728
  ##
706
- # Retrieves a EntryType resource.
729
+ # Gets an EntryType.
707
730
  #
708
731
  # @overload get_entry_type(request, options = nil)
709
732
  # Pass arguments to `get_entry_type` via a request object, either of type
@@ -783,14 +806,13 @@ module Google
783
806
 
784
807
  @catalog_service_stub.call_rpc :get_entry_type, request, options: options do |response, operation|
785
808
  yield response, operation if block_given?
786
- return response
787
809
  end
788
810
  rescue ::GRPC::BadStatus => e
789
811
  raise ::Google::Cloud::Error.from_error(e)
790
812
  end
791
813
 
792
814
  ##
793
- # Creates an AspectType
815
+ # Creates an AspectType.
794
816
  #
795
817
  # @overload create_aspect_type(request, options = nil)
796
818
  # Pass arguments to `create_aspect_type` via a request object, either of type
@@ -810,14 +832,14 @@ module Google
810
832
  # @param parent [::String]
811
833
  # Required. The resource name of the AspectType, of the form:
812
834
  # projects/\\{project_number}/locations/\\{location_id}
813
- # where `location_id` refers to a GCP region.
835
+ # where `location_id` refers to a Google Cloud region.
814
836
  # @param aspect_type_id [::String]
815
837
  # Required. AspectType identifier.
816
838
  # @param aspect_type [::Google::Cloud::Dataplex::V1::AspectType, ::Hash]
817
- # Required. AspectType Resource
839
+ # Required. AspectType Resource.
818
840
  # @param validate_only [::Boolean]
819
- # Optional. Only validate the request, but do not perform mutations.
820
- # The default is false.
841
+ # Optional. The service validates the request without performing any
842
+ # mutations. The default is false.
821
843
  #
822
844
  # @yield [response, operation] Access the result along with the RPC operation
823
845
  # @yieldparam response [::Gapic::Operation]
@@ -886,14 +908,14 @@ module Google
886
908
  @catalog_service_stub.call_rpc :create_aspect_type, request, options: options do |response, operation|
887
909
  response = ::Gapic::Operation.new response, @operations_client, options: options
888
910
  yield response, operation if block_given?
889
- return response
911
+ throw :response, response
890
912
  end
891
913
  rescue ::GRPC::BadStatus => e
892
914
  raise ::Google::Cloud::Error.from_error(e)
893
915
  end
894
916
 
895
917
  ##
896
- # Updates a AspectType resource.
918
+ # Updates an AspectType.
897
919
  #
898
920
  # @overload update_aspect_type(request, options = nil)
899
921
  # Pass arguments to `update_aspect_type` via a request object, either of type
@@ -985,14 +1007,14 @@ module Google
985
1007
  @catalog_service_stub.call_rpc :update_aspect_type, request, options: options do |response, operation|
986
1008
  response = ::Gapic::Operation.new response, @operations_client, options: options
987
1009
  yield response, operation if block_given?
988
- return response
1010
+ throw :response, response
989
1011
  end
990
1012
  rescue ::GRPC::BadStatus => e
991
1013
  raise ::Google::Cloud::Error.from_error(e)
992
1014
  end
993
1015
 
994
1016
  ##
995
- # Deletes a AspectType resource.
1017
+ # Deletes an AspectType.
996
1018
  #
997
1019
  # @overload delete_aspect_type(request, options = nil)
998
1020
  # Pass arguments to `delete_aspect_type` via a request object, either of type
@@ -1014,7 +1036,8 @@ module Google
1014
1036
  # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
1015
1037
  # @param etag [::String]
1016
1038
  # Optional. If the client provided etag value does not match the current etag
1017
- # value, the DeleteAspectTypeRequest method returns an ABORTED error response
1039
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error
1040
+ # response.
1018
1041
  #
1019
1042
  # @yield [response, operation] Access the result along with the RPC operation
1020
1043
  # @yieldparam response [::Gapic::Operation]
@@ -1083,7 +1106,7 @@ module Google
1083
1106
  @catalog_service_stub.call_rpc :delete_aspect_type, request, options: options do |response, operation|
1084
1107
  response = ::Gapic::Operation.new response, @operations_client, options: options
1085
1108
  yield response, operation if block_given?
1086
- return response
1109
+ throw :response, response
1087
1110
  end
1088
1111
  rescue ::GRPC::BadStatus => e
1089
1112
  raise ::Google::Cloud::Error.from_error(e)
@@ -1110,27 +1133,28 @@ module Google
1110
1133
  # @param parent [::String]
1111
1134
  # Required. The resource name of the AspectType location, of the form:
1112
1135
  # `projects/{project_number}/locations/{location_id}`
1113
- # where `location_id` refers to a GCP region.
1136
+ # where `location_id` refers to a Google Cloud region.
1114
1137
  # @param page_size [::Integer]
1115
1138
  # Optional. Maximum number of AspectTypes to return. The service may return
1116
- # fewer than this value. If unspecified, at most 10 AspectTypes will be
1117
- # returned. The maximum value is 1000; values above 1000 will be coerced to
1118
- # 1000.
1139
+ # fewer than this value. If unspecified, the service returns at most 10
1140
+ # AspectTypes. The maximum value is 1000; values above 1000 will be coerced
1141
+ # to 1000.
1119
1142
  # @param page_token [::String]
1120
1143
  # Optional. Page token received from a previous `ListAspectTypes` call.
1121
1144
  # Provide this to retrieve the subsequent page. When paginating, all other
1122
- # parameters provided to `ListAspectTypes` must match the call that provided
1123
- # the page token.
1145
+ # parameters you provide to `ListAspectTypes` must match the call that
1146
+ # provided the page token.
1124
1147
  # @param filter [::String]
1125
1148
  # Optional. Filter request. Filters are case-sensitive.
1126
- # The following formats are supported:
1149
+ # The service supports the following formats:
1150
+ #
1151
+ # * labels.key1 = "value1"
1152
+ # * labels:key1
1153
+ # * name = "value"
1127
1154
  #
1128
- # labels.key1 = "value1"
1129
- # labels:key1
1130
- # name = "value"
1131
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
1155
+ # These restrictions can be conjoined with AND, OR, and NOT conjunctions.
1132
1156
  # @param order_by [::String]
1133
- # Optional. Order by fields (`name` or `create_time`) for the result.
1157
+ # Optional. Orders the result by `name` or `create_time` fields.
1134
1158
  # If not specified, the ordering is undefined.
1135
1159
  #
1136
1160
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1197,14 +1221,14 @@ module Google
1197
1221
  @catalog_service_stub.call_rpc :list_aspect_types, request, options: options do |response, operation|
1198
1222
  response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_aspect_types, request, response, operation, options
1199
1223
  yield response, operation if block_given?
1200
- return response
1224
+ throw :response, response
1201
1225
  end
1202
1226
  rescue ::GRPC::BadStatus => e
1203
1227
  raise ::Google::Cloud::Error.from_error(e)
1204
1228
  end
1205
1229
 
1206
1230
  ##
1207
- # Retrieves a AspectType resource.
1231
+ # Gets an AspectType.
1208
1232
  #
1209
1233
  # @overload get_aspect_type(request, options = nil)
1210
1234
  # Pass arguments to `get_aspect_type` via a request object, either of type
@@ -1284,14 +1308,13 @@ module Google
1284
1308
 
1285
1309
  @catalog_service_stub.call_rpc :get_aspect_type, request, options: options do |response, operation|
1286
1310
  yield response, operation if block_given?
1287
- return response
1288
1311
  end
1289
1312
  rescue ::GRPC::BadStatus => e
1290
1313
  raise ::Google::Cloud::Error.from_error(e)
1291
1314
  end
1292
1315
 
1293
1316
  ##
1294
- # Creates an EntryGroup
1317
+ # Creates an EntryGroup.
1295
1318
  #
1296
1319
  # @overload create_entry_group(request, options = nil)
1297
1320
  # Pass arguments to `create_entry_group` via a request object, either of type
@@ -1315,10 +1338,10 @@ module Google
1315
1338
  # @param entry_group_id [::String]
1316
1339
  # Required. EntryGroup identifier.
1317
1340
  # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1318
- # Required. EntryGroup Resource
1341
+ # Required. EntryGroup Resource.
1319
1342
  # @param validate_only [::Boolean]
1320
- # Optional. Only validate the request, but do not perform mutations.
1321
- # The default is false.
1343
+ # Optional. The service validates the request without performing any
1344
+ # mutations. The default is false.
1322
1345
  #
1323
1346
  # @yield [response, operation] Access the result along with the RPC operation
1324
1347
  # @yieldparam response [::Gapic::Operation]
@@ -1387,14 +1410,14 @@ module Google
1387
1410
  @catalog_service_stub.call_rpc :create_entry_group, request, options: options do |response, operation|
1388
1411
  response = ::Gapic::Operation.new response, @operations_client, options: options
1389
1412
  yield response, operation if block_given?
1390
- return response
1413
+ throw :response, response
1391
1414
  end
1392
1415
  rescue ::GRPC::BadStatus => e
1393
1416
  raise ::Google::Cloud::Error.from_error(e)
1394
1417
  end
1395
1418
 
1396
1419
  ##
1397
- # Updates a EntryGroup resource.
1420
+ # Updates an EntryGroup.
1398
1421
  #
1399
1422
  # @overload update_entry_group(request, options = nil)
1400
1423
  # Pass arguments to `update_entry_group` via a request object, either of type
@@ -1412,12 +1435,12 @@ module Google
1412
1435
  # the default parameter values, pass an empty Hash as a request object (see above).
1413
1436
  #
1414
1437
  # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1415
- # Required. EntryGroup Resource
1438
+ # Required. EntryGroup Resource.
1416
1439
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1417
1440
  # Required. Mask of fields to update.
1418
1441
  # @param validate_only [::Boolean]
1419
- # Optional. Only validate the request, but do not perform mutations.
1420
- # The default is false.
1442
+ # Optional. The service validates the request, without performing any
1443
+ # mutations. The default is false.
1421
1444
  #
1422
1445
  # @yield [response, operation] Access the result along with the RPC operation
1423
1446
  # @yieldparam response [::Gapic::Operation]
@@ -1486,14 +1509,14 @@ module Google
1486
1509
  @catalog_service_stub.call_rpc :update_entry_group, request, options: options do |response, operation|
1487
1510
  response = ::Gapic::Operation.new response, @operations_client, options: options
1488
1511
  yield response, operation if block_given?
1489
- return response
1512
+ throw :response, response
1490
1513
  end
1491
1514
  rescue ::GRPC::BadStatus => e
1492
1515
  raise ::Google::Cloud::Error.from_error(e)
1493
1516
  end
1494
1517
 
1495
1518
  ##
1496
- # Deletes a EntryGroup resource.
1519
+ # Deletes an EntryGroup.
1497
1520
  #
1498
1521
  # @overload delete_entry_group(request, options = nil)
1499
1522
  # Pass arguments to `delete_entry_group` via a request object, either of type
@@ -1515,7 +1538,8 @@ module Google
1515
1538
  # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
1516
1539
  # @param etag [::String]
1517
1540
  # Optional. If the client provided etag value does not match the current etag
1518
- # value, the DeleteEntryGroupRequest method returns an ABORTED error response
1541
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error
1542
+ # response.
1519
1543
  #
1520
1544
  # @yield [response, operation] Access the result along with the RPC operation
1521
1545
  # @yieldparam response [::Gapic::Operation]
@@ -1584,7 +1608,7 @@ module Google
1584
1608
  @catalog_service_stub.call_rpc :delete_entry_group, request, options: options do |response, operation|
1585
1609
  response = ::Gapic::Operation.new response, @operations_client, options: options
1586
1610
  yield response, operation if block_given?
1587
- return response
1611
+ throw :response, response
1588
1612
  end
1589
1613
  rescue ::GRPC::BadStatus => e
1590
1614
  raise ::Google::Cloud::Error.from_error(e)
@@ -1611,17 +1635,17 @@ module Google
1611
1635
  # @param parent [::String]
1612
1636
  # Required. The resource name of the entryGroup location, of the form:
1613
1637
  # `projects/{project_number}/locations/{location_id}`
1614
- # where `location_id` refers to a GCP region.
1638
+ # where `location_id` refers to a Google Cloud region.
1615
1639
  # @param page_size [::Integer]
1616
1640
  # Optional. Maximum number of EntryGroups to return. The service may return
1617
- # fewer than this value. If unspecified, at most 10 EntryGroups will be
1618
- # returned. The maximum value is 1000; values above 1000 will be coerced to
1619
- # 1000.
1641
+ # fewer than this value. If unspecified, the service returns at most 10
1642
+ # EntryGroups. The maximum value is 1000; values above 1000 will be coerced
1643
+ # to 1000.
1620
1644
  # @param page_token [::String]
1621
1645
  # Optional. Page token received from a previous `ListEntryGroups` call.
1622
1646
  # Provide this to retrieve the subsequent page. When paginating, all other
1623
- # parameters provided to `ListEntryGroups` must match the call that provided
1624
- # the page token.
1647
+ # parameters you provide to `ListEntryGroups` must match the call that
1648
+ # provided the page token.
1625
1649
  # @param filter [::String]
1626
1650
  # Optional. Filter request.
1627
1651
  # @param order_by [::String]
@@ -1691,14 +1715,14 @@ module Google
1691
1715
  @catalog_service_stub.call_rpc :list_entry_groups, request, options: options do |response, operation|
1692
1716
  response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_entry_groups, request, response, operation, options
1693
1717
  yield response, operation if block_given?
1694
- return response
1718
+ throw :response, response
1695
1719
  end
1696
1720
  rescue ::GRPC::BadStatus => e
1697
1721
  raise ::Google::Cloud::Error.from_error(e)
1698
1722
  end
1699
1723
 
1700
1724
  ##
1701
- # Retrieves a EntryGroup resource.
1725
+ # Gets an EntryGroup.
1702
1726
  #
1703
1727
  # @overload get_entry_group(request, options = nil)
1704
1728
  # Pass arguments to `get_entry_group` via a request object, either of type
@@ -1778,7 +1802,6 @@ module Google
1778
1802
 
1779
1803
  @catalog_service_stub.call_rpc :get_entry_group, request, options: options do |response, operation|
1780
1804
  yield response, operation if block_given?
1781
- return response
1782
1805
  end
1783
1806
  rescue ::GRPC::BadStatus => e
1784
1807
  raise ::Google::Cloud::Error.from_error(e)
@@ -1808,20 +1831,21 @@ module Google
1808
1831
  # @param entry_id [::String]
1809
1832
  # Required. Entry identifier. It has to be unique within an Entry Group.
1810
1833
  #
1811
- # Entries corresponding to Google Cloud resources use Entry ID format based
1812
- # on Full Resource Names
1813
- # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
1814
- # The format is a Full Resource Name of the resource without the
1815
- # prefix double slashes in the API Service Name part of Full Resource Name.
1816
- # This allows retrieval of entries using their associated resource name.
1834
+ # Entries corresponding to Google Cloud resources use an Entry ID format
1835
+ # based on [full resource
1836
+ # names](https://cloud.google.com/apis/design/resource_names#full_resource_name).
1837
+ # The format is a full resource name of the resource without the
1838
+ # prefix double slashes in the API service name part of the full resource
1839
+ # name. This allows retrieval of entries using their associated resource
1840
+ # name.
1817
1841
  #
1818
- # For example if the Full Resource Name of a resource is
1842
+ # For example, if the full resource name of a resource is
1819
1843
  # `//library.googleapis.com/shelves/shelf1/books/book2`,
1820
1844
  # then the suggested entry_id is
1821
1845
  # `library.googleapis.com/shelves/shelf1/books/book2`.
1822
1846
  #
1823
1847
  # It is also suggested to follow the same convention for entries
1824
- # corresponding to resources from other providers or systems than Google
1848
+ # corresponding to resources from providers or systems other than Google
1825
1849
  # Cloud.
1826
1850
  #
1827
1851
  # The maximum size of the field is 4000 characters.
@@ -1887,7 +1911,6 @@ module Google
1887
1911
 
1888
1912
  @catalog_service_stub.call_rpc :create_entry, request, options: options do |response, operation|
1889
1913
  yield response, operation if block_given?
1890
- return response
1891
1914
  end
1892
1915
  rescue ::GRPC::BadStatus => e
1893
1916
  raise ::Google::Cloud::Error.from_error(e)
@@ -1917,28 +1940,34 @@ module Google
1917
1940
  # Optional. Mask of fields to update. To update Aspects, the update_mask must
1918
1941
  # contain the value "aspects".
1919
1942
  #
1920
- # If the update_mask is empty, all modifiable fields present in the request
1921
- # will be updated.
1943
+ # If the update_mask is empty, the service will update all modifiable fields
1944
+ # present in the request.
1922
1945
  # @param allow_missing [::Boolean]
1923
- # Optional. If set to true and the entry does not exist, it will be created.
1946
+ # Optional. If set to true and the entry doesn't exist, the service will
1947
+ # create it.
1924
1948
  # @param delete_missing_aspects [::Boolean]
1925
- # Optional. If set to true and the aspect_keys specify aspect ranges, any
1926
- # existing aspects from that range not provided in the request will be
1927
- # deleted.
1949
+ # Optional. If set to true and the aspect_keys specify aspect ranges, the
1950
+ # service deletes any existing aspects from that range that weren't provided
1951
+ # in the request.
1928
1952
  # @param aspect_keys [::Array<::String>]
1929
- # Optional. The map keys of the Aspects which should be modified. Supports
1930
- # the following syntaxes:
1931
- # * <aspect_type_reference> - matches aspect on given type and empty path
1932
- # * <aspect_type_reference>@path - matches aspect on given type and specified
1933
- # path
1934
- # * <aspect_type_reference>* - matches aspects on given type for all paths
1935
- # * *@path - matches aspects of all types on the given path
1936
- #
1937
- # Existing aspects matching the syntax will not be removed unless
1953
+ # Optional. The map keys of the Aspects which the service should modify. It
1954
+ # supports the following syntaxes:
1955
+ #
1956
+ # * `<aspect_type_reference>` - matches an aspect of the given type and empty
1957
+ # path.
1958
+ # * `<aspect_type_reference>@path` - matches an aspect of the given type and
1959
+ # specified path. For example, to attach an aspect to a field that is
1960
+ # specified by the `schema` aspect, the path should have the format
1961
+ # `Schema.<field_name>`.
1962
+ # * `<aspect_type_reference>*` - matches aspects of the given type for all
1963
+ # paths.
1964
+ # * `*@path` - matches aspects of all types on the given path.
1965
+ #
1966
+ # The service will not remove existing aspects matching the syntax unless
1938
1967
  # `delete_missing_aspects` is set to true.
1939
1968
  #
1940
- # If this field is left empty, it will be treated as specifying exactly those
1941
- # Aspects present in the request.
1969
+ # If this field is left empty, the service treats it as specifying
1970
+ # exactly those Aspects present in the request.
1942
1971
  #
1943
1972
  # @yield [response, operation] Access the result along with the RPC operation
1944
1973
  # @yieldparam response [::Google::Cloud::Dataplex::V1::Entry]
@@ -1999,7 +2028,6 @@ module Google
1999
2028
 
2000
2029
  @catalog_service_stub.call_rpc :update_entry, request, options: options do |response, operation|
2001
2030
  yield response, operation if block_given?
2002
- return response
2003
2031
  end
2004
2032
  rescue ::GRPC::BadStatus => e
2005
2033
  raise ::Google::Cloud::Error.from_error(e)
@@ -2086,14 +2114,13 @@ module Google
2086
2114
 
2087
2115
  @catalog_service_stub.call_rpc :delete_entry, request, options: options do |response, operation|
2088
2116
  yield response, operation if block_given?
2089
- return response
2090
2117
  end
2091
2118
  rescue ::GRPC::BadStatus => e
2092
2119
  raise ::Google::Cloud::Error.from_error(e)
2093
2120
  end
2094
2121
 
2095
2122
  ##
2096
- # Lists entries within an entry group.
2123
+ # Lists Entries within an EntryGroup.
2097
2124
  #
2098
2125
  # @overload list_entries(request, options = nil)
2099
2126
  # Pass arguments to `list_entries` via a request object, either of type
@@ -2114,23 +2141,35 @@ module Google
2114
2141
  # Required. The resource name of the parent Entry Group:
2115
2142
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
2116
2143
  # @param page_size [::Integer]
2144
+ # Optional. Number of items to return per page. If there are remaining
2145
+ # results, the service returns a next_page_token. If unspecified, the service
2146
+ # returns at most 10 Entries. The maximum value is 100; values above 100 will
2147
+ # be coerced to 100.
2117
2148
  # @param page_token [::String]
2118
- # Optional. The pagination token returned by a previous request.
2149
+ # Optional. Page token received from a previous `ListEntries` call. Provide
2150
+ # this to retrieve the subsequent page.
2119
2151
  # @param filter [::String]
2120
- # Optional. A filter on the entries to return.
2121
- # Filters are case-sensitive.
2122
- # The request can be filtered by the following fields:
2123
- # entry_type, entry_source.display_name.
2124
- # The comparison operators are =, !=, <, >, <=, >= (strings are compared
2125
- # according to lexical order)
2126
- # The logical operators AND, OR, NOT can be used
2127
- # in the filter. Wildcard "*" can be used, but for entry_type the full
2128
- # project id or number needs to be provided. Example filter expressions:
2129
- # "entry_source.display_name=AnExampleDisplayName"
2130
- # "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
2131
- # "entry_type=projects/example-project/locations/us/entryTypes/a* OR
2132
- # entry_type=projects/another-project/locations/*"
2133
- # "NOT entry_source.display_name=AnotherExampleDisplayName"
2152
+ # Optional. A filter on the entries to return. Filters are case-sensitive.
2153
+ # You can filter the request by the following fields:
2154
+ #
2155
+ # * entry_type
2156
+ # * entry_source.display_name
2157
+ #
2158
+ # The comparison operators are =, !=, <, >, <=, >=. The service compares
2159
+ # strings according to lexical order.
2160
+ #
2161
+ # You can use the logical operators AND, OR, NOT in the filter.
2162
+ #
2163
+ # You can use Wildcard "*", but for entry_type you need to provide the
2164
+ # full project id or number.
2165
+ #
2166
+ # Example filter expressions:
2167
+ #
2168
+ # * "entry_source.display_name=AnExampleDisplayName"
2169
+ # * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
2170
+ # * "entry_type=projects/example-project/locations/us/entryTypes/a* OR
2171
+ # entry_type=projects/another-project/locations/*"
2172
+ # * "NOT entry_source.display_name=AnotherExampleDisplayName"
2134
2173
  #
2135
2174
  # @yield [response, operation] Access the result along with the RPC operation
2136
2175
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>]
@@ -2196,14 +2235,19 @@ module Google
2196
2235
  @catalog_service_stub.call_rpc :list_entries, request, options: options do |response, operation|
2197
2236
  response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_entries, request, response, operation, options
2198
2237
  yield response, operation if block_given?
2199
- return response
2238
+ throw :response, response
2200
2239
  end
2201
2240
  rescue ::GRPC::BadStatus => e
2202
2241
  raise ::Google::Cloud::Error.from_error(e)
2203
2242
  end
2204
2243
 
2205
2244
  ##
2206
- # Gets a single entry.
2245
+ # Gets an Entry.
2246
+ #
2247
+ # **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is
2248
+ # changing. For more information, see [Changes to BigQuery metadata stored in
2249
+ # Dataplex
2250
+ # Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
2207
2251
  #
2208
2252
  # @overload get_entry(request, options = nil)
2209
2253
  # Pass arguments to `get_entry` via a request object, either of type
@@ -2224,13 +2268,14 @@ module Google
2224
2268
  # Required. The resource name of the Entry:
2225
2269
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
2226
2270
  # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2227
- # Optional. View for controlling which parts of an entry are to be returned.
2271
+ # Optional. View to control which parts of an entry the service should
2272
+ # return.
2228
2273
  # @param aspect_types [::Array<::String>]
2229
2274
  # Optional. Limits the aspects returned to the provided aspect types.
2230
- # Only works if the CUSTOM view is selected.
2275
+ # It only works for CUSTOM view.
2231
2276
  # @param paths [::Array<::String>]
2232
2277
  # Optional. Limits the aspects returned to those associated with the provided
2233
- # paths within the Entry. Only works if the CUSTOM view is selected.
2278
+ # paths within the Entry. It only works for CUSTOM view.
2234
2279
  #
2235
2280
  # @yield [response, operation] Access the result along with the RPC operation
2236
2281
  # @yieldparam response [::Google::Cloud::Dataplex::V1::Entry]
@@ -2291,14 +2336,18 @@ module Google
2291
2336
 
2292
2337
  @catalog_service_stub.call_rpc :get_entry, request, options: options do |response, operation|
2293
2338
  yield response, operation if block_given?
2294
- return response
2295
2339
  end
2296
2340
  rescue ::GRPC::BadStatus => e
2297
2341
  raise ::Google::Cloud::Error.from_error(e)
2298
2342
  end
2299
2343
 
2300
2344
  ##
2301
- # Looks up a single entry.
2345
+ # Looks up a single Entry by name using the permission on the source system.
2346
+ #
2347
+ # **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is
2348
+ # changing. For more information, see [Changes to BigQuery metadata stored in
2349
+ # Dataplex
2350
+ # Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
2302
2351
  #
2303
2352
  # @overload lookup_entry(request, options = nil)
2304
2353
  # Pass arguments to `lookup_entry` via a request object, either of type
@@ -2319,13 +2368,14 @@ module Google
2319
2368
  # Required. The project to which the request should be attributed in the
2320
2369
  # following form: `projects/{project}/locations/{location}`.
2321
2370
  # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2322
- # Optional. View for controlling which parts of an entry are to be returned.
2371
+ # Optional. View to control which parts of an entry the service should
2372
+ # return.
2323
2373
  # @param aspect_types [::Array<::String>]
2324
2374
  # Optional. Limits the aspects returned to the provided aspect types.
2325
- # Only works if the CUSTOM view is selected.
2375
+ # It only works for CUSTOM view.
2326
2376
  # @param paths [::Array<::String>]
2327
2377
  # Optional. Limits the aspects returned to those associated with the provided
2328
- # paths within the Entry. Only works if the CUSTOM view is selected.
2378
+ # paths within the Entry. It only works for CUSTOM view.
2329
2379
  # @param entry [::String]
2330
2380
  # Required. The resource name of the Entry:
2331
2381
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
@@ -2389,14 +2439,13 @@ module Google
2389
2439
 
2390
2440
  @catalog_service_stub.call_rpc :lookup_entry, request, options: options do |response, operation|
2391
2441
  yield response, operation if block_given?
2392
- return response
2393
2442
  end
2394
2443
  rescue ::GRPC::BadStatus => e
2395
2444
  raise ::Google::Cloud::Error.from_error(e)
2396
2445
  end
2397
2446
 
2398
2447
  ##
2399
- # Searches for entries matching given query and scope.
2448
+ # Searches for Entries matching the given query and scope.
2400
2449
  #
2401
2450
  # @overload search_entries(request, options = nil)
2402
2451
  # Pass arguments to `search_entries` via a request object, either of type
@@ -2419,15 +2468,19 @@ module Google
2419
2468
  # @param query [::String]
2420
2469
  # Required. The query against which entries in scope should be matched.
2421
2470
  # @param page_size [::Integer]
2422
- # Optional. Pagination.
2471
+ # Optional. Number of results in the search page. If <=0, then defaults
2472
+ # to 10. Max limit for page_size is 1000. Throws an invalid argument for
2473
+ # page_size > 1000.
2423
2474
  # @param page_token [::String]
2475
+ # Optional. Page token received from a previous `SearchEntries` call. Provide
2476
+ # this to retrieve the subsequent page.
2424
2477
  # @param order_by [::String]
2425
- # Optional. Ordering of the results. Supported options to be added later.
2478
+ # Optional. Specifies the ordering of results.
2426
2479
  # @param scope [::String]
2427
- # Optional. The scope under which the search should be operating. Should
2428
- # either be organizations/<org_id> or projects/<project_ref>. If left
2429
- # unspecified, it will default to the organization where the project provided
2430
- # in `name` is located.
2480
+ # Optional. The scope under which the search should be operating. It must
2481
+ # either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
2482
+ # unspecified, it defaults to the organization where the project provided in
2483
+ # `name` is located.
2431
2484
  #
2432
2485
  # @yield [response, operation] Access the result along with the RPC operation
2433
2486
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::SearchEntriesResult>]
@@ -2493,7 +2546,402 @@ module Google
2493
2546
  @catalog_service_stub.call_rpc :search_entries, request, options: options do |response, operation|
2494
2547
  response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :search_entries, request, response, operation, options
2495
2548
  yield response, operation if block_given?
2496
- return response
2549
+ throw :response, response
2550
+ end
2551
+ rescue ::GRPC::BadStatus => e
2552
+ raise ::Google::Cloud::Error.from_error(e)
2553
+ end
2554
+
2555
+ ##
2556
+ # Creates a metadata job. For example, use a metadata job to import Dataplex
2557
+ # Catalog entries and aspects from a third-party system into Dataplex.
2558
+ #
2559
+ # @overload create_metadata_job(request, options = nil)
2560
+ # Pass arguments to `create_metadata_job` via a request object, either of type
2561
+ # {::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest} or an equivalent Hash.
2562
+ #
2563
+ # @param request [::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest, ::Hash]
2564
+ # A request object representing the call parameters. Required. To specify no
2565
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2566
+ # @param options [::Gapic::CallOptions, ::Hash]
2567
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2568
+ #
2569
+ # @overload create_metadata_job(parent: nil, metadata_job: nil, metadata_job_id: nil, validate_only: nil)
2570
+ # Pass arguments to `create_metadata_job` via keyword arguments. Note that at
2571
+ # least one keyword argument is required. To specify no parameters, or to keep all
2572
+ # the default parameter values, pass an empty Hash as a request object (see above).
2573
+ #
2574
+ # @param parent [::String]
2575
+ # Required. The resource name of the parent location, in the format
2576
+ # `projects/{project_id_or_number}/locations/{location_id}`
2577
+ # @param metadata_job [::Google::Cloud::Dataplex::V1::MetadataJob, ::Hash]
2578
+ # Required. The metadata job resource.
2579
+ # @param metadata_job_id [::String]
2580
+ # Optional. The metadata job ID. If not provided, a unique ID is generated
2581
+ # with the prefix `metadata-job-`.
2582
+ # @param validate_only [::Boolean]
2583
+ # Optional. The service validates the request without performing any
2584
+ # mutations. The default is false.
2585
+ #
2586
+ # @yield [response, operation] Access the result along with the RPC operation
2587
+ # @yieldparam response [::Gapic::Operation]
2588
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2589
+ #
2590
+ # @return [::Gapic::Operation]
2591
+ #
2592
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2593
+ #
2594
+ # @example Basic example
2595
+ # require "google/cloud/dataplex/v1"
2596
+ #
2597
+ # # Create a client object. The client can be reused for multiple calls.
2598
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2599
+ #
2600
+ # # Create a request. To set request fields, pass in keyword arguments.
2601
+ # request = Google::Cloud::Dataplex::V1::CreateMetadataJobRequest.new
2602
+ #
2603
+ # # Call the create_metadata_job method.
2604
+ # result = client.create_metadata_job request
2605
+ #
2606
+ # # The returned object is of type Gapic::Operation. You can use it to
2607
+ # # check the status of an operation, cancel it, or wait for results.
2608
+ # # Here is how to wait for a response.
2609
+ # result.wait_until_done! timeout: 60
2610
+ # if result.response?
2611
+ # p result.response
2612
+ # else
2613
+ # puts "No response received."
2614
+ # end
2615
+ #
2616
+ def create_metadata_job request, options = nil
2617
+ raise ::ArgumentError, "request must be provided" if request.nil?
2618
+
2619
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest
2620
+
2621
+ # Converts hash and nil to an options object
2622
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2623
+
2624
+ # Customize the options with defaults
2625
+ metadata = @config.rpcs.create_metadata_job.metadata.to_h
2626
+
2627
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2628
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2629
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2630
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2631
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2632
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2633
+
2634
+ header_params = {}
2635
+ if request.parent
2636
+ header_params["parent"] = request.parent
2637
+ end
2638
+
2639
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2640
+ metadata[:"x-goog-request-params"] ||= request_params_header
2641
+
2642
+ options.apply_defaults timeout: @config.rpcs.create_metadata_job.timeout,
2643
+ metadata: metadata,
2644
+ retry_policy: @config.rpcs.create_metadata_job.retry_policy
2645
+
2646
+ options.apply_defaults timeout: @config.timeout,
2647
+ metadata: @config.metadata,
2648
+ retry_policy: @config.retry_policy
2649
+
2650
+ @catalog_service_stub.call_rpc :create_metadata_job, request, options: options do |response, operation|
2651
+ response = ::Gapic::Operation.new response, @operations_client, options: options
2652
+ yield response, operation if block_given?
2653
+ throw :response, response
2654
+ end
2655
+ rescue ::GRPC::BadStatus => e
2656
+ raise ::Google::Cloud::Error.from_error(e)
2657
+ end
2658
+
2659
+ ##
2660
+ # Gets a metadata job.
2661
+ #
2662
+ # @overload get_metadata_job(request, options = nil)
2663
+ # Pass arguments to `get_metadata_job` via a request object, either of type
2664
+ # {::Google::Cloud::Dataplex::V1::GetMetadataJobRequest} or an equivalent Hash.
2665
+ #
2666
+ # @param request [::Google::Cloud::Dataplex::V1::GetMetadataJobRequest, ::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 get_metadata_job(name: nil)
2673
+ # Pass arguments to `get_metadata_job` 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 metadata job, in the format
2679
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
2680
+ #
2681
+ # @yield [response, operation] Access the result along with the RPC operation
2682
+ # @yieldparam response [::Google::Cloud::Dataplex::V1::MetadataJob]
2683
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2684
+ #
2685
+ # @return [::Google::Cloud::Dataplex::V1::MetadataJob]
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::CatalogService::Client.new
2694
+ #
2695
+ # # Create a request. To set request fields, pass in keyword arguments.
2696
+ # request = Google::Cloud::Dataplex::V1::GetMetadataJobRequest.new
2697
+ #
2698
+ # # Call the get_metadata_job method.
2699
+ # result = client.get_metadata_job request
2700
+ #
2701
+ # # The returned object is of type Google::Cloud::Dataplex::V1::MetadataJob.
2702
+ # p result
2703
+ #
2704
+ def get_metadata_job 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::GetMetadataJobRequest
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.get_metadata_job.metadata.to_h
2714
+
2715
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
2720
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2721
+
2722
+ header_params = {}
2723
+ if request.name
2724
+ header_params["name"] = request.name
2725
+ end
2726
+
2727
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2728
+ metadata[:"x-goog-request-params"] ||= request_params_header
2729
+
2730
+ options.apply_defaults timeout: @config.rpcs.get_metadata_job.timeout,
2731
+ metadata: metadata,
2732
+ retry_policy: @config.rpcs.get_metadata_job.retry_policy
2733
+
2734
+ options.apply_defaults timeout: @config.timeout,
2735
+ metadata: @config.metadata,
2736
+ retry_policy: @config.retry_policy
2737
+
2738
+ @catalog_service_stub.call_rpc :get_metadata_job, request, options: options do |response, operation|
2739
+ yield response, operation if block_given?
2740
+ end
2741
+ rescue ::GRPC::BadStatus => e
2742
+ raise ::Google::Cloud::Error.from_error(e)
2743
+ end
2744
+
2745
+ ##
2746
+ # Lists metadata jobs.
2747
+ #
2748
+ # @overload list_metadata_jobs(request, options = nil)
2749
+ # Pass arguments to `list_metadata_jobs` via a request object, either of type
2750
+ # {::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest} or an equivalent Hash.
2751
+ #
2752
+ # @param request [::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest, ::Hash]
2753
+ # A request object representing the call parameters. Required. To specify no
2754
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2755
+ # @param options [::Gapic::CallOptions, ::Hash]
2756
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2757
+ #
2758
+ # @overload list_metadata_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
2759
+ # Pass arguments to `list_metadata_jobs` via keyword arguments. Note that at
2760
+ # least one keyword argument is required. To specify no parameters, or to keep all
2761
+ # the default parameter values, pass an empty Hash as a request object (see above).
2762
+ #
2763
+ # @param parent [::String]
2764
+ # Required. The resource name of the parent location, in the format
2765
+ # `projects/{project_id_or_number}/locations/{location_id}`
2766
+ # @param page_size [::Integer]
2767
+ # Optional. The maximum number of metadata jobs to return. The service might
2768
+ # return fewer jobs than this value. If unspecified, at most 10 jobs are
2769
+ # returned. The maximum value is 1,000.
2770
+ # @param page_token [::String]
2771
+ # Optional. The page token received from a previous `ListMetadataJobs` call.
2772
+ # Provide this token to retrieve the subsequent page of results. When
2773
+ # paginating, all other parameters that are provided to the
2774
+ # `ListMetadataJobs` request must match the call that provided the page
2775
+ # token.
2776
+ # @param filter [::String]
2777
+ # Optional. Filter request. Filters are case-sensitive.
2778
+ # The service supports the following formats:
2779
+ #
2780
+ # * `labels.key1 = "value1"`
2781
+ # * `labels:key1`
2782
+ # * `name = "value"`
2783
+ #
2784
+ # You can combine filters with `AND`, `OR`, and `NOT` operators.
2785
+ # @param order_by [::String]
2786
+ # Optional. The field to sort the results by, either `name` or `create_time`.
2787
+ # If not specified, the ordering is undefined.
2788
+ #
2789
+ # @yield [response, operation] Access the result along with the RPC operation
2790
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::MetadataJob>]
2791
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2792
+ #
2793
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::MetadataJob>]
2794
+ #
2795
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2796
+ #
2797
+ # @example Basic example
2798
+ # require "google/cloud/dataplex/v1"
2799
+ #
2800
+ # # Create a client object. The client can be reused for multiple calls.
2801
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2802
+ #
2803
+ # # Create a request. To set request fields, pass in keyword arguments.
2804
+ # request = Google::Cloud::Dataplex::V1::ListMetadataJobsRequest.new
2805
+ #
2806
+ # # Call the list_metadata_jobs method.
2807
+ # result = client.list_metadata_jobs request
2808
+ #
2809
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2810
+ # # over elements, and API calls will be issued to fetch pages as needed.
2811
+ # result.each do |item|
2812
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::MetadataJob.
2813
+ # p item
2814
+ # end
2815
+ #
2816
+ def list_metadata_jobs request, options = nil
2817
+ raise ::ArgumentError, "request must be provided" if request.nil?
2818
+
2819
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest
2820
+
2821
+ # Converts hash and nil to an options object
2822
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2823
+
2824
+ # Customize the options with defaults
2825
+ metadata = @config.rpcs.list_metadata_jobs.metadata.to_h
2826
+
2827
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2828
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2829
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2830
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2831
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2832
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2833
+
2834
+ header_params = {}
2835
+ if request.parent
2836
+ header_params["parent"] = request.parent
2837
+ end
2838
+
2839
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2840
+ metadata[:"x-goog-request-params"] ||= request_params_header
2841
+
2842
+ options.apply_defaults timeout: @config.rpcs.list_metadata_jobs.timeout,
2843
+ metadata: metadata,
2844
+ retry_policy: @config.rpcs.list_metadata_jobs.retry_policy
2845
+
2846
+ options.apply_defaults timeout: @config.timeout,
2847
+ metadata: @config.metadata,
2848
+ retry_policy: @config.retry_policy
2849
+
2850
+ @catalog_service_stub.call_rpc :list_metadata_jobs, request, options: options do |response, operation|
2851
+ response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_metadata_jobs, request, response, operation, options
2852
+ yield response, operation if block_given?
2853
+ throw :response, response
2854
+ end
2855
+ rescue ::GRPC::BadStatus => e
2856
+ raise ::Google::Cloud::Error.from_error(e)
2857
+ end
2858
+
2859
+ ##
2860
+ # Cancels a metadata job.
2861
+ #
2862
+ # If you cancel a metadata import job that is in progress, the changes in the
2863
+ # job might be partially applied. We recommend that you reset the state of
2864
+ # the entry groups in your project by running another metadata job that
2865
+ # reverts the changes from the canceled job.
2866
+ #
2867
+ # @overload cancel_metadata_job(request, options = nil)
2868
+ # Pass arguments to `cancel_metadata_job` via a request object, either of type
2869
+ # {::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest} or an equivalent Hash.
2870
+ #
2871
+ # @param request [::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest, ::Hash]
2872
+ # A request object representing the call parameters. Required. To specify no
2873
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2874
+ # @param options [::Gapic::CallOptions, ::Hash]
2875
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2876
+ #
2877
+ # @overload cancel_metadata_job(name: nil)
2878
+ # Pass arguments to `cancel_metadata_job` via keyword arguments. Note that at
2879
+ # least one keyword argument is required. To specify no parameters, or to keep all
2880
+ # the default parameter values, pass an empty Hash as a request object (see above).
2881
+ #
2882
+ # @param name [::String]
2883
+ # Required. The resource name of the job, in the format
2884
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`
2885
+ #
2886
+ # @yield [response, operation] Access the result along with the RPC operation
2887
+ # @yieldparam response [::Google::Protobuf::Empty]
2888
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2889
+ #
2890
+ # @return [::Google::Protobuf::Empty]
2891
+ #
2892
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2893
+ #
2894
+ # @example Basic example
2895
+ # require "google/cloud/dataplex/v1"
2896
+ #
2897
+ # # Create a client object. The client can be reused for multiple calls.
2898
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2899
+ #
2900
+ # # Create a request. To set request fields, pass in keyword arguments.
2901
+ # request = Google::Cloud::Dataplex::V1::CancelMetadataJobRequest.new
2902
+ #
2903
+ # # Call the cancel_metadata_job method.
2904
+ # result = client.cancel_metadata_job request
2905
+ #
2906
+ # # The returned object is of type Google::Protobuf::Empty.
2907
+ # p result
2908
+ #
2909
+ def cancel_metadata_job request, options = nil
2910
+ raise ::ArgumentError, "request must be provided" if request.nil?
2911
+
2912
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest
2913
+
2914
+ # Converts hash and nil to an options object
2915
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2916
+
2917
+ # Customize the options with defaults
2918
+ metadata = @config.rpcs.cancel_metadata_job.metadata.to_h
2919
+
2920
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2921
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2922
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2923
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2924
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2925
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2926
+
2927
+ header_params = {}
2928
+ if request.name
2929
+ header_params["name"] = request.name
2930
+ end
2931
+
2932
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2933
+ metadata[:"x-goog-request-params"] ||= request_params_header
2934
+
2935
+ options.apply_defaults timeout: @config.rpcs.cancel_metadata_job.timeout,
2936
+ metadata: metadata,
2937
+ retry_policy: @config.rpcs.cancel_metadata_job.retry_policy
2938
+
2939
+ options.apply_defaults timeout: @config.timeout,
2940
+ metadata: @config.metadata,
2941
+ retry_policy: @config.retry_policy
2942
+
2943
+ @catalog_service_stub.call_rpc :cancel_metadata_job, request, options: options do |response, operation|
2944
+ yield response, operation if block_given?
2497
2945
  end
2498
2946
  rescue ::GRPC::BadStatus => e
2499
2947
  raise ::Google::Cloud::Error.from_error(e)
@@ -2582,6 +3030,11 @@ module Google
2582
3030
  # default endpoint URL. The default value of nil uses the environment
2583
3031
  # universe (usually the default "googleapis.com" universe).
2584
3032
  # @return [::String,nil]
3033
+ # @!attribute [rw] logger
3034
+ # A custom logger to use for request/response debug logging, or the value
3035
+ # `:default` (the default) to construct a default logger, or `nil` to
3036
+ # explicitly disable logging.
3037
+ # @return [::Logger,:default,nil]
2585
3038
  #
2586
3039
  class Configuration
2587
3040
  extend ::Gapic::Config
@@ -2606,6 +3059,7 @@ module Google
2606
3059
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2607
3060
  config_attr :quota_project, nil, ::String, nil
2608
3061
  config_attr :universe_domain, nil, ::String, nil
3062
+ config_attr :logger, :default, ::Logger, nil, :default
2609
3063
 
2610
3064
  # @private
2611
3065
  def initialize parent_config = nil
@@ -2762,6 +3216,26 @@ module Google
2762
3216
  # @return [::Gapic::Config::Method]
2763
3217
  #
2764
3218
  attr_reader :search_entries
3219
+ ##
3220
+ # RPC-specific configuration for `create_metadata_job`
3221
+ # @return [::Gapic::Config::Method]
3222
+ #
3223
+ attr_reader :create_metadata_job
3224
+ ##
3225
+ # RPC-specific configuration for `get_metadata_job`
3226
+ # @return [::Gapic::Config::Method]
3227
+ #
3228
+ attr_reader :get_metadata_job
3229
+ ##
3230
+ # RPC-specific configuration for `list_metadata_jobs`
3231
+ # @return [::Gapic::Config::Method]
3232
+ #
3233
+ attr_reader :list_metadata_jobs
3234
+ ##
3235
+ # RPC-specific configuration for `cancel_metadata_job`
3236
+ # @return [::Gapic::Config::Method]
3237
+ #
3238
+ attr_reader :cancel_metadata_job
2765
3239
 
2766
3240
  # @private
2767
3241
  def initialize parent_rpcs = nil
@@ -2809,6 +3283,14 @@ module Google
2809
3283
  @lookup_entry = ::Gapic::Config::Method.new lookup_entry_config
2810
3284
  search_entries_config = parent_rpcs.search_entries if parent_rpcs.respond_to? :search_entries
2811
3285
  @search_entries = ::Gapic::Config::Method.new search_entries_config
3286
+ create_metadata_job_config = parent_rpcs.create_metadata_job if parent_rpcs.respond_to? :create_metadata_job
3287
+ @create_metadata_job = ::Gapic::Config::Method.new create_metadata_job_config
3288
+ get_metadata_job_config = parent_rpcs.get_metadata_job if parent_rpcs.respond_to? :get_metadata_job
3289
+ @get_metadata_job = ::Gapic::Config::Method.new get_metadata_job_config
3290
+ list_metadata_jobs_config = parent_rpcs.list_metadata_jobs if parent_rpcs.respond_to? :list_metadata_jobs
3291
+ @list_metadata_jobs = ::Gapic::Config::Method.new list_metadata_jobs_config
3292
+ cancel_metadata_job_config = parent_rpcs.cancel_metadata_job if parent_rpcs.respond_to? :cancel_metadata_job
3293
+ @cancel_metadata_job = ::Gapic::Config::Method.new cancel_metadata_job_config
2812
3294
 
2813
3295
  yield self if block_given?
2814
3296
  end