google-cloud-data_catalog-v1 0.7.3 → 0.8.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 (30) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/data_catalog/v1/data_catalog.rb +2 -2
  3. data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +303 -291
  4. data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +1 -1
  5. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +54 -45
  6. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +4 -3
  7. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +109 -22
  8. data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
  9. data/lib/google/cloud/datacatalog/v1/bigquery_pb.rb +48 -0
  10. data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +44 -0
  11. data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +179 -142
  12. data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +15 -14
  13. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +5 -0
  14. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +28 -14
  15. data/lib/google/cloud/datacatalog/v1/tags_pb.rb +3 -0
  16. data/lib/google/cloud/datacatalog/v1/usage_pb.rb +31 -0
  17. data/proto_docs/google/cloud/datacatalog/v1/bigquery.rb +87 -0
  18. data/proto_docs/google/cloud/datacatalog/v1/common.rb +1 -2
  19. data/proto_docs/google/cloud/datacatalog/v1/data_source.rb +6 -5
  20. data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +370 -246
  21. data/proto_docs/google/cloud/datacatalog/v1/gcs_fileset_spec.rb +16 -15
  22. data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +87 -71
  23. data/proto_docs/google/cloud/datacatalog/v1/policytagmanagerserialization.rb +34 -19
  24. data/proto_docs/google/cloud/datacatalog/v1/schema.rb +3 -3
  25. data/proto_docs/google/cloud/datacatalog/v1/search.rb +43 -29
  26. data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +23 -16
  27. data/proto_docs/google/cloud/datacatalog/v1/tags.rb +96 -51
  28. data/proto_docs/google/cloud/datacatalog/v1/timestamps.rb +12 -5
  29. data/proto_docs/google/cloud/datacatalog/v1/usage.rb +79 -0
  30. metadata +6 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d06bb3a84476a4087453bde146f9e0a59d5cdb0e92bc66809ce6947f49a10dc4
4
- data.tar.gz: 5b91a33cdfa973e5c95e41e1e4bab8f22023a67461967adc6e6a9bd670842d76
3
+ metadata.gz: ba6dc6009a98c8a25f244e37fadd139b37a2c100f1c855d599baf304a7c570aa
4
+ data.tar.gz: d5d529cebde9376bcafe9fac5ac1da3ceab4157365e84532a023ed5c96b3ce67
5
5
  SHA512:
6
- metadata.gz: 414883ffab5f4ea94ca340935187604727e5612072abacf01d280bd5cd1805e2fe456ba2d33031c0d39e58d12c3e70e3d5feb4af8c4bdb8baa48f597e4c35857
7
- data.tar.gz: 586188f37051be64cdd805f55b8abfd08c96f316936e99e779b7803d5371b737e8df09434274ac0692578d571152f0ded068e4b23a8b3c619f54c99c2a4d9984
6
+ metadata.gz: 0f956bfe7c2dc686e35ba1ff2be245ed7792806942ec1f5cb196a85e85750ea0ffc3c7d6b97268a7f3315ef190713265ac5e0e2ef3e3a6f847ff42ec33f6162f
7
+ data.tar.gz: 97e0d45757d40e7be14c3bac848adcb81f7090272413fc81c7ea56fc3a9483ec42808eff5c3f4a43061e78c97edf508a79fd41d9e5a967568290e00dbfc5c75f
@@ -31,8 +31,8 @@ module Google
31
31
  module DataCatalog
32
32
  module V1
33
33
  ##
34
- # Data Catalog API service allows clients to discover, understand, and manage
35
- # their data.
34
+ # Data Catalog API service allows you to discover, understand, and manage
35
+ # your data.
36
36
  #
37
37
  # To load this service and instantiate a client:
38
38
  #
@@ -27,8 +27,8 @@ module Google
27
27
  ##
28
28
  # Client for the DataCatalog service.
29
29
  #
30
- # Data Catalog API service allows clients to discover, understand, and manage
31
- # their data.
30
+ # Data Catalog API service allows you to discover, understand, and manage
31
+ # your data.
32
32
  #
33
33
  class Client
34
34
  include Paths
@@ -194,22 +194,21 @@ module Google
194
194
  # Service calls
195
195
 
196
196
  ##
197
- # Searches Data Catalog for multiple resources like entries, tags that
197
+ # Searches Data Catalog for multiple resources like entries and tags that
198
198
  # match a query.
199
199
  #
200
- # This is a custom method
201
- # (https://cloud.google.com/apis/design/custom_methods) and does not return
202
- # the complete resource, only the resource identifier and high level
203
- # fields. Clients can subsequently call `Get` methods.
200
+ # This is a [Custom Method]
201
+ # (https://cloud.google.com/apis/design/custom_methods) that doesn't return
202
+ # all information on a resource, only its ID and high level fields. To get
203
+ # more information, you can subsequently call specific get methods.
204
204
  #
205
- # Note that Data Catalog search queries do not guarantee full recall. Query
206
- # results that match your query may not be returned, even in subsequent
207
- # result pages. Also note that results returned (and not returned) can vary
208
- # across repeated search queries.
205
+ # Note: Data Catalog search queries don't guarantee full recall. Results
206
+ # that match your query might not be returned, even in subsequent
207
+ # result pages. Additionally, returned (and not returned) results can vary
208
+ # if you repeat search queries.
209
209
  #
210
- # See [Data Catalog Search
211
- # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
212
- # for more information.
210
+ # For more information, see [Data Catalog search syntax]
211
+ # (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
213
212
  #
214
213
  # @overload search_catalog(request, options = nil)
215
214
  # Pass arguments to `search_catalog` via a request object, either of type
@@ -227,43 +226,47 @@ module Google
227
226
  # the default parameter values, pass an empty Hash as a request object (see above).
228
227
  #
229
228
  # @param scope [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, ::Hash]
230
- # Required. The scope of this search request. A `scope` that has empty
231
- # `include_org_ids`, `include_project_ids` AND false
232
- # `include_gcp_public_datasets` is considered invalid. Data Catalog will
233
- # return an error in such a case.
229
+ # Required. The scope of this search request.
230
+ #
231
+ # The `scope` is invalid if `include_org_ids`, `include_project_ids` are
232
+ # empty AND `include_gcp_public_datasets` is set to `false`. In this case,
233
+ # the request returns an error.
234
234
  # @param query [::String]
235
- # Optional. The query string in search query syntax. An empty query string will result
236
- # in all data assets (in the specified scope) that the user has access to.
235
+ # Optional. The query string with a minimum of 3 characters and specific syntax.
236
+ # For more information, see
237
+ # [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference).
237
238
  #
238
- # Query strings can be simple as "x" or more qualified as:
239
+ # An empty query string returns all data assets (in the specified scope)
240
+ # that you have access to.
239
241
  #
240
- # * name:x
241
- # * column:x
242
- # * description:y
242
+ # A query string can be a simple `xyz` or qualified by predicates:
243
243
  #
244
- # Note: Query tokens need to have a minimum of 3 characters for substring
245
- # matching to work correctly. See [Data Catalog Search
246
- # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
247
- # for more information.
244
+ # * `name:x`
245
+ # * `column:y`
246
+ # * `description:z`
248
247
  # @param page_size [::Integer]
249
- # Number of results in the search page. If <=0 then defaults to 10. Max limit
250
- # for page_size is 1000. Throws an invalid argument for page_size > 1000.
248
+ # Number of results to return in a single search page.
249
+ #
250
+ # Can't be negative or 0, defaults to 10 in this case.
251
+ # The maximum number is 1000. If exceeded, throws an "invalid argument"
252
+ # exception.
251
253
  # @param page_token [::String]
252
- # Optional. Pagination token returned in an earlier
253
- # {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}, which
254
- # indicates that this is a continuation of a prior
254
+ # Optional. Pagination token that, if specified, returns the next page of search
255
+ # results. If empty, returns the first page.
256
+ #
257
+ # This token is returned in the {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}
258
+ # field of the response to a previous
255
259
  # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
256
- # call, and that the system should return the next page of data. If empty,
257
- # the first page is returned.
260
+ # call.
258
261
  # @param order_by [::String]
259
- # Specifies the ordering of results, currently supported case-sensitive
260
- # choices are:
262
+ # Specifies the order of results.
261
263
  #
262
- # * `relevance`, only supports descending
263
- # * `last_modified_timestamp [asc|desc]`, defaults to descending if not
264
- # specified
264
+ # Currently supported case-sensitive values are:
265
265
  #
266
- # If not specified, defaults to `relevance` descending.
266
+ # * `relevance` that can only be descending
267
+ # * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
268
+ #
269
+ # If this parameter is omitted, it defaults to the descending `relevance`.
267
270
  #
268
271
  # @yield [response, operation] Access the result along with the RPC operation
269
272
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
@@ -306,25 +309,33 @@ module Google
306
309
  end
307
310
 
308
311
  ##
309
- # Creates an EntryGroup.
312
+ # Creates an entry group.
313
+ #
314
+ # An entry group contains logically related entries together with [Cloud
315
+ # Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
316
+ # These policies specify users who can create, edit, and view entries
317
+ # within entry groups.
310
318
  #
311
- # An entry group contains logically related entries together with Cloud
312
- # Identity and Access Management policies that specify the users who can
313
- # create, edit, and view entries within the entry group.
319
+ # Data Catalog automatically creates entry groups with names that start with
320
+ # the `@` symbol for the following resources:
314
321
  #
315
- # Data Catalog automatically creates an entry group for BigQuery entries
316
- # ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry
317
- # group to contain Cloud Storage fileset entries or custom type entries,
318
- # and the IAM policies associated with those entries. Entry groups, like
319
- # entries, can be searched.
322
+ # * BigQuery entries (`@bigquery`)
323
+ # * Pub/Sub topics (`@pubsub`)
324
+ # * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
325
+ #
326
+ # You can create your own entry groups for Cloud Storage fileset entries
327
+ # and custom entries together with the corresponding IAM policies.
328
+ # User-created entry groups can't contain the `@` symbol, it is reserved
329
+ # for automatically created groups.
330
+ #
331
+ # Entry groups, like entries, can be searched.
320
332
  #
321
333
  # A maximum of 10,000 entry groups may be created per organization across all
322
334
  # locations.
323
335
  #
324
- # Users should enable the Data Catalog API in the project identified by
325
- # the `parent` parameter (see [Data Catalog Resource Project]
326
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
327
- # more information).
336
+ # You must enable the Data Catalog API in the project identified by
337
+ # the `parent` parameter. For more information, see [Data Catalog resource
338
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
328
339
  #
329
340
  # @overload create_entry_group(request, options = nil)
330
341
  # Pass arguments to `create_entry_group` via a request object, either of type
@@ -342,9 +353,7 @@ module Google
342
353
  # the default parameter values, pass an empty Hash as a request object (see above).
343
354
  #
344
355
  # @param parent [::String]
345
- # Required. The name of the project this entry group belongs to. Example:
346
- #
347
- # `projects/{project_id}/locations/{location}`
356
+ # Required. The names of the project and location that the new entry group belongs to.
348
357
  #
349
358
  # Note: The entry group itself and its child resources might not be
350
359
  # stored in the location specified in its name.
@@ -355,7 +364,7 @@ module Google
355
364
  # underscores (_), and must start with a letter or underscore.
356
365
  # The maximum size is 64 bytes when encoded in UTF-8.
357
366
  # @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
358
- # The entry group to create. Defaults to an empty entry group.
367
+ # The entry group to create. Defaults to empty.
359
368
  #
360
369
  # @yield [response, operation] Access the result along with the RPC operation
361
370
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
@@ -403,7 +412,7 @@ module Google
403
412
  end
404
413
 
405
414
  ##
406
- # Gets an EntryGroup.
415
+ # Gets an entry group.
407
416
  #
408
417
  # @overload get_entry_group(request, options = nil)
409
418
  # Pass arguments to `get_entry_group` via a request object, either of type
@@ -421,10 +430,9 @@ module Google
421
430
  # the default parameter values, pass an empty Hash as a request object (see above).
422
431
  #
423
432
  # @param name [::String]
424
- # Required. The name of the entry group. For example,
425
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
433
+ # Required. The name of the entry group to get.
426
434
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
427
- # The fields to return. If not set or empty, all fields are returned.
435
+ # The fields to return. If empty or omitted, all fields are returned.
428
436
  #
429
437
  # @yield [response, operation] Access the result along with the RPC operation
430
438
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
@@ -472,11 +480,12 @@ module Google
472
480
  end
473
481
 
474
482
  ##
475
- # Updates an EntryGroup. The user should enable the Data Catalog API in the
476
- # project identified by the `entry_group.name` parameter (see [Data Catalog
477
- # Resource Project]
478
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
479
- # more information).
483
+ # Updates an entry group.
484
+ #
485
+ # You must enable the Data Catalog API in the project identified by
486
+ # the `entry_group.name` parameter. For more information, see [Data Catalog
487
+ # resource
488
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
480
489
  #
481
490
  # @overload update_entry_group(request, options = nil)
482
491
  # Pass arguments to `update_entry_group` via a request object, either of type
@@ -494,7 +503,7 @@ module Google
494
503
  # the default parameter values, pass an empty Hash as a request object (see above).
495
504
  #
496
505
  # @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
497
- # Required. The updated entry group. "name" field must be set.
506
+ # Required. Updates for the entry group. The `name` field must be set.
498
507
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
499
508
  # Names of fields whose values to overwrite on an entry group.
500
509
  #
@@ -548,11 +557,12 @@ module Google
548
557
  end
549
558
 
550
559
  ##
551
- # Deletes an EntryGroup. Only entry groups that do not contain entries can be
552
- # deleted. Users should enable the Data Catalog API in the project
553
- # identified by the `name` parameter (see [Data Catalog Resource Project]
554
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
555
- # more information).
560
+ # Deletes an entry group.
561
+ #
562
+ # You must enable the Data Catalog API in the project
563
+ # identified by the `name` parameter. For more information, see [Data Catalog
564
+ # resource
565
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
556
566
  #
557
567
  # @overload delete_entry_group(request, options = nil)
558
568
  # Pass arguments to `delete_entry_group` via a request object, either of type
@@ -570,8 +580,7 @@ module Google
570
580
  # the default parameter values, pass an empty Hash as a request object (see above).
571
581
  #
572
582
  # @param name [::String]
573
- # Required. The name of the entry group. For example,
574
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
583
+ # Required. The name of the entry group to delete.
575
584
  # @param force [::Boolean]
576
585
  # Optional. If true, deletes all entries in the entry group.
577
586
  #
@@ -639,16 +648,17 @@ module Google
639
648
  # the default parameter values, pass an empty Hash as a request object (see above).
640
649
  #
641
650
  # @param parent [::String]
642
- # Required. The name of the location that contains the entry groups, which can be
643
- # provided in URL format. Example:
651
+ # Required. The name of the location that contains the entry groups to list.
644
652
  #
645
- # * projects/\\{project_id}/locations/\\{location}
653
+ # Can be provided as a URL.
646
654
  # @param page_size [::Integer]
647
- # Optional. The maximum number of items to return. Default is 10. Max limit is 1000.
648
- # Throws an invalid argument for `page_size > 1000`.
655
+ # Optional. The maximum number of items to return.
656
+ #
657
+ # Default is 10. Maximum limit is 1000.
658
+ # Throws an invalid argument if `page_size` is greater than 1000.
649
659
  # @param page_token [::String]
650
- # Optional. Token that specifies which page is requested. If empty, the first page is
651
- # returned.
660
+ # Optional. Pagination token that specifies the next page to return.
661
+ # If empty, returns the first page.
652
662
  #
653
663
  # @yield [response, operation] Access the result along with the RPC operation
654
664
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
@@ -697,15 +707,17 @@ module Google
697
707
  end
698
708
 
699
709
  ##
700
- # Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM'
701
- # or with a user-specified type can be created.
710
+ # Creates an entry.
711
+ #
712
+ # You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
713
+ # or custom types. Data Catalog automatically creates entries with other
714
+ # types during metadata ingestion from integrated systems.
702
715
  #
703
- # Users should enable the Data Catalog API in the project identified by
704
- # the `parent` parameter (see [Data Catalog Resource Project]
705
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
706
- # more information).
716
+ # You must enable the Data Catalog API in the project identified by
717
+ # the `parent` parameter. For more information, see [Data Catalog resource
718
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
707
719
  #
708
- # A maximum of 100,000 entries may be created per entry group.
720
+ # An entry group can have a maximum of 100,000 entries.
709
721
  #
710
722
  # @overload create_entry(request, options = nil)
711
723
  # Pass arguments to `create_entry` via a request object, either of type
@@ -723,9 +735,7 @@ module Google
723
735
  # the default parameter values, pass an empty Hash as a request object (see above).
724
736
  #
725
737
  # @param parent [::String]
726
- # Required. The name of the entry group this entry belongs to. Example:
727
- #
728
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`
738
+ # Required. The name of the entry group this entry belongs to.
729
739
  #
730
740
  # Note: The entry itself and its child resources might not be stored in
731
741
  # the location specified in its name.
@@ -785,10 +795,11 @@ module Google
785
795
 
786
796
  ##
787
797
  # Updates an existing entry.
788
- # Users should enable the Data Catalog API in the project identified by
789
- # the `entry.name` parameter (see [Data Catalog Resource Project]
790
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
791
- # more information).
798
+ #
799
+ # You must enable the Data Catalog API in the project identified by
800
+ # the `entry.name` parameter. For more information, see [Data Catalog
801
+ # resource
802
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
792
803
  #
793
804
  # @overload update_entry(request, options = nil)
794
805
  # Pass arguments to `update_entry` via a request object, either of type
@@ -806,7 +817,7 @@ module Google
806
817
  # the default parameter values, pass an empty Hash as a request object (see above).
807
818
  #
808
819
  # @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
809
- # Required. The updated entry. The "name" field must be set.
820
+ # Required. Updates for the entry. The `name` field must be set.
810
821
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
811
822
  # Names of fields whose values to overwrite on an entry.
812
823
  #
@@ -814,24 +825,29 @@ module Google
814
825
  # are overwritten. If such fields are non-required and omitted in the
815
826
  # request body, their values are emptied.
816
827
  #
817
- # The following fields are modifiable:
818
- #
819
- # * For entries with type `DATA_STREAM`:
820
- # * `schema`
821
- # * For entries with type `FILESET`:
822
- # * `schema`
823
- # * `display_name`
824
- # * `description`
825
- # * `gcs_fileset_spec`
826
- # * `gcs_fileset_spec.file_patterns`
827
- # * For entries with `user_specified_type`:
828
- # * `schema`
829
- # * `display_name`
830
- # * `description`
831
- # * `user_specified_type`
832
- # * `user_specified_system`
833
- # * `linked_resource`
834
- # * `source_system_timestamps`
828
+ # You can modify only the fields listed below.
829
+ #
830
+ # For entries with type `DATA_STREAM`:
831
+ #
832
+ # * `schema`
833
+ #
834
+ # For entries with type `FILESET`:
835
+ #
836
+ # * `schema`
837
+ # * `display_name`
838
+ # * `description`
839
+ # * `gcs_fileset_spec`
840
+ # * `gcs_fileset_spec.file_patterns`
841
+ #
842
+ # For entries with `user_specified_type`:
843
+ #
844
+ # * `schema`
845
+ # * `display_name`
846
+ # * `description`
847
+ # * `user_specified_type`
848
+ # * `user_specified_system`
849
+ # * `linked_resource`
850
+ # * `source_system_timestamps`
835
851
  #
836
852
  # @yield [response, operation] Access the result along with the RPC operation
837
853
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -879,13 +895,16 @@ module Google
879
895
  end
880
896
 
881
897
  ##
882
- # Deletes an existing entry. Only entries created through
898
+ # Deletes an existing entry.
899
+ #
900
+ # You can delete only the entries created by the
883
901
  # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}
884
- # method can be deleted.
885
- # Users should enable the Data Catalog API in the project identified by
886
- # the `name` parameter (see [Data Catalog Resource Project]
887
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
888
- # more information).
902
+ # method.
903
+ #
904
+ # You must enable the Data Catalog API in the project identified by
905
+ # the `name` parameter. For more information, see [Data Catalog
906
+ # resource
907
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
889
908
  #
890
909
  # @overload delete_entry(request, options = nil)
891
910
  # Pass arguments to `delete_entry` via a request object, either of type
@@ -903,9 +922,7 @@ module Google
903
922
  # the default parameter values, pass an empty Hash as a request object (see above).
904
923
  #
905
924
  # @param name [::String]
906
- # Required. The name of the entry. Example:
907
- #
908
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
925
+ # Required. The name of the entry to delete.
909
926
  #
910
927
  # @yield [response, operation] Access the result along with the RPC operation
911
928
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -971,9 +988,7 @@ module Google
971
988
  # the default parameter values, pass an empty Hash as a request object (see above).
972
989
  #
973
990
  # @param name [::String]
974
- # Required. The name of the entry. Example:
975
- #
976
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
991
+ # Required. The name of the entry to get.
977
992
  #
978
993
  # @yield [response, operation] Access the result along with the RPC operation
979
994
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -1021,9 +1036,9 @@ module Google
1021
1036
  end
1022
1037
 
1023
1038
  ##
1024
- # Get an entry by target resource name. This method allows clients to use
1025
- # the resource name from the source Google Cloud Platform service to get the
1026
- # Data Catalog Entry.
1039
+ # Gets an entry by its target resource name.
1040
+ #
1041
+ # The resource name comes from the source Google Cloud Platform service.
1027
1042
  #
1028
1043
  # @overload lookup_entry(request, options = nil)
1029
1044
  # Pass arguments to `lookup_entry` via a request object, either of type
@@ -1042,27 +1057,27 @@ module Google
1042
1057
  #
1043
1058
  # @param linked_resource [::String]
1044
1059
  # The full name of the Google Cloud Platform resource the Data Catalog
1045
- # entry represents. See:
1046
- # https://cloud.google.com/apis/design/resource_names#full_resource_name.
1047
- # Full names are case-sensitive.
1060
+ # entry represents. For more information, see [Full Resource Name]
1061
+ # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
1048
1062
  #
1049
- # Examples:
1063
+ # Full names are case-sensitive. For example:
1050
1064
  #
1051
- # * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
1052
- # * //pubsub.googleapis.com/projects/projectId/topics/topicId
1065
+ # * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
1066
+ # * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
1053
1067
  # @param sql_resource [::String]
1054
1068
  # The SQL name of the entry. SQL names are case-sensitive.
1055
1069
  #
1056
1070
  # Examples:
1057
1071
  #
1058
- # * `pubsub.project_id.topic_id`
1059
- # * ``pubsub.project_id.`topic.id.with.dots` ``
1060
- # * `bigquery.table.project_id.dataset_id.table_id`
1061
- # * `bigquery.dataset.project_id.dataset_id`
1062
- # * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id`
1072
+ # * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
1073
+ # * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
1074
+ # * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
1075
+ # * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
1076
+ # * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
1063
1077
  #
1064
- # `*_id`s should satisfy the standard SQL rules for identifiers.
1065
- # https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
1078
+ # Identifiers (`*_ID`) should comply with the
1079
+ # [Lexical structure in Standard SQL]
1080
+ # (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
1066
1081
  # @param fully_qualified_name [::String]
1067
1082
  # Fully qualified name (FQN) of the resource.
1068
1083
  #
@@ -1078,7 +1093,7 @@ module Google
1078
1093
  #
1079
1094
  # Example for a DPMS table:
1080
1095
  #
1081
- # `dataproc_metastore:project_id.location_id.instance_id.database_id.table_id`
1096
+ # `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
1082
1097
  #
1083
1098
  # @yield [response, operation] Access the result along with the RPC operation
1084
1099
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -1138,21 +1153,21 @@ module Google
1138
1153
  # the default parameter values, pass an empty Hash as a request object (see above).
1139
1154
  #
1140
1155
  # @param parent [::String]
1141
- # Required. The name of the entry group that contains the entries, which can
1142
- # be provided in URL format. Example:
1156
+ # Required. The name of the entry group that contains the entries to list.
1143
1157
  #
1144
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
1158
+ # Can be provided in URL format.
1145
1159
  # @param page_size [::Integer]
1146
- # The maximum number of items to return. Default is 10. Max limit is 1000.
1147
- # Throws an invalid argument for `page_size > 1000`.
1160
+ # The maximum number of items to return. Default is 10. Maximum limit is
1161
+ # 1000. Throws an invalid argument if `page_size` is more than 1000.
1148
1162
  # @param page_token [::String]
1149
- # Token that specifies which page is requested. If empty, the first page is
1150
- # returned.
1163
+ # Pagination token that specifies the next page to return. If empty, the
1164
+ # first page is returned.
1151
1165
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1152
- # The fields to return for each Entry. If not set or empty, all
1166
+ # The fields to return for each entry. If empty or omitted, all
1153
1167
  # fields are returned.
1154
- # For example, setting read_mask to contain only one path "name" will cause
1155
- # ListEntries to return a list of Entries with only "name" field.
1168
+ #
1169
+ # For example, to return a list of entries with only the `name` field,
1170
+ # set `read_mask` to only one path with the `name` value.
1156
1171
  #
1157
1172
  # @yield [response, operation] Access the result along with the RPC operation
1158
1173
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>]
@@ -1201,11 +1216,12 @@ module Google
1201
1216
  end
1202
1217
 
1203
1218
  ##
1204
- # Creates a tag template. The user should enable the Data Catalog API in
1205
- # the project identified by the `parent` parameter (see [Data Catalog
1206
- # Resource
1207
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
1208
- # for more information).
1219
+ # Creates a tag template.
1220
+ #
1221
+ # You must enable the Data Catalog API in the project identified by the
1222
+ # `parent` parameter.
1223
+ # For more information, see [Data Catalog resource project]
1224
+ # (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1209
1225
  #
1210
1226
  # @overload create_tag_template(request, options = nil)
1211
1227
  # Pass arguments to `create_tag_template` via a request object, either of type
@@ -1225,10 +1241,6 @@ module Google
1225
1241
  # @param parent [::String]
1226
1242
  # Required. The name of the project and the template location
1227
1243
  # [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
1228
- #
1229
- # Example:
1230
- #
1231
- # * projects/\\{project_id}/locations/us-central1
1232
1244
  # @param tag_template_id [::String]
1233
1245
  # Required. The ID of the tag template to create.
1234
1246
  #
@@ -1302,9 +1314,7 @@ module Google
1302
1314
  # the default parameter values, pass an empty Hash as a request object (see above).
1303
1315
  #
1304
1316
  # @param name [::String]
1305
- # Required. The name of the tag template. Example:
1306
- #
1307
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
1317
+ # Required. The name of the tag template to get.
1308
1318
  #
1309
1319
  # @yield [response, operation] Access the result along with the RPC operation
1310
1320
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplate]
@@ -1352,13 +1362,15 @@ module Google
1352
1362
  end
1353
1363
 
1354
1364
  ##
1355
- # Updates a tag template. This method cannot be used to update the fields of
1356
- # a template. The tag template fields are represented as separate resources
1357
- # and should be updated using their own create/update/delete methods.
1358
- # Users should enable the Data Catalog API in the project identified by
1359
- # the `tag_template.name` parameter (see [Data Catalog Resource Project]
1360
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1361
- # more information).
1365
+ # Updates a tag template.
1366
+ #
1367
+ # You can't update template fields with this method. These fields are
1368
+ # separate resources with their own create, update, and delete methods.
1369
+ #
1370
+ # You must enable the Data Catalog API in the project identified by
1371
+ # the `tag_template.name` parameter. For more information, see [Data Catalog
1372
+ # resource
1373
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1362
1374
  #
1363
1375
  # @overload update_tag_template(request, options = nil)
1364
1376
  # Pass arguments to `update_tag_template` via a request object, either of type
@@ -1376,12 +1388,12 @@ module Google
1376
1388
  # the default parameter values, pass an empty Hash as a request object (see above).
1377
1389
  #
1378
1390
  # @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
1379
- # Required. The template to update. The "name" field must be set.
1391
+ # Required. The template to update. The `name` field must be set.
1380
1392
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1381
1393
  # Names of fields whose values to overwrite on a tag template. Currently,
1382
1394
  # only `display_name` can be overwritten.
1383
1395
  #
1384
- # In general, if this parameter is absent or empty, all modifiable fields
1396
+ # If this parameter is absent or empty, all modifiable fields
1385
1397
  # are overwritten. If such fields are non-required and omitted in the
1386
1398
  # request body, their values are emptied.
1387
1399
  #
@@ -1431,11 +1443,11 @@ module Google
1431
1443
  end
1432
1444
 
1433
1445
  ##
1434
- # Deletes a tag template and all tags using the template.
1435
- # Users should enable the Data Catalog API in the project identified by
1436
- # the `name` parameter (see [Data Catalog Resource Project]
1437
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1438
- # more information).
1446
+ # Deletes a tag template and all tags that use it.
1447
+ #
1448
+ # You must enable the Data Catalog API in the project identified by
1449
+ # the `name` parameter. For more information, see [Data Catalog resource
1450
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1439
1451
  #
1440
1452
  # @overload delete_tag_template(request, options = nil)
1441
1453
  # Pass arguments to `delete_tag_template` via a request object, either of type
@@ -1453,13 +1465,11 @@ module Google
1453
1465
  # the default parameter values, pass an empty Hash as a request object (see above).
1454
1466
  #
1455
1467
  # @param name [::String]
1456
- # Required. The name of the tag template to delete. Example:
1457
- #
1458
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
1468
+ # Required. The name of the tag template to delete.
1459
1469
  # @param force [::Boolean]
1460
- # Required. Currently, this field must always be set to `true`.
1461
- # This confirms the deletion of any possible tags using this template.
1462
- # `force = false` will be supported in the future.
1470
+ # Required. If true, deletes all tags that use this template.
1471
+ #
1472
+ # Currently, `true` is the only supported value.
1463
1473
  #
1464
1474
  # @yield [response, operation] Access the result along with the RPC operation
1465
1475
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1507,11 +1517,11 @@ module Google
1507
1517
  end
1508
1518
 
1509
1519
  ##
1510
- # Creates a field in a tag template. The user should enable the Data Catalog
1511
- # API in the project identified by the `parent` parameter (see
1512
- # [Data Catalog Resource
1513
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
1514
- # for more information).
1520
+ # Creates a field in a tag template.
1521
+ #
1522
+ # You must enable the Data Catalog API in the project identified by
1523
+ # the `parent` parameter. For more information, see [Data Catalog resource
1524
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1515
1525
  #
1516
1526
  # @overload create_tag_template_field(request, options = nil)
1517
1527
  # Pass arguments to `create_tag_template_field` via a request object, either of type
@@ -1531,10 +1541,6 @@ module Google
1531
1541
  # @param parent [::String]
1532
1542
  # Required. The name of the project and the template location
1533
1543
  # [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
1534
- #
1535
- # Example:
1536
- #
1537
- # * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
1538
1544
  # @param tag_template_field_id [::String]
1539
1545
  # Required. The ID of the tag template field to create.
1540
1546
  #
@@ -1593,11 +1599,14 @@ module Google
1593
1599
  end
1594
1600
 
1595
1601
  ##
1596
- # Updates a field in a tag template. This method cannot be used to update the
1597
- # field type. Users should enable the Data Catalog API in the project
1598
- # identified by the `name` parameter (see [Data Catalog Resource Project]
1599
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1600
- # more information).
1602
+ # Updates a field in a tag template.
1603
+ #
1604
+ # You can't update the field type with this method.
1605
+ #
1606
+ # You must enable the Data Catalog API in the project
1607
+ # identified by the `name` parameter. For more information, see [Data Catalog
1608
+ # resource
1609
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1601
1610
  #
1602
1611
  # @overload update_tag_template_field(request, options = nil)
1603
1612
  # Pass arguments to `update_tag_template_field` via a request object, either of type
@@ -1615,18 +1624,16 @@ module Google
1615
1624
  # the default parameter values, pass an empty Hash as a request object (see above).
1616
1625
  #
1617
1626
  # @param name [::String]
1618
- # Required. The name of the tag template field. Example:
1619
- #
1620
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1627
+ # Required. The name of the tag template field.
1621
1628
  # @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
1622
1629
  # Required. The template to update.
1623
1630
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1624
1631
  # Optional. Names of fields whose values to overwrite on an individual field of a tag
1625
1632
  # template. The following fields are modifiable:
1626
1633
  #
1627
- # * `display_name`
1628
- # * `type.enum_type`
1629
- # * `is_required`
1634
+ # * `display_name`
1635
+ # * `type.enum_type`
1636
+ # * `is_required`
1630
1637
  #
1631
1638
  # If this parameter is absent or empty, all modifiable fields
1632
1639
  # are overwritten. If such fields are non-required and omitted in the request
@@ -1684,11 +1691,11 @@ module Google
1684
1691
  end
1685
1692
 
1686
1693
  ##
1687
- # Renames a field in a tag template. The user should enable the Data Catalog
1688
- # API in the project identified by the `name` parameter (see [Data Catalog
1689
- # Resource
1690
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
1691
- # for more information).
1694
+ # Renames a field in a tag template.
1695
+ #
1696
+ # You must enable the Data Catalog API in the project identified by the
1697
+ # `name` parameter. For more information, see [Data Catalog resource project]
1698
+ # (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1692
1699
  #
1693
1700
  # @overload rename_tag_template_field(request, options = nil)
1694
1701
  # Pass arguments to `rename_tag_template_field` via a request object, either of type
@@ -1706,9 +1713,7 @@ module Google
1706
1713
  # the default parameter values, pass an empty Hash as a request object (see above).
1707
1714
  #
1708
1715
  # @param name [::String]
1709
- # Required. The name of the tag template. Example:
1710
- #
1711
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1716
+ # Required. The name of the tag template.
1712
1717
  # @param new_tag_template_field_id [::String]
1713
1718
  # Required. The new ID of this tag template field. For example, `my_new_field`.
1714
1719
  #
@@ -1758,8 +1763,9 @@ module Google
1758
1763
  end
1759
1764
 
1760
1765
  ##
1761
- # Renames an enum value in a tag template. The enum values have to be unique
1762
- # within one enum field.
1766
+ # Renames an enum value in a tag template.
1767
+ #
1768
+ # Within a single enum field, enum values must be unique.
1763
1769
  #
1764
1770
  # @overload rename_tag_template_field_enum_value(request, options = nil)
1765
1771
  # Pass arguments to `rename_tag_template_field_enum_value` via a request object, either of type
@@ -1777,9 +1783,7 @@ module Google
1777
1783
  # the default parameter values, pass an empty Hash as a request object (see above).
1778
1784
  #
1779
1785
  # @param name [::String]
1780
- # Required. The name of the enum field value. Example:
1781
- #
1782
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}/enumValues/\\{enum_value_display_name}
1786
+ # Required. The name of the enum field value.
1783
1787
  # @param new_enum_value_display_name [::String]
1784
1788
  # Required. The new display name of the enum value. For example, `my_new_enum_value`.
1785
1789
  #
@@ -1829,11 +1833,12 @@ module Google
1829
1833
  end
1830
1834
 
1831
1835
  ##
1832
- # Deletes a field in a tag template and all uses of that field.
1833
- # Users should enable the Data Catalog API in the project identified by
1834
- # the `name` parameter (see [Data Catalog Resource Project]
1835
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
1836
- # more information).
1836
+ # Deletes a field in a tag template and all uses of this field from the tags
1837
+ # based on this template.
1838
+ #
1839
+ # You must enable the Data Catalog API in the project identified by
1840
+ # the `name` parameter. For more information, see [Data Catalog resource
1841
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
1837
1842
  #
1838
1843
  # @overload delete_tag_template_field(request, options = nil)
1839
1844
  # Pass arguments to `delete_tag_template_field` via a request object, either of type
@@ -1851,13 +1856,11 @@ module Google
1851
1856
  # the default parameter values, pass an empty Hash as a request object (see above).
1852
1857
  #
1853
1858
  # @param name [::String]
1854
- # Required. The name of the tag template field to delete. Example:
1855
- #
1856
- # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1859
+ # Required. The name of the tag template field to delete.
1857
1860
  # @param force [::Boolean]
1858
- # Required. Currently, this field must always be set to `true`.
1859
- # This confirms the deletion of this field from any tags using this field.
1860
- # `force = false` will be supported in the future.
1861
+ # Required. If true, deletes this field from any tags that use it.
1862
+ #
1863
+ # Currently, `true` is the only supported value.
1861
1864
  #
1862
1865
  # @yield [response, operation] Access the result along with the RPC operation
1863
1866
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1905,13 +1908,18 @@ module Google
1905
1908
  end
1906
1909
 
1907
1910
  ##
1908
- # Creates a tag on an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
1909
- # Note: The project identified by the `parent` parameter for the
1910
- # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
1911
- # and the
1912
- # [tag
1913
- # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
1914
- # used to create the tag must be from the same organization.
1911
+ # Creates a tag and assigns it to:
1912
+ #
1913
+ # * An {::Google::Cloud::DataCatalog::V1::Entry Entry} if the method name is
1914
+ # ``projects.locations.entryGroups.entries.tags.create``.
1915
+ # * Or {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}if the method
1916
+ # name is ``projects.locations.entryGroups.tags.create``.
1917
+ #
1918
+ # Note: The project identified by the `parent` parameter for the [tag]
1919
+ # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
1920
+ # and the [tag template]
1921
+ # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
1922
+ # used to create the tag must be in the same organization.
1915
1923
  #
1916
1924
  # @overload create_tag(request, options = nil)
1917
1925
  # Pass arguments to `create_tag` via a request object, either of type
@@ -1929,10 +1937,10 @@ module Google
1929
1937
  # the default parameter values, pass an empty Hash as a request object (see above).
1930
1938
  #
1931
1939
  # @param parent [::String]
1932
- # Required. The name of the resource to attach this tag to. Tags can be attached to
1933
- # entries. An entry can have up to 1000 attached tags. Example:
1940
+ # Required. The name of the resource to attach this tag to.
1934
1941
  #
1935
- # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}`
1942
+ # Tags can be attached to entries or entry groups. An entry can have up to
1943
+ # 1000 attached tags.
1936
1944
  #
1937
1945
  # Note: The tag and its child resources might not be stored in
1938
1946
  # the location specified in its name.
@@ -2076,9 +2084,7 @@ module Google
2076
2084
  # the default parameter values, pass an empty Hash as a request object (see above).
2077
2085
  #
2078
2086
  # @param name [::String]
2079
- # Required. The name of the tag to delete. Example:
2080
- #
2081
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
2087
+ # Required. The name of the tag to delete.
2082
2088
  #
2083
2089
  # @yield [response, operation] Access the result along with the RPC operation
2084
2090
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -2126,7 +2132,7 @@ module Google
2126
2132
  end
2127
2133
 
2128
2134
  ##
2129
- # Lists the tags on an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
2135
+ # Lists tags assigned to an {::Google::Cloud::DataCatalog::V1::Entry Entry}.
2130
2136
  #
2131
2137
  # @overload list_tags(request, options = nil)
2132
2138
  # Pass arguments to `list_tags` via a request object, either of type
@@ -2144,19 +2150,16 @@ module Google
2144
2150
  # the default parameter values, pass an empty Hash as a request object (see above).
2145
2151
  #
2146
2152
  # @param parent [::String]
2147
- # Required. The name of the Data Catalog resource to list the tags of. The resource
2148
- # could be an {::Google::Cloud::DataCatalog::V1::Entry Entry} or an
2149
- # {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
2153
+ # Required. The name of the Data Catalog resource to list the tags of.
2150
2154
  #
2151
- # Examples:
2152
- #
2153
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
2154
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
2155
+ # The resource can be an {::Google::Cloud::DataCatalog::V1::Entry Entry}
2156
+ # or an {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}
2157
+ # (without `/entries/{entries}` at the end).
2155
2158
  # @param page_size [::Integer]
2156
- # The maximum number of tags to return. Default is 10. Max limit is 1000.
2159
+ # The maximum number of tags to return. Default is 10. Maximum limit is 1000.
2157
2160
  # @param page_token [::String]
2158
- # Token that specifies which page is requested. If empty, the first page is
2159
- # returned.
2161
+ # Pagination token that specifies the next page to return. If empty, the
2162
+ # first page is returned.
2160
2163
  #
2161
2164
  # @yield [response, operation] Access the result along with the RPC operation
2162
2165
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>]
@@ -2205,20 +2208,23 @@ module Google
2205
2208
  end
2206
2209
 
2207
2210
  ##
2208
- # Sets the access control policy for a resource. Replaces any existing
2211
+ # Sets an access control policy for a resource. Replaces any existing
2209
2212
  # policy.
2213
+ #
2210
2214
  # Supported resources are:
2211
- # - Tag templates.
2212
- # - Entries.
2213
- # - Entry groups.
2214
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2215
- # and any external Google Cloud Platform resources synced to Data Catalog.
2216
- #
2217
- # Callers must have following Google IAM permission
2218
- # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
2219
- # templates.
2220
- # - `datacatalog.entries.setIamPolicy` to set policies on entries.
2221
- # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
2215
+ #
2216
+ # - Tag templates
2217
+ # - Entry groups
2218
+ #
2219
+ # Note: This method sets policies only within Data Catalog and can't be
2220
+ # used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
2221
+ # external Google Cloud Platform resources synced with the Data Catalog.
2222
+ #
2223
+ # To call this method, you must have the following Google IAM permissions:
2224
+ #
2225
+ # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
2226
+ # templates.
2227
+ # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
2222
2228
  #
2223
2229
  # @overload set_iam_policy(request, options = nil)
2224
2230
  # Pass arguments to `set_iam_policy` via a request object, either of type
@@ -2290,22 +2296,27 @@ module Google
2290
2296
  end
2291
2297
 
2292
2298
  ##
2293
- # Gets the access control policy for a resource. A `NOT_FOUND` error
2294
- # is returned if the resource does not exist. An empty policy is returned
2295
- # if the resource exists but does not have a policy set on it.
2299
+ # Gets the access control policy for a resource.
2300
+ #
2301
+ # May return:
2302
+ #
2303
+ # * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
2304
+ # permission to view it.
2305
+ # * An empty policy if the resource exists but doesn't have a set policy.
2296
2306
  #
2297
2307
  # Supported resources are:
2298
- # - Tag templates.
2299
- # - Entries.
2300
- # - Entry groups.
2301
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2302
- # and any external Google Cloud Platform resources synced to Data Catalog.
2303
- #
2304
- # Callers must have following Google IAM permission
2305
- # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
2306
- # templates.
2307
- # - `datacatalog.entries.getIamPolicy` to get policies on entries.
2308
- # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
2308
+ #
2309
+ # - Tag templates
2310
+ # - Entry groups
2311
+ #
2312
+ # Note: This method doesn't get policies from Google Cloud Platform
2313
+ # resources ingested into Data Catalog.
2314
+ #
2315
+ # To call this method, you must have the following Google IAM permissions:
2316
+ #
2317
+ # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
2318
+ # templates.
2319
+ # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
2309
2320
  #
2310
2321
  # @overload get_iam_policy(request, options = nil)
2311
2322
  # Pass arguments to `get_iam_policy` via a request object, either of type
@@ -2375,19 +2386,20 @@ module Google
2375
2386
  end
2376
2387
 
2377
2388
  ##
2378
- # Returns the caller's permissions on a resource.
2379
- # If the resource does not exist, an empty set of permissions is returned
2380
- # (We don't return a `NOT_FOUND` error).
2389
+ # Gets your permissions on a resource.
2390
+ #
2391
+ # Returns an empty set of permissions if the resource doesn't exist.
2381
2392
  #
2382
2393
  # Supported resources are:
2383
- # - Tag templates.
2384
- # - Entries.
2385
- # - Entry groups.
2386
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2387
- # and any external Google Cloud Platform resources synced to Data Catalog.
2388
- #
2389
- # A caller is not required to have Google IAM permission to make this
2390
- # request.
2394
+ #
2395
+ # - Tag templates
2396
+ # - Entry groups
2397
+ #
2398
+ # Note: This method gets policies only within Data Catalog and can't be
2399
+ # used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
2400
+ # external Google Cloud Platform resources ingested into Data Catalog.
2401
+ #
2402
+ # No Google IAM permissions are required to call this method.
2391
2403
  #
2392
2404
  # @overload test_iam_permissions(request, options = nil)
2393
2405
  # Pass arguments to `test_iam_permissions` via a request object, either of type