google-cloud-dataplex-v1 1.0.1 → 1.1.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 (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
@@ -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
@@ -289,7 +289,7 @@ module Google
289
289
  # Service calls
290
290
 
291
291
  ##
292
- # Creates an EntryType
292
+ # Creates an EntryType.
293
293
  #
294
294
  # @overload create_entry_type(request, options = nil)
295
295
  # Pass arguments to `create_entry_type` via a request object, either of type
@@ -309,14 +309,14 @@ module Google
309
309
  # @param parent [::String]
310
310
  # Required. The resource name of the EntryType, of the form:
311
311
  # projects/\\{project_number}/locations/\\{location_id}
312
- # where `location_id` refers to a GCP region.
312
+ # where `location_id` refers to a Google Cloud region.
313
313
  # @param entry_type_id [::String]
314
314
  # Required. EntryType identifier.
315
315
  # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
316
- # Required. EntryType Resource
316
+ # Required. EntryType Resource.
317
317
  # @param validate_only [::Boolean]
318
- # Optional. Only validate the request, but do not perform mutations.
319
- # The default is false.
318
+ # Optional. The service validates the request without performing any
319
+ # mutations. The default is false.
320
320
  #
321
321
  # @yield [response, operation] Access the result along with the RPC operation
322
322
  # @yieldparam response [::Gapic::Operation]
@@ -392,7 +392,7 @@ module Google
392
392
  end
393
393
 
394
394
  ##
395
- # Updates a EntryType resource.
395
+ # Updates an EntryType.
396
396
  #
397
397
  # @overload update_entry_type(request, options = nil)
398
398
  # Pass arguments to `update_entry_type` via a request object, either of type
@@ -410,12 +410,12 @@ module Google
410
410
  # the default parameter values, pass an empty Hash as a request object (see above).
411
411
  #
412
412
  # @param entry_type [::Google::Cloud::Dataplex::V1::EntryType, ::Hash]
413
- # Required. EntryType Resource
413
+ # Required. EntryType Resource.
414
414
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
415
415
  # Required. Mask of fields to update.
416
416
  # @param validate_only [::Boolean]
417
- # Optional. Only validate the request, but do not perform mutations.
418
- # The default is false.
417
+ # Optional. The service validates the request without performing any
418
+ # mutations. The default is false.
419
419
  #
420
420
  # @yield [response, operation] Access the result along with the RPC operation
421
421
  # @yieldparam response [::Gapic::Operation]
@@ -491,7 +491,7 @@ module Google
491
491
  end
492
492
 
493
493
  ##
494
- # Deletes a EntryType resource.
494
+ # Deletes an EntryType.
495
495
  #
496
496
  # @overload delete_entry_type(request, options = nil)
497
497
  # Pass arguments to `delete_entry_type` via a request object, either of type
@@ -513,7 +513,7 @@ module Google
513
513
  # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
514
514
  # @param etag [::String]
515
515
  # Optional. If the client provided etag value does not match the current etag
516
- # value, the DeleteEntryTypeRequest method returns an ABORTED error response
516
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response.
517
517
  #
518
518
  # @yield [response, operation] Access the result along with the RPC operation
519
519
  # @yieldparam response [::Gapic::Operation]
@@ -609,27 +609,28 @@ module Google
609
609
  # @param parent [::String]
610
610
  # Required. The resource name of the EntryType location, of the form:
611
611
  # `projects/{project_number}/locations/{location_id}`
612
- # where `location_id` refers to a GCP region.
612
+ # where `location_id` refers to a Google Cloud region.
613
613
  # @param page_size [::Integer]
614
614
  # 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
615
+ # fewer than this value. If unspecified, the service returns at most 10
616
+ # EntryTypes. The maximum value is 1000; values above 1000 will be coerced to
617
617
  # 1000.
618
618
  # @param page_token [::String]
619
619
  # Optional. Page token received from a previous `ListEntryTypes` call.
620
620
  # 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.
621
+ # parameters you provided to `ListEntryTypes` must match the call that
622
+ # provided the page token.
623
623
  # @param filter [::String]
624
624
  # Optional. Filter request. Filters are case-sensitive.
625
- # The following formats are supported:
625
+ # The service supports the following formats:
626
626
  #
627
- # labels.key1 = "value1"
628
- # labels:key1
629
- # name = "value"
630
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
627
+ # * labels.key1 = "value1"
628
+ # * labels:key1
629
+ # * name = "value"
630
+ #
631
+ # These restrictions can be conjoined with AND, OR, and NOT conjunctions.
631
632
  # @param order_by [::String]
632
- # Optional. Order by fields (`name` or `create_time`) for the result.
633
+ # Optional. Orders the result by `name` or `create_time` fields.
633
634
  # If not specified, the ordering is undefined.
634
635
  #
635
636
  # @yield [response, operation] Access the result along with the RPC operation
@@ -703,7 +704,7 @@ module Google
703
704
  end
704
705
 
705
706
  ##
706
- # Retrieves a EntryType resource.
707
+ # Gets an EntryType.
707
708
  #
708
709
  # @overload get_entry_type(request, options = nil)
709
710
  # Pass arguments to `get_entry_type` via a request object, either of type
@@ -790,7 +791,7 @@ module Google
790
791
  end
791
792
 
792
793
  ##
793
- # Creates an AspectType
794
+ # Creates an AspectType.
794
795
  #
795
796
  # @overload create_aspect_type(request, options = nil)
796
797
  # Pass arguments to `create_aspect_type` via a request object, either of type
@@ -810,14 +811,14 @@ module Google
810
811
  # @param parent [::String]
811
812
  # Required. The resource name of the AspectType, of the form:
812
813
  # projects/\\{project_number}/locations/\\{location_id}
813
- # where `location_id` refers to a GCP region.
814
+ # where `location_id` refers to a Google Cloud region.
814
815
  # @param aspect_type_id [::String]
815
816
  # Required. AspectType identifier.
816
817
  # @param aspect_type [::Google::Cloud::Dataplex::V1::AspectType, ::Hash]
817
- # Required. AspectType Resource
818
+ # Required. AspectType Resource.
818
819
  # @param validate_only [::Boolean]
819
- # Optional. Only validate the request, but do not perform mutations.
820
- # The default is false.
820
+ # Optional. The service validates the request without performing any
821
+ # mutations. The default is false.
821
822
  #
822
823
  # @yield [response, operation] Access the result along with the RPC operation
823
824
  # @yieldparam response [::Gapic::Operation]
@@ -893,7 +894,7 @@ module Google
893
894
  end
894
895
 
895
896
  ##
896
- # Updates a AspectType resource.
897
+ # Updates an AspectType.
897
898
  #
898
899
  # @overload update_aspect_type(request, options = nil)
899
900
  # Pass arguments to `update_aspect_type` via a request object, either of type
@@ -992,7 +993,7 @@ module Google
992
993
  end
993
994
 
994
995
  ##
995
- # Deletes a AspectType resource.
996
+ # Deletes an AspectType.
996
997
  #
997
998
  # @overload delete_aspect_type(request, options = nil)
998
999
  # Pass arguments to `delete_aspect_type` via a request object, either of type
@@ -1014,7 +1015,8 @@ module Google
1014
1015
  # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
1015
1016
  # @param etag [::String]
1016
1017
  # Optional. If the client provided etag value does not match the current etag
1017
- # value, the DeleteAspectTypeRequest method returns an ABORTED error response
1018
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error
1019
+ # response.
1018
1020
  #
1019
1021
  # @yield [response, operation] Access the result along with the RPC operation
1020
1022
  # @yieldparam response [::Gapic::Operation]
@@ -1110,27 +1112,28 @@ module Google
1110
1112
  # @param parent [::String]
1111
1113
  # Required. The resource name of the AspectType location, of the form:
1112
1114
  # `projects/{project_number}/locations/{location_id}`
1113
- # where `location_id` refers to a GCP region.
1115
+ # where `location_id` refers to a Google Cloud region.
1114
1116
  # @param page_size [::Integer]
1115
1117
  # 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.
1118
+ # fewer than this value. If unspecified, the service returns at most 10
1119
+ # AspectTypes. The maximum value is 1000; values above 1000 will be coerced
1120
+ # to 1000.
1119
1121
  # @param page_token [::String]
1120
1122
  # Optional. Page token received from a previous `ListAspectTypes` call.
1121
1123
  # 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.
1124
+ # parameters you provide to `ListAspectTypes` must match the call that
1125
+ # provided the page token.
1124
1126
  # @param filter [::String]
1125
1127
  # Optional. Filter request. Filters are case-sensitive.
1126
- # The following formats are supported:
1128
+ # The service supports the following formats:
1129
+ #
1130
+ # * labels.key1 = "value1"
1131
+ # * labels:key1
1132
+ # * name = "value"
1127
1133
  #
1128
- # labels.key1 = "value1"
1129
- # labels:key1
1130
- # name = "value"
1131
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
1134
+ # These restrictions can be conjoined with AND, OR, and NOT conjunctions.
1132
1135
  # @param order_by [::String]
1133
- # Optional. Order by fields (`name` or `create_time`) for the result.
1136
+ # Optional. Orders the result by `name` or `create_time` fields.
1134
1137
  # If not specified, the ordering is undefined.
1135
1138
  #
1136
1139
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1204,7 +1207,7 @@ module Google
1204
1207
  end
1205
1208
 
1206
1209
  ##
1207
- # Retrieves a AspectType resource.
1210
+ # Gets an AspectType.
1208
1211
  #
1209
1212
  # @overload get_aspect_type(request, options = nil)
1210
1213
  # Pass arguments to `get_aspect_type` via a request object, either of type
@@ -1291,7 +1294,7 @@ module Google
1291
1294
  end
1292
1295
 
1293
1296
  ##
1294
- # Creates an EntryGroup
1297
+ # Creates an EntryGroup.
1295
1298
  #
1296
1299
  # @overload create_entry_group(request, options = nil)
1297
1300
  # Pass arguments to `create_entry_group` via a request object, either of type
@@ -1315,10 +1318,10 @@ module Google
1315
1318
  # @param entry_group_id [::String]
1316
1319
  # Required. EntryGroup identifier.
1317
1320
  # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1318
- # Required. EntryGroup Resource
1321
+ # Required. EntryGroup Resource.
1319
1322
  # @param validate_only [::Boolean]
1320
- # Optional. Only validate the request, but do not perform mutations.
1321
- # The default is false.
1323
+ # Optional. The service validates the request without performing any
1324
+ # mutations. The default is false.
1322
1325
  #
1323
1326
  # @yield [response, operation] Access the result along with the RPC operation
1324
1327
  # @yieldparam response [::Gapic::Operation]
@@ -1394,7 +1397,7 @@ module Google
1394
1397
  end
1395
1398
 
1396
1399
  ##
1397
- # Updates a EntryGroup resource.
1400
+ # Updates an EntryGroup.
1398
1401
  #
1399
1402
  # @overload update_entry_group(request, options = nil)
1400
1403
  # Pass arguments to `update_entry_group` via a request object, either of type
@@ -1412,12 +1415,12 @@ module Google
1412
1415
  # the default parameter values, pass an empty Hash as a request object (see above).
1413
1416
  #
1414
1417
  # @param entry_group [::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash]
1415
- # Required. EntryGroup Resource
1418
+ # Required. EntryGroup Resource.
1416
1419
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1417
1420
  # Required. Mask of fields to update.
1418
1421
  # @param validate_only [::Boolean]
1419
- # Optional. Only validate the request, but do not perform mutations.
1420
- # The default is false.
1422
+ # Optional. The service validates the request, without performing any
1423
+ # mutations. The default is false.
1421
1424
  #
1422
1425
  # @yield [response, operation] Access the result along with the RPC operation
1423
1426
  # @yieldparam response [::Gapic::Operation]
@@ -1493,7 +1496,7 @@ module Google
1493
1496
  end
1494
1497
 
1495
1498
  ##
1496
- # Deletes a EntryGroup resource.
1499
+ # Deletes an EntryGroup.
1497
1500
  #
1498
1501
  # @overload delete_entry_group(request, options = nil)
1499
1502
  # Pass arguments to `delete_entry_group` via a request object, either of type
@@ -1515,7 +1518,8 @@ module Google
1515
1518
  # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
1516
1519
  # @param etag [::String]
1517
1520
  # Optional. If the client provided etag value does not match the current etag
1518
- # value, the DeleteEntryGroupRequest method returns an ABORTED error response
1521
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error
1522
+ # response.
1519
1523
  #
1520
1524
  # @yield [response, operation] Access the result along with the RPC operation
1521
1525
  # @yieldparam response [::Gapic::Operation]
@@ -1611,17 +1615,17 @@ module Google
1611
1615
  # @param parent [::String]
1612
1616
  # Required. The resource name of the entryGroup location, of the form:
1613
1617
  # `projects/{project_number}/locations/{location_id}`
1614
- # where `location_id` refers to a GCP region.
1618
+ # where `location_id` refers to a Google Cloud region.
1615
1619
  # @param page_size [::Integer]
1616
1620
  # 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.
1621
+ # fewer than this value. If unspecified, the service returns at most 10
1622
+ # EntryGroups. The maximum value is 1000; values above 1000 will be coerced
1623
+ # to 1000.
1620
1624
  # @param page_token [::String]
1621
1625
  # Optional. Page token received from a previous `ListEntryGroups` call.
1622
1626
  # 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.
1627
+ # parameters you provide to `ListEntryGroups` must match the call that
1628
+ # provided the page token.
1625
1629
  # @param filter [::String]
1626
1630
  # Optional. Filter request.
1627
1631
  # @param order_by [::String]
@@ -1698,7 +1702,7 @@ module Google
1698
1702
  end
1699
1703
 
1700
1704
  ##
1701
- # Retrieves a EntryGroup resource.
1705
+ # Gets an EntryGroup.
1702
1706
  #
1703
1707
  # @overload get_entry_group(request, options = nil)
1704
1708
  # Pass arguments to `get_entry_group` via a request object, either of type
@@ -1808,20 +1812,21 @@ module Google
1808
1812
  # @param entry_id [::String]
1809
1813
  # Required. Entry identifier. It has to be unique within an Entry Group.
1810
1814
  #
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.
1815
+ # Entries corresponding to Google Cloud resources use an Entry ID format
1816
+ # based on [full resource
1817
+ # names](https://cloud.google.com/apis/design/resource_names#full_resource_name).
1818
+ # The format is a full resource name of the resource without the
1819
+ # prefix double slashes in the API service name part of the full resource
1820
+ # name. This allows retrieval of entries using their associated resource
1821
+ # name.
1817
1822
  #
1818
- # For example if the Full Resource Name of a resource is
1823
+ # For example, if the full resource name of a resource is
1819
1824
  # `//library.googleapis.com/shelves/shelf1/books/book2`,
1820
1825
  # then the suggested entry_id is
1821
1826
  # `library.googleapis.com/shelves/shelf1/books/book2`.
1822
1827
  #
1823
1828
  # It is also suggested to follow the same convention for entries
1824
- # corresponding to resources from other providers or systems than Google
1829
+ # corresponding to resources from providers or systems other than Google
1825
1830
  # Cloud.
1826
1831
  #
1827
1832
  # The maximum size of the field is 4000 characters.
@@ -1917,28 +1922,34 @@ module Google
1917
1922
  # Optional. Mask of fields to update. To update Aspects, the update_mask must
1918
1923
  # contain the value "aspects".
1919
1924
  #
1920
- # If the update_mask is empty, all modifiable fields present in the request
1921
- # will be updated.
1925
+ # If the update_mask is empty, the service will update all modifiable fields
1926
+ # present in the request.
1922
1927
  # @param allow_missing [::Boolean]
1923
- # Optional. If set to true and the entry does not exist, it will be created.
1928
+ # Optional. If set to true and the entry doesn't exist, the service will
1929
+ # create it.
1924
1930
  # @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.
1931
+ # Optional. If set to true and the aspect_keys specify aspect ranges, the
1932
+ # service deletes any existing aspects from that range that weren't provided
1933
+ # in the request.
1928
1934
  # @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
1935
+ # Optional. The map keys of the Aspects which the service should modify. It
1936
+ # supports the following syntaxes:
1937
+ #
1938
+ # * `<aspect_type_reference>` - matches an aspect of the given type and empty
1939
+ # path.
1940
+ # * `<aspect_type_reference>@path` - matches an aspect of the given type and
1941
+ # specified path. For example, to attach an aspect to a field that is
1942
+ # specified by the `schema` aspect, the path should have the format
1943
+ # `Schema.<field_name>`.
1944
+ # * `<aspect_type_reference>*` - matches aspects of the given type for all
1945
+ # paths.
1946
+ # * `*@path` - matches aspects of all types on the given path.
1947
+ #
1948
+ # The service will not remove existing aspects matching the syntax unless
1938
1949
  # `delete_missing_aspects` is set to true.
1939
1950
  #
1940
- # If this field is left empty, it will be treated as specifying exactly those
1941
- # Aspects present in the request.
1951
+ # If this field is left empty, the service treats it as specifying
1952
+ # exactly those Aspects present in the request.
1942
1953
  #
1943
1954
  # @yield [response, operation] Access the result along with the RPC operation
1944
1955
  # @yieldparam response [::Google::Cloud::Dataplex::V1::Entry]
@@ -2093,7 +2104,7 @@ module Google
2093
2104
  end
2094
2105
 
2095
2106
  ##
2096
- # Lists entries within an entry group.
2107
+ # Lists Entries within an EntryGroup.
2097
2108
  #
2098
2109
  # @overload list_entries(request, options = nil)
2099
2110
  # Pass arguments to `list_entries` via a request object, either of type
@@ -2114,23 +2125,35 @@ module Google
2114
2125
  # Required. The resource name of the parent Entry Group:
2115
2126
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
2116
2127
  # @param page_size [::Integer]
2128
+ # Optional. Number of items to return per page. If there are remaining
2129
+ # results, the service returns a next_page_token. If unspecified, the service
2130
+ # returns at most 10 Entries. The maximum value is 100; values above 100 will
2131
+ # be coerced to 100.
2117
2132
  # @param page_token [::String]
2118
- # Optional. The pagination token returned by a previous request.
2133
+ # Optional. Page token received from a previous `ListEntries` call. Provide
2134
+ # this to retrieve the subsequent page.
2119
2135
  # @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"
2136
+ # Optional. A filter on the entries to return. Filters are case-sensitive.
2137
+ # You can filter the request by the following fields:
2138
+ #
2139
+ # * entry_type
2140
+ # * entry_source.display_name
2141
+ #
2142
+ # The comparison operators are =, !=, <, >, <=, >=. The service compares
2143
+ # strings according to lexical order.
2144
+ #
2145
+ # You can use the logical operators AND, OR, NOT in the filter.
2146
+ #
2147
+ # You can use Wildcard "*", but for entry_type you need to provide the
2148
+ # full project id or number.
2149
+ #
2150
+ # Example filter expressions:
2151
+ #
2152
+ # * "entry_source.display_name=AnExampleDisplayName"
2153
+ # * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
2154
+ # * "entry_type=projects/example-project/locations/us/entryTypes/a* OR
2155
+ # entry_type=projects/another-project/locations/*"
2156
+ # * "NOT entry_source.display_name=AnotherExampleDisplayName"
2134
2157
  #
2135
2158
  # @yield [response, operation] Access the result along with the RPC operation
2136
2159
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>]
@@ -2203,7 +2226,12 @@ module Google
2203
2226
  end
2204
2227
 
2205
2228
  ##
2206
- # Gets a single entry.
2229
+ # Gets an Entry.
2230
+ #
2231
+ # **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is
2232
+ # changing. For more information, see [Changes to BigQuery metadata stored in
2233
+ # Dataplex
2234
+ # Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
2207
2235
  #
2208
2236
  # @overload get_entry(request, options = nil)
2209
2237
  # Pass arguments to `get_entry` via a request object, either of type
@@ -2224,13 +2252,14 @@ module Google
2224
2252
  # Required. The resource name of the Entry:
2225
2253
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
2226
2254
  # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2227
- # Optional. View for controlling which parts of an entry are to be returned.
2255
+ # Optional. View to control which parts of an entry the service should
2256
+ # return.
2228
2257
  # @param aspect_types [::Array<::String>]
2229
2258
  # Optional. Limits the aspects returned to the provided aspect types.
2230
- # Only works if the CUSTOM view is selected.
2259
+ # It only works for CUSTOM view.
2231
2260
  # @param paths [::Array<::String>]
2232
2261
  # Optional. Limits the aspects returned to those associated with the provided
2233
- # paths within the Entry. Only works if the CUSTOM view is selected.
2262
+ # paths within the Entry. It only works for CUSTOM view.
2234
2263
  #
2235
2264
  # @yield [response, operation] Access the result along with the RPC operation
2236
2265
  # @yieldparam response [::Google::Cloud::Dataplex::V1::Entry]
@@ -2298,7 +2327,12 @@ module Google
2298
2327
  end
2299
2328
 
2300
2329
  ##
2301
- # Looks up a single entry.
2330
+ # Looks up a single Entry by name using the permission on the source system.
2331
+ #
2332
+ # **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is
2333
+ # changing. For more information, see [Changes to BigQuery metadata stored in
2334
+ # Dataplex
2335
+ # Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
2302
2336
  #
2303
2337
  # @overload lookup_entry(request, options = nil)
2304
2338
  # Pass arguments to `lookup_entry` via a request object, either of type
@@ -2319,13 +2353,14 @@ module Google
2319
2353
  # Required. The project to which the request should be attributed in the
2320
2354
  # following form: `projects/{project}/locations/{location}`.
2321
2355
  # @param view [::Google::Cloud::Dataplex::V1::EntryView]
2322
- # Optional. View for controlling which parts of an entry are to be returned.
2356
+ # Optional. View to control which parts of an entry the service should
2357
+ # return.
2323
2358
  # @param aspect_types [::Array<::String>]
2324
2359
  # Optional. Limits the aspects returned to the provided aspect types.
2325
- # Only works if the CUSTOM view is selected.
2360
+ # It only works for CUSTOM view.
2326
2361
  # @param paths [::Array<::String>]
2327
2362
  # Optional. Limits the aspects returned to those associated with the provided
2328
- # paths within the Entry. Only works if the CUSTOM view is selected.
2363
+ # paths within the Entry. It only works for CUSTOM view.
2329
2364
  # @param entry [::String]
2330
2365
  # Required. The resource name of the Entry:
2331
2366
  # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
@@ -2396,7 +2431,7 @@ module Google
2396
2431
  end
2397
2432
 
2398
2433
  ##
2399
- # Searches for entries matching given query and scope.
2434
+ # Searches for Entries matching the given query and scope.
2400
2435
  #
2401
2436
  # @overload search_entries(request, options = nil)
2402
2437
  # Pass arguments to `search_entries` via a request object, either of type
@@ -2419,15 +2454,19 @@ module Google
2419
2454
  # @param query [::String]
2420
2455
  # Required. The query against which entries in scope should be matched.
2421
2456
  # @param page_size [::Integer]
2422
- # Optional. Pagination.
2457
+ # Optional. Number of results in the search page. If <=0, then defaults
2458
+ # to 10. Max limit for page_size is 1000. Throws an invalid argument for
2459
+ # page_size > 1000.
2423
2460
  # @param page_token [::String]
2461
+ # Optional. Page token received from a previous `SearchEntries` call. Provide
2462
+ # this to retrieve the subsequent page.
2424
2463
  # @param order_by [::String]
2425
- # Optional. Ordering of the results. Supported options to be added later.
2464
+ # Optional. Specifies the ordering of results.
2426
2465
  # @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.
2466
+ # Optional. The scope under which the search should be operating. It must
2467
+ # either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
2468
+ # unspecified, it defaults to the organization where the project provided in
2469
+ # `name` is located.
2431
2470
  #
2432
2471
  # @yield [response, operation] Access the result along with the RPC operation
2433
2472
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::SearchEntriesResult>]
@@ -2499,6 +2538,403 @@ module Google
2499
2538
  raise ::Google::Cloud::Error.from_error(e)
2500
2539
  end
2501
2540
 
2541
+ ##
2542
+ # Creates a metadata job. For example, use a metadata job to import Dataplex
2543
+ # Catalog entries and aspects from a third-party system into Dataplex.
2544
+ #
2545
+ # @overload create_metadata_job(request, options = nil)
2546
+ # Pass arguments to `create_metadata_job` via a request object, either of type
2547
+ # {::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest} or an equivalent Hash.
2548
+ #
2549
+ # @param request [::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest, ::Hash]
2550
+ # A request object representing the call parameters. Required. To specify no
2551
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2552
+ # @param options [::Gapic::CallOptions, ::Hash]
2553
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2554
+ #
2555
+ # @overload create_metadata_job(parent: nil, metadata_job: nil, metadata_job_id: nil, validate_only: nil)
2556
+ # Pass arguments to `create_metadata_job` via keyword arguments. Note that at
2557
+ # least one keyword argument is required. To specify no parameters, or to keep all
2558
+ # the default parameter values, pass an empty Hash as a request object (see above).
2559
+ #
2560
+ # @param parent [::String]
2561
+ # Required. The resource name of the parent location, in the format
2562
+ # `projects/{project_id_or_number}/locations/{location_id}`
2563
+ # @param metadata_job [::Google::Cloud::Dataplex::V1::MetadataJob, ::Hash]
2564
+ # Required. The metadata job resource.
2565
+ # @param metadata_job_id [::String]
2566
+ # Optional. The metadata job ID. If not provided, a unique ID is generated
2567
+ # with the prefix `metadata-job-`.
2568
+ # @param validate_only [::Boolean]
2569
+ # Optional. The service validates the request without performing any
2570
+ # mutations. The default is false.
2571
+ #
2572
+ # @yield [response, operation] Access the result along with the RPC operation
2573
+ # @yieldparam response [::Gapic::Operation]
2574
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2575
+ #
2576
+ # @return [::Gapic::Operation]
2577
+ #
2578
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2579
+ #
2580
+ # @example Basic example
2581
+ # require "google/cloud/dataplex/v1"
2582
+ #
2583
+ # # Create a client object. The client can be reused for multiple calls.
2584
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2585
+ #
2586
+ # # Create a request. To set request fields, pass in keyword arguments.
2587
+ # request = Google::Cloud::Dataplex::V1::CreateMetadataJobRequest.new
2588
+ #
2589
+ # # Call the create_metadata_job method.
2590
+ # result = client.create_metadata_job request
2591
+ #
2592
+ # # The returned object is of type Gapic::Operation. You can use it to
2593
+ # # check the status of an operation, cancel it, or wait for results.
2594
+ # # Here is how to wait for a response.
2595
+ # result.wait_until_done! timeout: 60
2596
+ # if result.response?
2597
+ # p result.response
2598
+ # else
2599
+ # puts "No response received."
2600
+ # end
2601
+ #
2602
+ def create_metadata_job request, options = nil
2603
+ raise ::ArgumentError, "request must be provided" if request.nil?
2604
+
2605
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateMetadataJobRequest
2606
+
2607
+ # Converts hash and nil to an options object
2608
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2609
+
2610
+ # Customize the options with defaults
2611
+ metadata = @config.rpcs.create_metadata_job.metadata.to_h
2612
+
2613
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2614
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2615
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2616
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2617
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2618
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2619
+
2620
+ header_params = {}
2621
+ if request.parent
2622
+ header_params["parent"] = request.parent
2623
+ end
2624
+
2625
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2626
+ metadata[:"x-goog-request-params"] ||= request_params_header
2627
+
2628
+ options.apply_defaults timeout: @config.rpcs.create_metadata_job.timeout,
2629
+ metadata: metadata,
2630
+ retry_policy: @config.rpcs.create_metadata_job.retry_policy
2631
+
2632
+ options.apply_defaults timeout: @config.timeout,
2633
+ metadata: @config.metadata,
2634
+ retry_policy: @config.retry_policy
2635
+
2636
+ @catalog_service_stub.call_rpc :create_metadata_job, request, options: options do |response, operation|
2637
+ response = ::Gapic::Operation.new response, @operations_client, options: options
2638
+ yield response, operation if block_given?
2639
+ return response
2640
+ end
2641
+ rescue ::GRPC::BadStatus => e
2642
+ raise ::Google::Cloud::Error.from_error(e)
2643
+ end
2644
+
2645
+ ##
2646
+ # Gets a metadata job.
2647
+ #
2648
+ # @overload get_metadata_job(request, options = nil)
2649
+ # Pass arguments to `get_metadata_job` via a request object, either of type
2650
+ # {::Google::Cloud::Dataplex::V1::GetMetadataJobRequest} or an equivalent Hash.
2651
+ #
2652
+ # @param request [::Google::Cloud::Dataplex::V1::GetMetadataJobRequest, ::Hash]
2653
+ # A request object representing the call parameters. Required. To specify no
2654
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2655
+ # @param options [::Gapic::CallOptions, ::Hash]
2656
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2657
+ #
2658
+ # @overload get_metadata_job(name: nil)
2659
+ # Pass arguments to `get_metadata_job` via keyword arguments. Note that at
2660
+ # least one keyword argument is required. To specify no parameters, or to keep all
2661
+ # the default parameter values, pass an empty Hash as a request object (see above).
2662
+ #
2663
+ # @param name [::String]
2664
+ # Required. The resource name of the metadata job, in the format
2665
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
2666
+ #
2667
+ # @yield [response, operation] Access the result along with the RPC operation
2668
+ # @yieldparam response [::Google::Cloud::Dataplex::V1::MetadataJob]
2669
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2670
+ #
2671
+ # @return [::Google::Cloud::Dataplex::V1::MetadataJob]
2672
+ #
2673
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2674
+ #
2675
+ # @example Basic example
2676
+ # require "google/cloud/dataplex/v1"
2677
+ #
2678
+ # # Create a client object. The client can be reused for multiple calls.
2679
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2680
+ #
2681
+ # # Create a request. To set request fields, pass in keyword arguments.
2682
+ # request = Google::Cloud::Dataplex::V1::GetMetadataJobRequest.new
2683
+ #
2684
+ # # Call the get_metadata_job method.
2685
+ # result = client.get_metadata_job request
2686
+ #
2687
+ # # The returned object is of type Google::Cloud::Dataplex::V1::MetadataJob.
2688
+ # p result
2689
+ #
2690
+ def get_metadata_job request, options = nil
2691
+ raise ::ArgumentError, "request must be provided" if request.nil?
2692
+
2693
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetMetadataJobRequest
2694
+
2695
+ # Converts hash and nil to an options object
2696
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2697
+
2698
+ # Customize the options with defaults
2699
+ metadata = @config.rpcs.get_metadata_job.metadata.to_h
2700
+
2701
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2702
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2703
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2704
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2705
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2706
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2707
+
2708
+ header_params = {}
2709
+ if request.name
2710
+ header_params["name"] = request.name
2711
+ end
2712
+
2713
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2714
+ metadata[:"x-goog-request-params"] ||= request_params_header
2715
+
2716
+ options.apply_defaults timeout: @config.rpcs.get_metadata_job.timeout,
2717
+ metadata: metadata,
2718
+ retry_policy: @config.rpcs.get_metadata_job.retry_policy
2719
+
2720
+ options.apply_defaults timeout: @config.timeout,
2721
+ metadata: @config.metadata,
2722
+ retry_policy: @config.retry_policy
2723
+
2724
+ @catalog_service_stub.call_rpc :get_metadata_job, request, options: options do |response, operation|
2725
+ yield response, operation if block_given?
2726
+ return response
2727
+ end
2728
+ rescue ::GRPC::BadStatus => e
2729
+ raise ::Google::Cloud::Error.from_error(e)
2730
+ end
2731
+
2732
+ ##
2733
+ # Lists metadata jobs.
2734
+ #
2735
+ # @overload list_metadata_jobs(request, options = nil)
2736
+ # Pass arguments to `list_metadata_jobs` via a request object, either of type
2737
+ # {::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest} or an equivalent Hash.
2738
+ #
2739
+ # @param request [::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest, ::Hash]
2740
+ # A request object representing the call parameters. Required. To specify no
2741
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2742
+ # @param options [::Gapic::CallOptions, ::Hash]
2743
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2744
+ #
2745
+ # @overload list_metadata_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
2746
+ # Pass arguments to `list_metadata_jobs` via keyword arguments. Note that at
2747
+ # least one keyword argument is required. To specify no parameters, or to keep all
2748
+ # the default parameter values, pass an empty Hash as a request object (see above).
2749
+ #
2750
+ # @param parent [::String]
2751
+ # Required. The resource name of the parent location, in the format
2752
+ # `projects/{project_id_or_number}/locations/{location_id}`
2753
+ # @param page_size [::Integer]
2754
+ # Optional. The maximum number of metadata jobs to return. The service might
2755
+ # return fewer jobs than this value. If unspecified, at most 10 jobs are
2756
+ # returned. The maximum value is 1,000.
2757
+ # @param page_token [::String]
2758
+ # Optional. The page token received from a previous `ListMetadataJobs` call.
2759
+ # Provide this token to retrieve the subsequent page of results. When
2760
+ # paginating, all other parameters that are provided to the
2761
+ # `ListMetadataJobs` request must match the call that provided the page
2762
+ # token.
2763
+ # @param filter [::String]
2764
+ # Optional. Filter request. Filters are case-sensitive.
2765
+ # The service supports the following formats:
2766
+ #
2767
+ # * `labels.key1 = "value1"`
2768
+ # * `labels:key1`
2769
+ # * `name = "value"`
2770
+ #
2771
+ # You can combine filters with `AND`, `OR`, and `NOT` operators.
2772
+ # @param order_by [::String]
2773
+ # Optional. The field to sort the results by, either `name` or `create_time`.
2774
+ # If not specified, the ordering is undefined.
2775
+ #
2776
+ # @yield [response, operation] Access the result along with the RPC operation
2777
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::MetadataJob>]
2778
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2779
+ #
2780
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::MetadataJob>]
2781
+ #
2782
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2783
+ #
2784
+ # @example Basic example
2785
+ # require "google/cloud/dataplex/v1"
2786
+ #
2787
+ # # Create a client object. The client can be reused for multiple calls.
2788
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2789
+ #
2790
+ # # Create a request. To set request fields, pass in keyword arguments.
2791
+ # request = Google::Cloud::Dataplex::V1::ListMetadataJobsRequest.new
2792
+ #
2793
+ # # Call the list_metadata_jobs method.
2794
+ # result = client.list_metadata_jobs request
2795
+ #
2796
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2797
+ # # over elements, and API calls will be issued to fetch pages as needed.
2798
+ # result.each do |item|
2799
+ # # Each element is of type ::Google::Cloud::Dataplex::V1::MetadataJob.
2800
+ # p item
2801
+ # end
2802
+ #
2803
+ def list_metadata_jobs request, options = nil
2804
+ raise ::ArgumentError, "request must be provided" if request.nil?
2805
+
2806
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListMetadataJobsRequest
2807
+
2808
+ # Converts hash and nil to an options object
2809
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2810
+
2811
+ # Customize the options with defaults
2812
+ metadata = @config.rpcs.list_metadata_jobs.metadata.to_h
2813
+
2814
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2815
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2816
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2817
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2818
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2819
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2820
+
2821
+ header_params = {}
2822
+ if request.parent
2823
+ header_params["parent"] = request.parent
2824
+ end
2825
+
2826
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2827
+ metadata[:"x-goog-request-params"] ||= request_params_header
2828
+
2829
+ options.apply_defaults timeout: @config.rpcs.list_metadata_jobs.timeout,
2830
+ metadata: metadata,
2831
+ retry_policy: @config.rpcs.list_metadata_jobs.retry_policy
2832
+
2833
+ options.apply_defaults timeout: @config.timeout,
2834
+ metadata: @config.metadata,
2835
+ retry_policy: @config.retry_policy
2836
+
2837
+ @catalog_service_stub.call_rpc :list_metadata_jobs, request, options: options do |response, operation|
2838
+ response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_metadata_jobs, request, response, operation, options
2839
+ yield response, operation if block_given?
2840
+ return response
2841
+ end
2842
+ rescue ::GRPC::BadStatus => e
2843
+ raise ::Google::Cloud::Error.from_error(e)
2844
+ end
2845
+
2846
+ ##
2847
+ # Cancels a metadata job.
2848
+ #
2849
+ # If you cancel a metadata import job that is in progress, the changes in the
2850
+ # job might be partially applied. We recommend that you reset the state of
2851
+ # the entry groups in your project by running another metadata job that
2852
+ # reverts the changes from the canceled job.
2853
+ #
2854
+ # @overload cancel_metadata_job(request, options = nil)
2855
+ # Pass arguments to `cancel_metadata_job` via a request object, either of type
2856
+ # {::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest} or an equivalent Hash.
2857
+ #
2858
+ # @param request [::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest, ::Hash]
2859
+ # A request object representing the call parameters. Required. To specify no
2860
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2861
+ # @param options [::Gapic::CallOptions, ::Hash]
2862
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2863
+ #
2864
+ # @overload cancel_metadata_job(name: nil)
2865
+ # Pass arguments to `cancel_metadata_job` via keyword arguments. Note that at
2866
+ # least one keyword argument is required. To specify no parameters, or to keep all
2867
+ # the default parameter values, pass an empty Hash as a request object (see above).
2868
+ #
2869
+ # @param name [::String]
2870
+ # Required. The resource name of the job, in the format
2871
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`
2872
+ #
2873
+ # @yield [response, operation] Access the result along with the RPC operation
2874
+ # @yieldparam response [::Google::Protobuf::Empty]
2875
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2876
+ #
2877
+ # @return [::Google::Protobuf::Empty]
2878
+ #
2879
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2880
+ #
2881
+ # @example Basic example
2882
+ # require "google/cloud/dataplex/v1"
2883
+ #
2884
+ # # Create a client object. The client can be reused for multiple calls.
2885
+ # client = Google::Cloud::Dataplex::V1::CatalogService::Client.new
2886
+ #
2887
+ # # Create a request. To set request fields, pass in keyword arguments.
2888
+ # request = Google::Cloud::Dataplex::V1::CancelMetadataJobRequest.new
2889
+ #
2890
+ # # Call the cancel_metadata_job method.
2891
+ # result = client.cancel_metadata_job request
2892
+ #
2893
+ # # The returned object is of type Google::Protobuf::Empty.
2894
+ # p result
2895
+ #
2896
+ def cancel_metadata_job request, options = nil
2897
+ raise ::ArgumentError, "request must be provided" if request.nil?
2898
+
2899
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CancelMetadataJobRequest
2900
+
2901
+ # Converts hash and nil to an options object
2902
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2903
+
2904
+ # Customize the options with defaults
2905
+ metadata = @config.rpcs.cancel_metadata_job.metadata.to_h
2906
+
2907
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2908
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2909
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2910
+ gapic_version: ::Google::Cloud::Dataplex::V1::VERSION
2911
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2912
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2913
+
2914
+ header_params = {}
2915
+ if request.name
2916
+ header_params["name"] = request.name
2917
+ end
2918
+
2919
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2920
+ metadata[:"x-goog-request-params"] ||= request_params_header
2921
+
2922
+ options.apply_defaults timeout: @config.rpcs.cancel_metadata_job.timeout,
2923
+ metadata: metadata,
2924
+ retry_policy: @config.rpcs.cancel_metadata_job.retry_policy
2925
+
2926
+ options.apply_defaults timeout: @config.timeout,
2927
+ metadata: @config.metadata,
2928
+ retry_policy: @config.retry_policy
2929
+
2930
+ @catalog_service_stub.call_rpc :cancel_metadata_job, request, options: options do |response, operation|
2931
+ yield response, operation if block_given?
2932
+ return response
2933
+ end
2934
+ rescue ::GRPC::BadStatus => e
2935
+ raise ::Google::Cloud::Error.from_error(e)
2936
+ end
2937
+
2502
2938
  ##
2503
2939
  # Configuration class for the CatalogService API.
2504
2940
  #
@@ -2762,6 +3198,26 @@ module Google
2762
3198
  # @return [::Gapic::Config::Method]
2763
3199
  #
2764
3200
  attr_reader :search_entries
3201
+ ##
3202
+ # RPC-specific configuration for `create_metadata_job`
3203
+ # @return [::Gapic::Config::Method]
3204
+ #
3205
+ attr_reader :create_metadata_job
3206
+ ##
3207
+ # RPC-specific configuration for `get_metadata_job`
3208
+ # @return [::Gapic::Config::Method]
3209
+ #
3210
+ attr_reader :get_metadata_job
3211
+ ##
3212
+ # RPC-specific configuration for `list_metadata_jobs`
3213
+ # @return [::Gapic::Config::Method]
3214
+ #
3215
+ attr_reader :list_metadata_jobs
3216
+ ##
3217
+ # RPC-specific configuration for `cancel_metadata_job`
3218
+ # @return [::Gapic::Config::Method]
3219
+ #
3220
+ attr_reader :cancel_metadata_job
2765
3221
 
2766
3222
  # @private
2767
3223
  def initialize parent_rpcs = nil
@@ -2809,6 +3265,14 @@ module Google
2809
3265
  @lookup_entry = ::Gapic::Config::Method.new lookup_entry_config
2810
3266
  search_entries_config = parent_rpcs.search_entries if parent_rpcs.respond_to? :search_entries
2811
3267
  @search_entries = ::Gapic::Config::Method.new search_entries_config
3268
+ create_metadata_job_config = parent_rpcs.create_metadata_job if parent_rpcs.respond_to? :create_metadata_job
3269
+ @create_metadata_job = ::Gapic::Config::Method.new create_metadata_job_config
3270
+ get_metadata_job_config = parent_rpcs.get_metadata_job if parent_rpcs.respond_to? :get_metadata_job
3271
+ @get_metadata_job = ::Gapic::Config::Method.new get_metadata_job_config
3272
+ list_metadata_jobs_config = parent_rpcs.list_metadata_jobs if parent_rpcs.respond_to? :list_metadata_jobs
3273
+ @list_metadata_jobs = ::Gapic::Config::Method.new list_metadata_jobs_config
3274
+ cancel_metadata_job_config = parent_rpcs.cancel_metadata_job if parent_rpcs.respond_to? :cancel_metadata_job
3275
+ @cancel_metadata_job = ::Gapic::Config::Method.new cancel_metadata_job_config
2812
3276
 
2813
3277
  yield self if block_given?
2814
3278
  end