google-cloud-dataplex-v1 1.0.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dataplex/v1/bindings_override.rb +120 -0
  3. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +17 -1
  4. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +585 -121
  5. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +3 -10
  6. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
  7. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +556 -121
  8. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +32 -10
  9. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +238 -0
  10. data/lib/google/cloud/dataplex/v1/catalog_service/rest.rb +4 -4
  11. data/lib/google/cloud/dataplex/v1/catalog_service.rb +4 -4
  12. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +44 -20
  13. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +52 -0
  14. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +1 -1
  15. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +3 -10
  16. data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +36 -0
  17. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +32 -10
  18. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +3 -10
  19. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +32 -10
  20. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +3 -10
  21. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +32 -10
  22. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +3 -1
  23. data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -1
  24. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  25. data/proto_docs/google/api/client.rb +20 -0
  26. data/proto_docs/google/api/field_info.rb +88 -0
  27. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +710 -234
  28. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +156 -0
  29. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +4 -4
  30. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +7 -2
  31. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +30 -12
  32. data/proto_docs/google/cloud/dataplex/v1/logs.rb +51 -1
  33. data/proto_docs/google/cloud/dataplex/v1/tasks.rb +3 -4
  34. data/proto_docs/google/longrunning/operations.rb +19 -14
  35. metadata +6 -3
@@ -32,10 +32,10 @@ module Google
32
32
  # REST client for the CatalogService service.
33
33
  #
34
34
  # The primary resources offered by this service are EntryGroups, EntryTypes,
35
- # AspectTypes, Entry and Aspect which collectively allow a data administrator
36
- # to organize, manage, secure and catalog data across their organization
37
- # located across cloud projects in a variety of storage systems including Cloud
38
- # Storage and BigQuery.
35
+ # AspectTypes, and Entries. They collectively let data administrators organize,
36
+ # manage, secure, and catalog data located across cloud projects in their
37
+ # organization in a variety of storage systems, including Cloud Storage and
38
+ # BigQuery.
39
39
  #
40
40
  class Client
41
41
  # @private
@@ -284,7 +284,7 @@ module Google
284
284
  # Service calls
285
285
 
286
286
  ##
287
- # Creates an EntryType
287
+ # Creates an EntryType.
288
288
  #
289
289
  # @overload create_entry_type(request, options = nil)
290
290
  # Pass arguments to `create_entry_type` via a request object, either of type
@@ -304,14 +304,14 @@ module Google
304
304
  # @param parent [::String]
305
305
  # Required. The resource name of the EntryType, of the form:
306
306
  # projects/\\{project_number}/locations/\\{location_id}
307
- # where `location_id` refers to a GCP region.
307
+ # where `location_id` refers to a Google Cloud region.
308
308
  # @param entry_type_id [::String]
309
309
  # Required. EntryType identifier.
310
310
  # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
311
- # Required. EntryType Resource
311
+ # Required. EntryType Resource.
312
312
  # @param validate_only [::Boolean]
313
- # Optional. Only validate the request, but do not perform mutations.
314
- # The default is false.
313
+ # Optional. The service validates the request without performing any
314
+ # mutations. The default is false.
315
315
  # @yield [result, operation] Access the result along with the TransportOperation object
316
316
  # @yieldparam result [::Gapic::Operation]
317
317
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -380,7 +380,7 @@ module Google
380
380
  end
381
381
 
382
382
  ##
383
- # Updates a EntryType resource.
383
+ # Updates an EntryType.
384
384
  #
385
385
  # @overload update_entry_type(request, options = nil)
386
386
  # Pass arguments to `update_entry_type` via a request object, either of type
@@ -398,12 +398,12 @@ module Google
398
398
  # the default parameter values, pass an empty Hash as a request object (see above).
399
399
  #
400
400
  # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
401
- # Required. EntryType Resource
401
+ # Required. EntryType Resource.
402
402
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
403
403
  # Required. Mask of fields to update.
404
404
  # @param validate_only [::Boolean]
405
- # Optional. Only validate the request, but do not perform mutations.
406
- # The default is false.
405
+ # Optional. The service validates the request without performing any
406
+ # mutations. The default is false.
407
407
  # @yield [result, operation] Access the result along with the TransportOperation object
408
408
  # @yieldparam result [::Gapic::Operation]
409
409
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -472,7 +472,7 @@ module Google
472
472
  end
473
473
 
474
474
  ##
475
- # Deletes a EntryType resource.
475
+ # Deletes an EntryType.
476
476
  #
477
477
  # @overload delete_entry_type(request, options = nil)
478
478
  # Pass arguments to `delete_entry_type` via a request object, either of type
@@ -494,7 +494,7 @@ module Google
494
494
  # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
495
495
  # @param etag [::String]
496
496
  # Optional. If the client provided etag value does not match the current etag
497
- # value, the DeleteEntryTypeRequest method returns an ABORTED error response
497
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response.
498
498
  # @yield [result, operation] Access the result along with the TransportOperation object
499
499
  # @yieldparam result [::Gapic::Operation]
500
500
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -583,27 +583,28 @@ module Google
583
583
  # @param parent [::String]
584
584
  # Required. The resource name of the EntryType location, of the form:
585
585
  # `projects/{project_number}/locations/{location_id}`
586
- # where `location_id` refers to a GCP region.
586
+ # where `location_id` refers to a Google Cloud region.
587
587
  # @param page_size [::Integer]
588
588
  # Optional. Maximum number of EntryTypes to return. The service may return
589
- # fewer than this value. If unspecified, at most 10 EntryTypes will be
590
- # returned. The maximum value is 1000; values above 1000 will be coerced to
589
+ # fewer than this value. If unspecified, the service returns at most 10
590
+ # EntryTypes. The maximum value is 1000; values above 1000 will be coerced to
591
591
  # 1000.
592
592
  # @param page_token [::String]
593
593
  # Optional. Page token received from a previous `ListEntryTypes` call.
594
594
  # Provide this to retrieve the subsequent page. When paginating, all other
595
- # parameters provided to `ListEntryTypes` must match the call that provided
596
- # the page token.
595
+ # parameters you provided to `ListEntryTypes` must match the call that
596
+ # provided the page token.
597
597
  # @param filter [::String]
598
598
  # Optional. Filter request. Filters are case-sensitive.
599
- # The following formats are supported:
599
+ # The service supports the following formats:
600
+ #
601
+ # * labels.key1 = "value1"
602
+ # * labels:key1
603
+ # * name = "value"
600
604
  #
601
- # labels.key1 = "value1"
602
- # labels:key1
603
- # name = "value"
604
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
605
+ # These restrictions can be conjoined with AND, OR, and NOT conjunctions.
605
606
  # @param order_by [::String]
606
- # Optional. Order by fields (`name` or `create_time`) for the result.
607
+ # Optional. Orders the result by `name` or `create_time` fields.
607
608
  # If not specified, the ordering is undefined.
608
609
  # @yield [result, operation] Access the result along with the TransportOperation object
609
610
  # @yieldparam result [::Google::Cloud::Dataplex::V1::ListEntryTypesResponse]
@@ -669,7 +670,7 @@ module Google
669
670
  end
670
671
 
671
672
  ##
672
- # Retrieves a EntryType resource.
673
+ # Gets an EntryType.
673
674
  #
674
675
  # @overload get_entry_type(request, options = nil)
675
676
  # Pass arguments to `get_entry_type` via a request object, either of type
@@ -749,7 +750,7 @@ module Google
749
750
  end
750
751
 
751
752
  ##
752
- # Creates an AspectType
753
+ # Creates an AspectType.
753
754
  #
754
755
  # @overload create_aspect_type(request, options = nil)
755
756
  # Pass arguments to `create_aspect_type` via a request object, either of type
@@ -769,14 +770,14 @@ module Google
769
770
  # @param parent [::String]
770
771
  # Required. The resource name of the AspectType, of the form:
771
772
  # projects/\\{project_number}/locations/\\{location_id}
772
- # where `location_id` refers to a GCP region.
773
+ # where `location_id` refers to a Google Cloud region.
773
774
  # @param aspect_type_id [::String]
774
775
  # Required. AspectType identifier.
775
776
  # @param aspect_type [::Google::Cloud::Dataplex::V1::AspectType, ::Hash]
776
- # Required. AspectType Resource
777
+ # Required. AspectType Resource.
777
778
  # @param validate_only [::Boolean]
778
- # Optional. Only validate the request, but do not perform mutations.
779
- # The default is false.
779
+ # Optional. The service validates the request without performing any
780
+ # mutations. The default is false.
780
781
  # @yield [result, operation] Access the result along with the TransportOperation object
781
782
  # @yieldparam result [::Gapic::Operation]
782
783
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -845,7 +846,7 @@ module Google
845
846
  end
846
847
 
847
848
  ##
848
- # Updates a AspectType resource.
849
+ # Updates an AspectType.
849
850
  #
850
851
  # @overload update_aspect_type(request, options = nil)
851
852
  # Pass arguments to `update_aspect_type` via a request object, either of type
@@ -937,7 +938,7 @@ module Google
937
938
  end
938
939
 
939
940
  ##
940
- # Deletes a AspectType resource.
941
+ # Deletes an AspectType.
941
942
  #
942
943
  # @overload delete_aspect_type(request, options = nil)
943
944
  # Pass arguments to `delete_aspect_type` via a request object, either of type
@@ -959,7 +960,8 @@ module Google
959
960
  # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
960
961
  # @param etag [::String]
961
962
  # Optional. If the client provided etag value does not match the current etag
962
- # value, the DeleteAspectTypeRequest method returns an ABORTED error response
963
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error
964
+ # response.
963
965
  # @yield [result, operation] Access the result along with the TransportOperation object
964
966
  # @yieldparam result [::Gapic::Operation]
965
967
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1048,27 +1050,28 @@ module Google
1048
1050
  # @param parent [::String]
1049
1051
  # Required. The resource name of the AspectType location, of the form:
1050
1052
  # `projects/{project_number}/locations/{location_id}`
1051
- # where `location_id` refers to a GCP region.
1053
+ # where `location_id` refers to a Google Cloud region.
1052
1054
  # @param page_size [::Integer]
1053
1055
  # Optional. Maximum number of AspectTypes to return. The service may return
1054
- # fewer than this value. If unspecified, at most 10 AspectTypes will be
1055
- # returned. The maximum value is 1000; values above 1000 will be coerced to
1056
- # 1000.
1056
+ # fewer than this value. If unspecified, the service returns at most 10
1057
+ # AspectTypes. The maximum value is 1000; values above 1000 will be coerced
1058
+ # to 1000.
1057
1059
  # @param page_token [::String]
1058
1060
  # Optional. Page token received from a previous `ListAspectTypes` call.
1059
1061
  # Provide this to retrieve the subsequent page. When paginating, all other
1060
- # parameters provided to `ListAspectTypes` must match the call that provided
1061
- # the page token.
1062
+ # parameters you provide to `ListAspectTypes` must match the call that
1063
+ # provided the page token.
1062
1064
  # @param filter [::String]
1063
1065
  # Optional. Filter request. Filters are case-sensitive.
1064
- # The following formats are supported:
1066
+ # The service supports the following formats:
1065
1067
  #
1066
- # labels.key1 = "value1"
1067
- # labels:key1
1068
- # name = "value"
1069
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
1068
+ # * labels.key1 = "value1"
1069
+ # * labels:key1
1070
+ # * name = "value"
1071
+ #
1072
+ # These restrictions can be conjoined with AND, OR, and NOT conjunctions.
1070
1073
  # @param order_by [::String]
1071
- # Optional. Order by fields (`name` or `create_time`) for the result.
1074
+ # Optional. Orders the result by `name` or `create_time` fields.
1072
1075
  # If not specified, the ordering is undefined.
1073
1076
  # @yield [result, operation] Access the result along with the TransportOperation object
1074
1077
  # @yieldparam result [::Google::Cloud::Dataplex::V1::ListAspectTypesResponse]
@@ -1134,7 +1137,7 @@ module Google
1134
1137
  end
1135
1138
 
1136
1139
  ##
1137
- # Retrieves a AspectType resource.
1140
+ # Gets an AspectType.
1138
1141
  #
1139
1142
  # @overload get_aspect_type(request, options = nil)
1140
1143
  # Pass arguments to `get_aspect_type` via a request object, either of type
@@ -1214,7 +1217,7 @@ module Google
1214
1217
  end
1215
1218
 
1216
1219
  ##
1217
- # Creates an EntryGroup
1220
+ # Creates an EntryGroup.
1218
1221
  #
1219
1222
  # @overload create_entry_group(request, options = nil)
1220
1223
  # Pass arguments to `create_entry_group` via a request object, either of type
@@ -1238,10 +1241,10 @@ module Google
1238
1241
  # @param entry_group_id [::String]
1239
1242
  # Required. EntryGroup identifier.
1240
1243
  # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1241
- # Required. EntryGroup Resource
1244
+ # Required. EntryGroup Resource.
1242
1245
  # @param validate_only [::Boolean]
1243
- # Optional. Only validate the request, but do not perform mutations.
1244
- # The default is false.
1246
+ # Optional. The service validates the request without performing any
1247
+ # mutations. The default is false.
1245
1248
  # @yield [result, operation] Access the result along with the TransportOperation object
1246
1249
  # @yieldparam result [::Gapic::Operation]
1247
1250
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1310,7 +1313,7 @@ module Google
1310
1313
  end
1311
1314
 
1312
1315
  ##
1313
- # Updates a EntryGroup resource.
1316
+ # Updates an EntryGroup.
1314
1317
  #
1315
1318
  # @overload update_entry_group(request, options = nil)
1316
1319
  # Pass arguments to `update_entry_group` via a request object, either of type
@@ -1328,12 +1331,12 @@ module Google
1328
1331
  # the default parameter values, pass an empty Hash as a request object (see above).
1329
1332
  #
1330
1333
  # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1331
- # Required. EntryGroup Resource
1334
+ # Required. EntryGroup Resource.
1332
1335
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1333
1336
  # Required. Mask of fields to update.
1334
1337
  # @param validate_only [::Boolean]
1335
- # Optional. Only validate the request, but do not perform mutations.
1336
- # The default is false.
1338
+ # Optional. The service validates the request, without performing any
1339
+ # mutations. The default is false.
1337
1340
  # @yield [result, operation] Access the result along with the TransportOperation object
1338
1341
  # @yieldparam result [::Gapic::Operation]
1339
1342
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1402,7 +1405,7 @@ module Google
1402
1405
  end
1403
1406
 
1404
1407
  ##
1405
- # Deletes a EntryGroup resource.
1408
+ # Deletes an EntryGroup.
1406
1409
  #
1407
1410
  # @overload delete_entry_group(request, options = nil)
1408
1411
  # Pass arguments to `delete_entry_group` via a request object, either of type
@@ -1424,7 +1427,8 @@ module Google
1424
1427
  # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
1425
1428
  # @param etag [::String]
1426
1429
  # Optional. If the client provided etag value does not match the current etag
1427
- # value, the DeleteEntryGroupRequest method returns an ABORTED error response
1430
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error
1431
+ # response.
1428
1432
  # @yield [result, operation] Access the result along with the TransportOperation object
1429
1433
  # @yieldparam result [::Gapic::Operation]
1430
1434
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1513,17 +1517,17 @@ module Google
1513
1517
  # @param parent [::String]
1514
1518
  # Required. The resource name of the entryGroup location, of the form:
1515
1519
  # `projects/{project_number}/locations/{location_id}`
1516
- # where `location_id` refers to a GCP region.
1520
+ # where `location_id` refers to a Google Cloud region.
1517
1521
  # @param page_size [::Integer]
1518
1522
  # Optional. Maximum number of EntryGroups to return. The service may return
1519
- # fewer than this value. If unspecified, at most 10 EntryGroups will be
1520
- # returned. The maximum value is 1000; values above 1000 will be coerced to
1521
- # 1000.
1523
+ # fewer than this value. If unspecified, the service returns at most 10
1524
+ # EntryGroups. The maximum value is 1000; values above 1000 will be coerced
1525
+ # to 1000.
1522
1526
  # @param page_token [::String]
1523
1527
  # Optional. Page token received from a previous `ListEntryGroups` call.
1524
1528
  # Provide this to retrieve the subsequent page. When paginating, all other
1525
- # parameters provided to `ListEntryGroups` must match the call that provided
1526
- # the page token.
1529
+ # parameters you provide to `ListEntryGroups` must match the call that
1530
+ # provided the page token.
1527
1531
  # @param filter [::String]
1528
1532
  # Optional. Filter request.
1529
1533
  # @param order_by [::String]
@@ -1592,7 +1596,7 @@ module Google
1592
1596
  end
1593
1597
 
1594
1598
  ##
1595
- # Retrieves a EntryGroup resource.
1599
+ # Gets an EntryGroup.
1596
1600
  #
1597
1601
  # @overload get_entry_group(request, options = nil)
1598
1602
  # Pass arguments to `get_entry_group` via a request object, either of type
@@ -1695,20 +1699,21 @@ module Google
1695
1699
  # @param entry_id [::String]
1696
1700
  # Required. Entry identifier. It has to be unique within an Entry Group.
1697
1701
  #
1698
- # Entries corresponding to Google Cloud resources use Entry ID format based
1699
- # on Full Resource Names
1700
- # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
1701
- # The format is a Full Resource Name of the resource without the
1702
- # prefix double slashes in the API Service Name part of Full Resource Name.
1703
- # This allows retrieval of entries using their associated resource name.
1702
+ # Entries corresponding to Google Cloud resources use an Entry ID format
1703
+ # based on [full resource
1704
+ # names](https://cloud.google.com/apis/design/resource_names#full_resource_name).
1705
+ # The format is a full resource name of the resource without the
1706
+ # prefix double slashes in the API service name part of the full resource
1707
+ # name. This allows retrieval of entries using their associated resource
1708
+ # name.
1704
1709
  #
1705
- # For example if the Full Resource Name of a resource is
1710
+ # For example, if the full resource name of a resource is
1706
1711
  # `//library.googleapis.com/shelves/shelf1/books/book2`,
1707
1712
  # then the suggested entry_id is
1708
1713
  # `library.googleapis.com/shelves/shelf1/books/book2`.
1709
1714
  #
1710
1715
  # It is also suggested to follow the same convention for entries
1711
- # corresponding to resources from other providers or systems than Google
1716
+ # corresponding to resources from providers or systems other than Google
1712
1717
  # Cloud.
1713
1718
  #
1714
1719
  # The maximum size of the field is 4000 characters.
@@ -1797,28 +1802,34 @@ module Google
1797
1802
  # Optional. Mask of fields to update. To update Aspects, the update_mask must
1798
1803
  # contain the value "aspects".
1799
1804
  #
1800
- # If the update_mask is empty, all modifiable fields present in the request
1801
- # will be updated.
1805
+ # If the update_mask is empty, the service will update all modifiable fields
1806
+ # present in the request.
1802
1807
  # @param allow_missing [::Boolean]
1803
- # Optional. If set to true and the entry does not exist, it will be created.
1808
+ # Optional. If set to true and the entry doesn't exist, the service will
1809
+ # create it.
1804
1810
  # @param delete_missing_aspects [::Boolean]
1805
- # Optional. If set to true and the aspect_keys specify aspect ranges, any
1806
- # existing aspects from that range not provided in the request will be
1807
- # deleted.
1811
+ # Optional. If set to true and the aspect_keys specify aspect ranges, the
1812
+ # service deletes any existing aspects from that range that weren't provided
1813
+ # in the request.
1808
1814
  # @param aspect_keys [::Array<::String>]
1809
- # Optional. The map keys of the Aspects which should be modified. Supports
1810
- # the following syntaxes:
1811
- # * <aspect_type_reference> - matches aspect on given type and empty path
1812
- # * <aspect_type_reference>@path - matches aspect on given type and specified
1813
- # path
1814
- # * <aspect_type_reference>* - matches aspects on given type for all paths
1815
- # * *@path - matches aspects of all types on the given path
1816
- #
1817
- # Existing aspects matching the syntax will not be removed unless
1815
+ # Optional. The map keys of the Aspects which the service should modify. It
1816
+ # supports the following syntaxes:
1817
+ #
1818
+ # * `<aspect_type_reference>` - matches an aspect of the given type and empty
1819
+ # path.
1820
+ # * `<aspect_type_reference>@path` - matches an aspect of the given type and
1821
+ # specified path. For example, to attach an aspect to a field that is
1822
+ # specified by the `schema` aspect, the path should have the format
1823
+ # `Schema.<field_name>`.
1824
+ # * `<aspect_type_reference>*` - matches aspects of the given type for all
1825
+ # paths.
1826
+ # * `*@path` - matches aspects of all types on the given path.
1827
+ #
1828
+ # The service will not remove existing aspects matching the syntax unless
1818
1829
  # `delete_missing_aspects` is set to true.
1819
1830
  #
1820
- # If this field is left empty, it will be treated as specifying exactly those
1821
- # Aspects present in the request.
1831
+ # If this field is left empty, the service treats it as specifying
1832
+ # exactly those Aspects present in the request.
1822
1833
  # @yield [result, operation] Access the result along with the TransportOperation object
1823
1834
  # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
1824
1835
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1959,7 +1970,7 @@ module Google
1959
1970
  end
1960
1971
 
1961
1972
  ##
1962
- # Lists entries within an entry group.
1973
+ # Lists Entries within an EntryGroup.
1963
1974
  #
1964
1975
  # @overload list_entries(request, options = nil)
1965
1976
  # Pass arguments to `list_entries` via a request object, either of type
@@ -1980,23 +1991,35 @@ module Google
1980
1991
  # Required. The resource name of the parent Entry Group:
1981
1992
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
1982
1993
  # @param page_size [::Integer]
1994
+ # Optional. Number of items to return per page. If there are remaining
1995
+ # results, the service returns a next_page_token. If unspecified, the service
1996
+ # returns at most 10 Entries. The maximum value is 100; values above 100 will
1997
+ # be coerced to 100.
1983
1998
  # @param page_token [::String]
1984
- # Optional. The pagination token returned by a previous request.
1999
+ # Optional. Page token received from a previous `ListEntries` call. Provide
2000
+ # this to retrieve the subsequent page.
1985
2001
  # @param filter [::String]
1986
- # Optional. A filter on the entries to return.
1987
- # Filters are case-sensitive.
1988
- # The request can be filtered by the following fields:
1989
- # entry_type, entry_source.display_name.
1990
- # The comparison operators are =, !=, <, >, <=, >= (strings are compared
1991
- # according to lexical order)
1992
- # The logical operators AND, OR, NOT can be used
1993
- # in the filter. Wildcard "*" can be used, but for entry_type the full
1994
- # project id or number needs to be provided. Example filter expressions:
1995
- # "entry_source.display_name=AnExampleDisplayName"
1996
- # "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
1997
- # "entry_type=projects/example-project/locations/us/entryTypes/a* OR
1998
- # entry_type=projects/another-project/locations/*"
1999
- # "NOT entry_source.display_name=AnotherExampleDisplayName"
2002
+ # Optional. A filter on the entries to return. Filters are case-sensitive.
2003
+ # You can filter the request by the following fields:
2004
+ #
2005
+ # * entry_type
2006
+ # * entry_source.display_name
2007
+ #
2008
+ # The comparison operators are =, !=, <, >, <=, >=. The service compares
2009
+ # strings according to lexical order.
2010
+ #
2011
+ # You can use the logical operators AND, OR, NOT in the filter.
2012
+ #
2013
+ # You can use Wildcard "*", but for entry_type you need to provide the
2014
+ # full project id or number.
2015
+ #
2016
+ # Example filter expressions:
2017
+ #
2018
+ # * "entry_source.display_name=AnExampleDisplayName"
2019
+ # * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
2020
+ # * "entry_type=projects/example-project/locations/us/entryTypes/a* OR
2021
+ # entry_type=projects/another-project/locations/*"
2022
+ # * "NOT entry_source.display_name=AnotherExampleDisplayName"
2000
2023
  # @yield [result, operation] Access the result along with the TransportOperation object
2001
2024
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>]
2002
2025
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2062,7 +2085,12 @@ module Google
2062
2085
  end
2063
2086
 
2064
2087
  ##
2065
- # Gets a single entry.
2088
+ # Gets an Entry.
2089
+ #
2090
+ # **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is
2091
+ # changing. For more information, see [Changes to BigQuery metadata stored in
2092
+ # Dataplex
2093
+ # Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
2066
2094
  #
2067
2095
  # @overload get_entry(request, options = nil)
2068
2096
  # Pass arguments to `get_entry` via a request object, either of type
@@ -2083,13 +2111,14 @@ module Google
2083
2111
  # Required. The resource name of the Entry:
2084
2112
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
2085
2113
  # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2086
- # Optional. View for controlling which parts of an entry are to be returned.
2114
+ # Optional. View to control which parts of an entry the service should
2115
+ # return.
2087
2116
  # @param aspect_types [::Array<::String>]
2088
2117
  # Optional. Limits the aspects returned to the provided aspect types.
2089
- # Only works if the CUSTOM view is selected.
2118
+ # It only works for CUSTOM view.
2090
2119
  # @param paths [::Array<::String>]
2091
2120
  # Optional. Limits the aspects returned to those associated with the provided
2092
- # paths within the Entry. Only works if the CUSTOM view is selected.
2121
+ # paths within the Entry. It only works for CUSTOM view.
2093
2122
  # @yield [result, operation] Access the result along with the TransportOperation object
2094
2123
  # @yieldparam result [::Google::Cloud::Dataplex::V1::Entry]
2095
2124
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2150,7 +2179,12 @@ module Google
2150
2179
  end
2151
2180
 
2152
2181
  ##
2153
- # Looks up a single entry.
2182
+ # Looks up a single Entry by name using the permission on the source system.
2183
+ #
2184
+ # **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is
2185
+ # changing. For more information, see [Changes to BigQuery metadata stored in
2186
+ # Dataplex
2187
+ # Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
2154
2188
  #
2155
2189
  # @overload lookup_entry(request, options = nil)
2156
2190
  # Pass arguments to `lookup_entry` via a request object, either of type
@@ -2171,13 +2205,14 @@ module Google
2171
2205
  # Required. The project to which the request should be attributed in the
2172
2206
  # following form: `projects/{project}/locations/{location}`.
2173
2207
  # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2174
- # Optional. View for controlling which parts of an entry are to be returned.
2208
+ # Optional. View to control which parts of an entry the service should
2209
+ # return.
2175
2210
  # @param aspect_types [::Array<::String>]
2176
2211
  # Optional. Limits the aspects returned to the provided aspect types.
2177
- # Only works if the CUSTOM view is selected.
2212
+ # It only works for CUSTOM view.
2178
2213
  # @param paths [::Array<::String>]
2179
2214
  # Optional. Limits the aspects returned to those associated with the provided
2180
- # paths within the Entry. Only works if the CUSTOM view is selected.
2215
+ # paths within the Entry. It only works for CUSTOM view.
2181
2216
  # @param entry [::String]
2182
2217
  # Required. The resource name of the Entry:
2183
2218
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
@@ -2241,7 +2276,7 @@ module Google
2241
2276
  end
2242
2277
 
2243
2278
  ##
2244
- # Searches for entries matching given query and scope.
2279
+ # Searches for Entries matching the given query and scope.
2245
2280
  #
2246
2281
  # @overload search_entries(request, options = nil)
2247
2282
  # Pass arguments to `search_entries` via a request object, either of type
@@ -2264,15 +2299,19 @@ module Google
2264
2299
  # @param query [::String]
2265
2300
  # Required. The query against which entries in scope should be matched.
2266
2301
  # @param page_size [::Integer]
2267
- # Optional. Pagination.
2302
+ # Optional. Number of results in the search page. If <=0, then defaults
2303
+ # to 10. Max limit for page_size is 1000. Throws an invalid argument for
2304
+ # page_size > 1000.
2268
2305
  # @param page_token [::String]
2306
+ # Optional. Page token received from a previous `SearchEntries` call. Provide
2307
+ # this to retrieve the subsequent page.
2269
2308
  # @param order_by [::String]
2270
- # Optional. Ordering of the results. Supported options to be added later.
2309
+ # Optional. Specifies the ordering of results.
2271
2310
  # @param scope [::String]
2272
- # Optional. The scope under which the search should be operating. Should
2273
- # either be organizations/<org_id> or projects/<project_ref>. If left
2274
- # unspecified, it will default to the organization where the project provided
2275
- # in `name` is located.
2311
+ # Optional. The scope under which the search should be operating. It must
2312
+ # either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
2313
+ # unspecified, it defaults to the organization where the project provided in
2314
+ # `name` is located.
2276
2315
  # @yield [result, operation] Access the result along with the TransportOperation object
2277
2316
  # @yieldparam result [::Google::Cloud::Dataplex::V1::SearchEntriesResponse]
2278
2317
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2336,6 +2375,374 @@ module Google
2336
2375
  raise ::Google::Cloud::Error.from_error(e)
2337
2376
  end
2338
2377
 
2378
+ ##
2379
+ # Creates a metadata job. For example, use a metadata job to import Dataplex
2380
+ # Catalog entries and aspects from a third-party system into Dataplex.
2381
+ #
2382
+ # @overload create_metadata_job(request, options = nil)
2383
+ # Pass arguments to `create_metadata_job` via a request object, either of type
2384
+ # {::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest} or an equivalent Hash.
2385
+ #
2386
+ # @param request [::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest, ::Hash]
2387
+ # A request object representing the call parameters. Required. To specify no
2388
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2389
+ # @param options [::Gapic::CallOptions, ::Hash]
2390
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2391
+ #
2392
+ # @overload create_metadata_job(parent: nil, metadata_job: nil, metadata_job_id: nil, validate_only: nil)
2393
+ # Pass arguments to `create_metadata_job` via keyword arguments. Note that at
2394
+ # least one keyword argument is required. To specify no parameters, or to keep all
2395
+ # the default parameter values, pass an empty Hash as a request object (see above).
2396
+ #
2397
+ # @param parent [::String]
2398
+ # Required. The resource name of the parent location, in the format
2399
+ # `projects/{project_id_or_number}/locations/{location_id}`
2400
+ # @param metadata_job [::Google::Cloud::Dataplex::V1::MetadataJob, ::Hash]
2401
+ # Required. The metadata job resource.
2402
+ # @param metadata_job_id [::String]
2403
+ # Optional. The metadata job ID. If not provided, a unique ID is generated
2404
+ # with the prefix `metadata-job-`.
2405
+ # @param validate_only [::Boolean]
2406
+ # Optional. The service validates the request without performing any
2407
+ # mutations. The default is false.
2408
+ # @yield [result, operation] Access the result along with the TransportOperation object
2409
+ # @yieldparam result [::Gapic::Operation]
2410
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2411
+ #
2412
+ # @return [::Gapic::Operation]
2413
+ #
2414
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2415
+ #
2416
+ # @example Basic example
2417
+ # require "google/cloud/dataplex/v1"
2418
+ #
2419
+ # # Create a client object. The client can be reused for multiple calls.
2420
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2421
+ #
2422
+ # # Create a request. To set request fields, pass in keyword arguments.
2423
+ # request = Google::Cloud::Dataplex::V1::CreateMetadataJobRequest.new
2424
+ #
2425
+ # # Call the create_metadata_job method.
2426
+ # result = client.create_metadata_job request
2427
+ #
2428
+ # # The returned object is of type Gapic::Operation. You can use it to
2429
+ # # check the status of an operation, cancel it, or wait for results.
2430
+ # # Here is how to wait for a response.
2431
+ # result.wait_until_done! timeout: 60
2432
+ # if result.response?
2433
+ # p result.response
2434
+ # else
2435
+ # puts "No response received."
2436
+ # end
2437
+ #
2438
+ def create_metadata_job request, options = nil
2439
+ raise ::ArgumentError, "request must be provided" if request.nil?
2440
+
2441
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest
2442
+
2443
+ # Converts hash and nil to an options object
2444
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2445
+
2446
+ # Customize the options with defaults
2447
+ call_metadata = @config.rpcs.create_metadata_job.metadata.to_h
2448
+
2449
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2450
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2451
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2452
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2453
+ transports_version_send: [:rest]
2454
+
2455
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2456
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2457
+
2458
+ options.apply_defaults timeout: @config.rpcs.create_metadata_job.timeout,
2459
+ metadata: call_metadata,
2460
+ retry_policy: @config.rpcs.create_metadata_job.retry_policy
2461
+
2462
+ options.apply_defaults timeout: @config.timeout,
2463
+ metadata: @config.metadata,
2464
+ retry_policy: @config.retry_policy
2465
+
2466
+ @catalog_service_stub.create_metadata_job request, options do |result, operation|
2467
+ result = ::Gapic::Operation.new result, @operations_client, options: options
2468
+ yield result, operation if block_given?
2469
+ return result
2470
+ end
2471
+ rescue ::Gapic::Rest::Error => e
2472
+ raise ::Google::Cloud::Error.from_error(e)
2473
+ end
2474
+
2475
+ ##
2476
+ # Gets a metadata job.
2477
+ #
2478
+ # @overload get_metadata_job(request, options = nil)
2479
+ # Pass arguments to `get_metadata_job` via a request object, either of type
2480
+ # {::Google::Cloud::Dataplex::V1::GetMetadataJobRequest} or an equivalent Hash.
2481
+ #
2482
+ # @param request [::Google::Cloud::Dataplex::V1::GetMetadataJobRequest, ::Hash]
2483
+ # A request object representing the call parameters. Required. To specify no
2484
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2485
+ # @param options [::Gapic::CallOptions, ::Hash]
2486
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2487
+ #
2488
+ # @overload get_metadata_job(name: nil)
2489
+ # Pass arguments to `get_metadata_job` via keyword arguments. Note that at
2490
+ # least one keyword argument is required. To specify no parameters, or to keep all
2491
+ # the default parameter values, pass an empty Hash as a request object (see above).
2492
+ #
2493
+ # @param name [::String]
2494
+ # Required. The resource name of the metadata job, in the format
2495
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
2496
+ # @yield [result, operation] Access the result along with the TransportOperation object
2497
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::MetadataJob]
2498
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2499
+ #
2500
+ # @return [::Google::Cloud::Dataplex::V1::MetadataJob]
2501
+ #
2502
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2503
+ #
2504
+ # @example Basic example
2505
+ # require "google/cloud/dataplex/v1"
2506
+ #
2507
+ # # Create a client object. The client can be reused for multiple calls.
2508
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2509
+ #
2510
+ # # Create a request. To set request fields, pass in keyword arguments.
2511
+ # request = Google::Cloud::Dataplex::V1::GetMetadataJobRequest.new
2512
+ #
2513
+ # # Call the get_metadata_job method.
2514
+ # result = client.get_metadata_job request
2515
+ #
2516
+ # # The returned object is of type Google::Cloud::Dataplex::V1::MetadataJob.
2517
+ # p result
2518
+ #
2519
+ def get_metadata_job request, options = nil
2520
+ raise ::ArgumentError, "request must be provided" if request.nil?
2521
+
2522
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetMetadataJobRequest
2523
+
2524
+ # Converts hash and nil to an options object
2525
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2526
+
2527
+ # Customize the options with defaults
2528
+ call_metadata = @config.rpcs.get_metadata_job.metadata.to_h
2529
+
2530
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2531
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2532
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2533
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2534
+ transports_version_send: [:rest]
2535
+
2536
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2537
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2538
+
2539
+ options.apply_defaults timeout: @config.rpcs.get_metadata_job.timeout,
2540
+ metadata: call_metadata,
2541
+ retry_policy: @config.rpcs.get_metadata_job.retry_policy
2542
+
2543
+ options.apply_defaults timeout: @config.timeout,
2544
+ metadata: @config.metadata,
2545
+ retry_policy: @config.retry_policy
2546
+
2547
+ @catalog_service_stub.get_metadata_job request, options do |result, operation|
2548
+ yield result, operation if block_given?
2549
+ return result
2550
+ end
2551
+ rescue ::Gapic::Rest::Error => e
2552
+ raise ::Google::Cloud::Error.from_error(e)
2553
+ end
2554
+
2555
+ ##
2556
+ # Lists metadata jobs.
2557
+ #
2558
+ # @overload list_metadata_jobs(request, options = nil)
2559
+ # Pass arguments to `list_metadata_jobs` via a request object, either of type
2560
+ # {::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest} or an equivalent Hash.
2561
+ #
2562
+ # @param request [::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest, ::Hash]
2563
+ # A request object representing the call parameters. Required. To specify no
2564
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2565
+ # @param options [::Gapic::CallOptions, ::Hash]
2566
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2567
+ #
2568
+ # @overload list_metadata_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
2569
+ # Pass arguments to `list_metadata_jobs` via keyword arguments. Note that at
2570
+ # least one keyword argument is required. To specify no parameters, or to keep all
2571
+ # the default parameter values, pass an empty Hash as a request object (see above).
2572
+ #
2573
+ # @param parent [::String]
2574
+ # Required. The resource name of the parent location, in the format
2575
+ # `projects/{project_id_or_number}/locations/{location_id}`
2576
+ # @param page_size [::Integer]
2577
+ # Optional. The maximum number of metadata jobs to return. The service might
2578
+ # return fewer jobs than this value. If unspecified, at most 10 jobs are
2579
+ # returned. The maximum value is 1,000.
2580
+ # @param page_token [::String]
2581
+ # Optional. The page token received from a previous `ListMetadataJobs` call.
2582
+ # Provide this token to retrieve the subsequent page of results. When
2583
+ # paginating, all other parameters that are provided to the
2584
+ # `ListMetadataJobs` request must match the call that provided the page
2585
+ # token.
2586
+ # @param filter [::String]
2587
+ # Optional. Filter request. Filters are case-sensitive.
2588
+ # The service supports the following formats:
2589
+ #
2590
+ # * `labels.key1 = "value1"`
2591
+ # * `labels:key1`
2592
+ # * `name = "value"`
2593
+ #
2594
+ # You can combine filters with `AND`, `OR`, and `NOT` operators.
2595
+ # @param order_by [::String]
2596
+ # Optional. The field to sort the results by, either `name` or `create_time`.
2597
+ # If not specified, the ordering is undefined.
2598
+ # @yield [result, operation] Access the result along with the TransportOperation object
2599
+ # @yieldparam result [::Google::Cloud::Dataplex::V1::ListMetadataJobsResponse]
2600
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2601
+ #
2602
+ # @return [::Google::Cloud::Dataplex::V1::ListMetadataJobsResponse]
2603
+ #
2604
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2605
+ #
2606
+ # @example Basic example
2607
+ # require "google/cloud/dataplex/v1"
2608
+ #
2609
+ # # Create a client object. The client can be reused for multiple calls.
2610
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2611
+ #
2612
+ # # Create a request. To set request fields, pass in keyword arguments.
2613
+ # request = Google::Cloud::Dataplex::V1::ListMetadataJobsRequest.new
2614
+ #
2615
+ # # Call the list_metadata_jobs method.
2616
+ # result = client.list_metadata_jobs request
2617
+ #
2618
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2619
+ # # over elements, and API calls will be issued to fetch pages as needed.
2620
+ # result.each do |item|
2621
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::MetadataJob.
2622
+ # p item
2623
+ # end
2624
+ #
2625
+ def list_metadata_jobs request, options = nil
2626
+ raise ::ArgumentError, "request must be provided" if request.nil?
2627
+
2628
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest
2629
+
2630
+ # Converts hash and nil to an options object
2631
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2632
+
2633
+ # Customize the options with defaults
2634
+ call_metadata = @config.rpcs.list_metadata_jobs.metadata.to_h
2635
+
2636
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2637
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2638
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2639
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2640
+ transports_version_send: [:rest]
2641
+
2642
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2643
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2644
+
2645
+ options.apply_defaults timeout: @config.rpcs.list_metadata_jobs.timeout,
2646
+ metadata: call_metadata,
2647
+ retry_policy: @config.rpcs.list_metadata_jobs.retry_policy
2648
+
2649
+ options.apply_defaults timeout: @config.timeout,
2650
+ metadata: @config.metadata,
2651
+ retry_policy: @config.retry_policy
2652
+
2653
+ @catalog_service_stub.list_metadata_jobs request, options do |result, operation|
2654
+ yield result, operation if block_given?
2655
+ return result
2656
+ end
2657
+ rescue ::Gapic::Rest::Error => e
2658
+ raise ::Google::Cloud::Error.from_error(e)
2659
+ end
2660
+
2661
+ ##
2662
+ # Cancels a metadata job.
2663
+ #
2664
+ # If you cancel a metadata import job that is in progress, the changes in the
2665
+ # job might be partially applied. We recommend that you reset the state of
2666
+ # the entry groups in your project by running another metadata job that
2667
+ # reverts the changes from the canceled job.
2668
+ #
2669
+ # @overload cancel_metadata_job(request, options = nil)
2670
+ # Pass arguments to `cancel_metadata_job` via a request object, either of type
2671
+ # {::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest} or an equivalent Hash.
2672
+ #
2673
+ # @param request [::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest, ::Hash]
2674
+ # A request object representing the call parameters. Required. To specify no
2675
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2676
+ # @param options [::Gapic::CallOptions, ::Hash]
2677
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2678
+ #
2679
+ # @overload cancel_metadata_job(name: nil)
2680
+ # Pass arguments to `cancel_metadata_job` via keyword arguments. Note that at
2681
+ # least one keyword argument is required. To specify no parameters, or to keep all
2682
+ # the default parameter values, pass an empty Hash as a request object (see above).
2683
+ #
2684
+ # @param name [::String]
2685
+ # Required. The resource name of the job, in the format
2686
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`
2687
+ # @yield [result, operation] Access the result along with the TransportOperation object
2688
+ # @yieldparam result [::Google::Protobuf::Empty]
2689
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2690
+ #
2691
+ # @return [::Google::Protobuf::Empty]
2692
+ #
2693
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2694
+ #
2695
+ # @example Basic example
2696
+ # require "google/cloud/dataplex/v1"
2697
+ #
2698
+ # # Create a client object. The client can be reused for multiple calls.
2699
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Rest::Client.new
2700
+ #
2701
+ # # Create a request. To set request fields, pass in keyword arguments.
2702
+ # request = Google::Cloud::Dataplex::V1::CancelMetadataJobRequest.new
2703
+ #
2704
+ # # Call the cancel_metadata_job method.
2705
+ # result = client.cancel_metadata_job request
2706
+ #
2707
+ # # The returned object is of type Google::Protobuf::Empty.
2708
+ # p result
2709
+ #
2710
+ def cancel_metadata_job request, options = nil
2711
+ raise ::ArgumentError, "request must be provided" if request.nil?
2712
+
2713
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest
2714
+
2715
+ # Converts hash and nil to an options object
2716
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2717
+
2718
+ # Customize the options with defaults
2719
+ call_metadata = @config.rpcs.cancel_metadata_job.metadata.to_h
2720
+
2721
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2722
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2723
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2724
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2725
+ transports_version_send: [:rest]
2726
+
2727
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2728
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2729
+
2730
+ options.apply_defaults timeout: @config.rpcs.cancel_metadata_job.timeout,
2731
+ metadata: call_metadata,
2732
+ retry_policy: @config.rpcs.cancel_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.cancel_metadata_job request, options do |result, operation|
2739
+ yield result, operation if block_given?
2740
+ return result
2741
+ end
2742
+ rescue ::Gapic::Rest::Error => e
2743
+ raise ::Google::Cloud::Error.from_error(e)
2744
+ end
2745
+
2339
2746
  ##
2340
2747
  # Configuration class for the CatalogService REST API.
2341
2748
  #
@@ -2586,6 +2993,26 @@ module Google
2586
2993
  # @return [::Gapic::Config::Method]
2587
2994
  #
2588
2995
  attr_reader :search_entries
2996
+ ##
2997
+ # RPC-specific configuration for `create_metadata_job`
2998
+ # @return [::Gapic::Config::Method]
2999
+ #
3000
+ attr_reader :create_metadata_job
3001
+ ##
3002
+ # RPC-specific configuration for `get_metadata_job`
3003
+ # @return [::Gapic::Config::Method]
3004
+ #
3005
+ attr_reader :get_metadata_job
3006
+ ##
3007
+ # RPC-specific configuration for `list_metadata_jobs`
3008
+ # @return [::Gapic::Config::Method]
3009
+ #
3010
+ attr_reader :list_metadata_jobs
3011
+ ##
3012
+ # RPC-specific configuration for `cancel_metadata_job`
3013
+ # @return [::Gapic::Config::Method]
3014
+ #
3015
+ attr_reader :cancel_metadata_job
2589
3016
 
2590
3017
  # @private
2591
3018
  def initialize parent_rpcs = nil
@@ -2633,6 +3060,14 @@ module Google
2633
3060
  @lookup_entry = ::Gapic::Config::Method.new lookup_entry_config
2634
3061
  search_entries_config = parent_rpcs.search_entries if parent_rpcs.respond_to? :search_entries
2635
3062
  @search_entries = ::Gapic::Config::Method.new search_entries_config
3063
+ create_metadata_job_config = parent_rpcs.create_metadata_job if parent_rpcs.respond_to? :create_metadata_job
3064
+ @create_metadata_job = ::Gapic::Config::Method.new create_metadata_job_config
3065
+ get_metadata_job_config = parent_rpcs.get_metadata_job if parent_rpcs.respond_to? :get_metadata_job
3066
+ @get_metadata_job = ::Gapic::Config::Method.new get_metadata_job_config
3067
+ list_metadata_jobs_config = parent_rpcs.list_metadata_jobs if parent_rpcs.respond_to? :list_metadata_jobs
3068
+ @list_metadata_jobs = ::Gapic::Config::Method.new list_metadata_jobs_config
3069
+ cancel_metadata_job_config = parent_rpcs.cancel_metadata_job if parent_rpcs.respond_to? :cancel_metadata_job
3070
+ @cancel_metadata_job = ::Gapic::Config::Method.new cancel_metadata_job_config
2636
3071
 
2637
3072
  yield self if block_given?
2638
3073
  end