google-cloud-data_catalog-v1 0.5.0 → 0.7.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/LICENSE.md +188 -190
  4. data/README.md +3 -3
  5. data/lib/google/cloud/data_catalog/v1.rb +2 -0
  6. data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +222 -128
  7. data/lib/google/cloud/data_catalog/v1/data_catalog/paths.rb +23 -0
  8. data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +54 -0
  9. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +1321 -0
  10. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/credentials.rb +51 -0
  11. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/paths.rb +90 -0
  12. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +51 -0
  13. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +474 -0
  14. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/credentials.rb +51 -0
  15. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/paths.rb +69 -0
  16. data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
  17. data/lib/google/cloud/datacatalog/v1/common_pb.rb +1 -0
  18. data/lib/google/cloud/datacatalog/v1/data_source_pb.rb +30 -0
  19. data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +25 -0
  20. data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +6 -3
  21. data/lib/google/cloud/datacatalog/v1/policytagmanager_pb.rb +107 -0
  22. data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +86 -0
  23. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +70 -0
  24. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +62 -0
  25. data/lib/google/cloud/datacatalog/v1/search_pb.rb +2 -0
  26. data/lib/google/cloud/datacatalog/v1/table_spec_pb.rb +1 -0
  27. data/lib/google/cloud/datacatalog/v1/tags_pb.rb +1 -0
  28. data/proto_docs/google/api/field_behavior.rb +7 -1
  29. data/proto_docs/google/cloud/datacatalog/v1/common.rb +3 -0
  30. data/proto_docs/google/cloud/datacatalog/v1/data_source.rb +51 -0
  31. data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +212 -111
  32. data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +303 -0
  33. data/proto_docs/google/cloud/datacatalog/v1/policytagmanagerserialization.rb +141 -0
  34. data/proto_docs/google/cloud/datacatalog/v1/schema.rb +16 -4
  35. data/proto_docs/google/cloud/datacatalog/v1/search.rb +14 -0
  36. data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +3 -0
  37. data/proto_docs/google/cloud/datacatalog/v1/tags.rb +44 -21
  38. data/proto_docs/google/type/expr.rb +35 -12
  39. metadata +34 -12
@@ -17,6 +17,8 @@
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
19
  require "google/cloud/data_catalog/v1/data_catalog"
20
+ require "google/cloud/data_catalog/v1/policy_tag_manager"
21
+ require "google/cloud/data_catalog/v1/policy_tag_manager_serialization"
20
22
  require "google/cloud/data_catalog/v1/version"
21
23
 
22
24
  module Google
@@ -61,7 +61,7 @@ module Google
61
61
  parent_config = while namespace.any?
62
62
  parent_name = namespace.join "::"
63
63
  parent_const = const_get parent_name
64
- break parent_const.configure if parent_const&.respond_to? :configure
64
+ break parent_const.configure if parent_const.respond_to? :configure
65
65
  namespace.pop
66
66
  end
67
67
  default_config = Client::Configuration.new parent_config
@@ -70,66 +70,42 @@ module Google
70
70
 
71
71
  default_config.rpcs.search_catalog.timeout = 60.0
72
72
  default_config.rpcs.search_catalog.retry_policy = {
73
- initial_delay: 0.1,
74
- max_delay: 60.0,
75
- multiplier: 1.3,
76
- retry_codes: [14]
73
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
77
74
  }
78
75
 
79
76
  default_config.rpcs.get_entry_group.timeout = 60.0
80
77
  default_config.rpcs.get_entry_group.retry_policy = {
81
- initial_delay: 0.1,
82
- max_delay: 60.0,
83
- multiplier: 1.3,
84
- retry_codes: [14]
78
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
85
79
  }
86
80
 
87
81
  default_config.rpcs.list_entry_groups.timeout = 60.0
88
82
  default_config.rpcs.list_entry_groups.retry_policy = {
89
- initial_delay: 0.1,
90
- max_delay: 60.0,
91
- multiplier: 1.3,
92
- retry_codes: [14]
83
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
93
84
  }
94
85
 
95
86
  default_config.rpcs.get_entry.timeout = 60.0
96
87
  default_config.rpcs.get_entry.retry_policy = {
97
- initial_delay: 0.1,
98
- max_delay: 60.0,
99
- multiplier: 1.3,
100
- retry_codes: [14]
88
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
101
89
  }
102
90
 
103
91
  default_config.rpcs.lookup_entry.timeout = 60.0
104
92
  default_config.rpcs.lookup_entry.retry_policy = {
105
- initial_delay: 0.1,
106
- max_delay: 60.0,
107
- multiplier: 1.3,
108
- retry_codes: [14]
93
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
109
94
  }
110
95
 
111
96
  default_config.rpcs.list_entries.timeout = 60.0
112
97
  default_config.rpcs.list_entries.retry_policy = {
113
- initial_delay: 0.1,
114
- max_delay: 60.0,
115
- multiplier: 1.3,
116
- retry_codes: [14]
98
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
117
99
  }
118
100
 
119
101
  default_config.rpcs.list_tags.timeout = 60.0
120
102
  default_config.rpcs.list_tags.retry_policy = {
121
- initial_delay: 0.1,
122
- max_delay: 60.0,
123
- multiplier: 1.3,
124
- retry_codes: [14]
103
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
125
104
  }
126
105
 
127
106
  default_config.rpcs.get_iam_policy.timeout = 60.0
128
107
  default_config.rpcs.get_iam_policy.retry_policy = {
129
- initial_delay: 0.1,
130
- max_delay: 60.0,
131
- multiplier: 1.3,
132
- retry_codes: [14]
108
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
133
109
  }
134
110
 
135
111
  default_config
@@ -198,9 +174,9 @@ module Google
198
174
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
199
175
  @config.endpoint == Client.configure.endpoint &&
200
176
  !@config.endpoint.split(".").first.include?("-")
201
- credentials ||= Credentials.default scope: @config.scope,
177
+ credentials ||= Credentials.default scope: @config.scope,
202
178
  enable_self_signed_jwt: enable_self_signed_jwt
203
- if credentials.is_a?(String) || credentials.is_a?(Hash)
179
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
204
180
  credentials = Credentials.new credentials, scope: @config.scope
205
181
  end
206
182
  @quota_project_id = @config.quota_project
@@ -224,7 +200,7 @@ module Google
224
200
  # This is a custom method
225
201
  # (https://cloud.google.com/apis/design/custom_methods) and does not return
226
202
  # the complete resource, only the resource identifier and high level
227
- # fields. Clients can subsequentally call `Get` methods.
203
+ # fields. Clients can subsequently call `Get` methods.
228
204
  #
229
205
  # Note that Data Catalog search queries do not guarantee full recall. Query
230
206
  # results that match your query may not be returned, even in subsequent
@@ -256,8 +232,8 @@ module Google
256
232
  # `include_gcp_public_datasets` is considered invalid. Data Catalog will
257
233
  # return an error in such a case.
258
234
  # @param query [::String]
259
- # Required. The query string in search query syntax. The query must be
260
- # non-empty.
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.
261
237
  #
262
238
  # Query strings can be simple as "x" or more qualified as:
263
239
  #
@@ -274,8 +250,8 @@ module Google
274
250
  # for page_size is 1000. Throws an invalid argument for page_size > 1000.
275
251
  # @param page_token [::String]
276
252
  # Optional. Pagination token returned in an earlier
277
- # {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token},
278
- # which indicates that this is a continuation of a prior
253
+ # {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}, which
254
+ # indicates that this is a continuation of a prior
279
255
  # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
280
256
  # call, and that the system should return the next page of data. If empty,
281
257
  # the first page is returned.
@@ -366,16 +342,18 @@ module Google
366
342
  # the default parameter values, pass an empty Hash as a request object (see above).
367
343
  #
368
344
  # @param parent [::String]
369
- # Required. The name of the project this entry group is in. Example:
345
+ # Required. The name of the project this entry group belongs to. Example:
370
346
  #
371
- # * projects/\\{project_id}/locations/\\{location}
347
+ # `projects/{project_id}/locations/{location}`
372
348
  #
373
- # Note that this EntryGroup and its child resources may not actually be
374
- # stored in the location in this name.
349
+ # Note: The entry group itself and its child resources might not be
350
+ # stored in the location specified in its name.
375
351
  # @param entry_group_id [::String]
376
- # Required. The id of the entry group to create.
377
- # The id must begin with a letter or underscore, contain only English
378
- # letters, numbers and underscores, and be at most 64 characters.
352
+ # Required. The ID of the entry group to create.
353
+ #
354
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9),
355
+ # underscores (_), and must start with a letter or underscore.
356
+ # The maximum size is 64 bytes when encoded in UTF-8.
379
357
  # @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
380
358
  # The entry group to create. Defaults to an empty entry group.
381
359
  #
@@ -518,8 +496,11 @@ module Google
518
496
  # @param entry_group [::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash]
519
497
  # Required. The updated entry group. "name" field must be set.
520
498
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
521
- # The fields to update on the entry group. If absent or empty, all modifiable
522
- # fields are updated.
499
+ # Names of fields whose values to overwrite on an entry group.
500
+ #
501
+ # If this parameter is absent or empty, all modifiable fields
502
+ # are overwritten. If such fields are non-required and omitted in the
503
+ # request body, their values are emptied.
523
504
  #
524
505
  # @yield [response, operation] Access the result along with the RPC operation
525
506
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::EntryGroup]
@@ -658,16 +639,16 @@ module Google
658
639
  # the default parameter values, pass an empty Hash as a request object (see above).
659
640
  #
660
641
  # @param parent [::String]
661
- # Required. The name of the location that contains the entry groups, which
662
- # can be provided in URL format. Example:
642
+ # Required. The name of the location that contains the entry groups, which can be
643
+ # provided in URL format. Example:
663
644
  #
664
645
  # * projects/\\{project_id}/locations/\\{location}
665
646
  # @param page_size [::Integer]
666
- # Optional. The maximum number of items to return. Default is 10. Max limit
667
- # is 1000. Throws an invalid argument for `page_size > 1000`.
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`.
668
649
  # @param page_token [::String]
669
- # Optional. Token that specifies which page is requested. If empty, the first
670
- # page is returned.
650
+ # Optional. Token that specifies which page is requested. If empty, the first page is
651
+ # returned.
671
652
  #
672
653
  # @yield [response, operation] Access the result along with the RPC operation
673
654
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>]
@@ -716,8 +697,8 @@ module Google
716
697
  end
717
698
 
718
699
  ##
719
- # Creates an entry. Only entries of 'FILESET' type or user-specified type can
720
- # be created.
700
+ # Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM'
701
+ # or with a user-specified type can be created.
721
702
  #
722
703
  # Users should enable the Data Catalog API in the project identified by
723
704
  # the `parent` parameter (see [Data Catalog Resource Project]
@@ -742,14 +723,18 @@ module Google
742
723
  # the default parameter values, pass an empty Hash as a request object (see above).
743
724
  #
744
725
  # @param parent [::String]
745
- # Required. The name of the entry group this entry is in. Example:
726
+ # Required. The name of the entry group this entry belongs to. Example:
746
727
  #
747
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
728
+ # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`
748
729
  #
749
- # Note that this Entry and its child resources may not actually be stored in
750
- # the location in this name.
730
+ # Note: The entry itself and its child resources might not be stored in
731
+ # the location specified in its name.
751
732
  # @param entry_id [::String]
752
- # Required. The id of the entry to create.
733
+ # Required. The ID of the entry to create.
734
+ #
735
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9),
736
+ # and underscores (_).
737
+ # The maximum size is 64 bytes when encoded in UTF-8.
753
738
  # @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
754
739
  # Required. The entry to create.
755
740
  #
@@ -823,26 +808,30 @@ module Google
823
808
  # @param entry [::Google::Cloud::DataCatalog::V1::Entry, ::Hash]
824
809
  # Required. The updated entry. The "name" field must be set.
825
810
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
826
- # The fields to update on the entry. If absent or empty, all modifiable
827
- # fields are updated.
811
+ # Names of fields whose values to overwrite on an entry.
812
+ #
813
+ # If this parameter is absent or empty, all modifiable fields
814
+ # are overwritten. If such fields are non-required and omitted in the
815
+ # request body, their values are emptied.
828
816
  #
829
817
  # The following fields are modifiable:
818
+ #
830
819
  # * For entries with type `DATA_STREAM`:
831
820
  # * `schema`
832
- # * For entries with type `FILESET`
821
+ # * For entries with type `FILESET`:
833
822
  # * `schema`
834
823
  # * `display_name`
835
824
  # * `description`
836
825
  # * `gcs_fileset_spec`
837
826
  # * `gcs_fileset_spec.file_patterns`
838
- # * For entries with `user_specified_type`
827
+ # * For entries with `user_specified_type`:
839
828
  # * `schema`
840
829
  # * `display_name`
841
830
  # * `description`
842
- # * user_specified_type
843
- # * user_specified_system
844
- # * linked_resource
845
- # * source_system_timestamps
831
+ # * `user_specified_type`
832
+ # * `user_specified_system`
833
+ # * `linked_resource`
834
+ # * `source_system_timestamps`
846
835
  #
847
836
  # @yield [response, operation] Access the result along with the RPC operation
848
837
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -1046,7 +1035,7 @@ module Google
1046
1035
  # @param options [::Gapic::CallOptions, ::Hash]
1047
1036
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1048
1037
  #
1049
- # @overload lookup_entry(linked_resource: nil, sql_resource: nil)
1038
+ # @overload lookup_entry(linked_resource: nil, sql_resource: nil, fully_qualified_name: nil)
1050
1039
  # Pass arguments to `lookup_entry` via keyword arguments. Note that at
1051
1040
  # least one keyword argument is required. To specify no parameters, or to keep all
1052
1041
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1072,8 +1061,24 @@ module Google
1072
1061
  # * `bigquery.dataset.project_id.dataset_id`
1073
1062
  # * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id`
1074
1063
  #
1075
- # `*_id`s shoud satisfy the standard SQL rules for identifiers.
1064
+ # `*_id`s should satisfy the standard SQL rules for identifiers.
1076
1065
  # https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
1066
+ # @param fully_qualified_name [::String]
1067
+ # Fully qualified name (FQN) of the resource.
1068
+ #
1069
+ # FQNs take two forms:
1070
+ #
1071
+ # * For non-regionalized resources:
1072
+ #
1073
+ # `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
1074
+ #
1075
+ # * For regionalized resources:
1076
+ #
1077
+ # `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
1078
+ #
1079
+ # Example for a DPMS table:
1080
+ #
1081
+ # `dataproc_metastore:project_id.location_id.instance_id.database_id.table_id`
1077
1082
  #
1078
1083
  # @yield [response, operation] Access the result along with the RPC operation
1079
1084
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Entry]
@@ -1225,7 +1230,11 @@ module Google
1225
1230
  #
1226
1231
  # * projects/\\{project_id}/locations/us-central1
1227
1232
  # @param tag_template_id [::String]
1228
- # Required. The id of the tag template to create.
1233
+ # Required. The ID of the tag template to create.
1234
+ #
1235
+ # The ID must contain only lowercase letters (a-z), numbers (0-9),
1236
+ # or underscores (_), and must start with a letter or underscore.
1237
+ # The maximum size is 64 bytes when encoded in UTF-8.
1229
1238
  # @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
1230
1239
  # Required. The tag template to create.
1231
1240
  #
@@ -1369,13 +1378,12 @@ module Google
1369
1378
  # @param tag_template [::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash]
1370
1379
  # Required. The template to update. The "name" field must be set.
1371
1380
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1372
- # The field mask specifies the parts of the template to overwrite.
1373
- #
1374
- # Allowed fields:
1375
- #
1376
- # * `display_name`
1381
+ # Names of fields whose values to overwrite on a tag template. Currently,
1382
+ # only `display_name` can be overwritten.
1377
1383
  #
1378
- # If absent or empty, all of the allowed fields above will be updated.
1384
+ # In general, if this parameter is absent or empty, all modifiable fields
1385
+ # are overwritten. If such fields are non-required and omitted in the
1386
+ # request body, their values are emptied.
1379
1387
  #
1380
1388
  # @yield [response, operation] Access the result along with the RPC operation
1381
1389
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplate]
@@ -1529,7 +1537,10 @@ module Google
1529
1537
  # * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
1530
1538
  # @param tag_template_field_id [::String]
1531
1539
  # Required. The ID of the tag template field to create.
1532
- # Field ids can contain letters (both uppercase and lowercase), numbers
1540
+ #
1541
+ # Note: Adding a required field to an existing template is *not* allowed.
1542
+ #
1543
+ # Field IDs can contain letters (both uppercase and lowercase), numbers
1533
1544
  # (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
1534
1545
  # character long and at most 128 characters long. Field IDs must also be
1535
1546
  # unique within their template.
@@ -1610,20 +1621,22 @@ module Google
1610
1621
  # @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
1611
1622
  # Required. The template to update.
1612
1623
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1613
- # Optional. The field mask specifies the parts of the template to be updated.
1614
- # Allowed fields:
1624
+ # Optional. Names of fields whose values to overwrite on an individual field of a tag
1625
+ # template. The following fields are modifiable:
1615
1626
  #
1616
1627
  # * `display_name`
1617
1628
  # * `type.enum_type`
1618
1629
  # * `is_required`
1619
1630
  #
1620
- # If `update_mask` is not set or empty, all of the allowed fields above will
1621
- # be updated.
1631
+ # If this parameter is absent or empty, all modifiable fields
1632
+ # are overwritten. If such fields are non-required and omitted in the request
1633
+ # body, their values are emptied with one exception: when updating an enum
1634
+ # type, the provided values are merged with the existing values. Therefore,
1635
+ # enum values can only be added, existing enum values cannot be deleted or
1636
+ # renamed.
1622
1637
  #
1623
- # When updating an enum type, the provided values will be merged with the
1624
- # existing values. Therefore, enum values can only be added, existing enum
1625
- # values cannot be deleted nor renamed. Updating a template field from
1626
- # optional to required is NOT allowed.
1638
+ # Additionally, updating a template field from optional to required is
1639
+ # *not* allowed.
1627
1640
  #
1628
1641
  # @yield [response, operation] Access the result along with the RPC operation
1629
1642
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplateField]
@@ -1697,8 +1710,7 @@ module Google
1697
1710
  #
1698
1711
  # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1699
1712
  # @param new_tag_template_field_id [::String]
1700
- # Required. The new ID of this tag template field. For example,
1701
- # `my_new_field`.
1713
+ # Required. The new ID of this tag template field. For example, `my_new_field`.
1702
1714
  #
1703
1715
  # @yield [response, operation] Access the result along with the RPC operation
1704
1716
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplateField]
@@ -1745,6 +1757,77 @@ module Google
1745
1757
  raise ::Google::Cloud::Error.from_error(e)
1746
1758
  end
1747
1759
 
1760
+ ##
1761
+ # Renames an enum value in a tag template. The enum values have to be unique
1762
+ # within one enum field.
1763
+ #
1764
+ # @overload rename_tag_template_field_enum_value(request, options = nil)
1765
+ # Pass arguments to `rename_tag_template_field_enum_value` via a request object, either of type
1766
+ # {::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest} or an equivalent Hash.
1767
+ #
1768
+ # @param request [::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest, ::Hash]
1769
+ # A request object representing the call parameters. Required. To specify no
1770
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1771
+ # @param options [::Gapic::CallOptions, ::Hash]
1772
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1773
+ #
1774
+ # @overload rename_tag_template_field_enum_value(name: nil, new_enum_value_display_name: nil)
1775
+ # Pass arguments to `rename_tag_template_field_enum_value` via keyword arguments. Note that at
1776
+ # least one keyword argument is required. To specify no parameters, or to keep all
1777
+ # the default parameter values, pass an empty Hash as a request object (see above).
1778
+ #
1779
+ # @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}
1783
+ # @param new_enum_value_display_name [::String]
1784
+ # Required. The new display name of the enum value. For example, `my_new_enum_value`.
1785
+ #
1786
+ # @yield [response, operation] Access the result along with the RPC operation
1787
+ # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplateField]
1788
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1789
+ #
1790
+ # @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
1791
+ #
1792
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1793
+ #
1794
+ def rename_tag_template_field_enum_value request, options = nil
1795
+ raise ::ArgumentError, "request must be provided" if request.nil?
1796
+
1797
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest
1798
+
1799
+ # Converts hash and nil to an options object
1800
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1801
+
1802
+ # Customize the options with defaults
1803
+ metadata = @config.rpcs.rename_tag_template_field_enum_value.metadata.to_h
1804
+
1805
+ # Set x-goog-api-client and x-goog-user-project headers
1806
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1807
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1808
+ gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1809
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1810
+
1811
+ header_params = {
1812
+ "name" => request.name
1813
+ }
1814
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1815
+ metadata[:"x-goog-request-params"] ||= request_params_header
1816
+
1817
+ options.apply_defaults timeout: @config.rpcs.rename_tag_template_field_enum_value.timeout,
1818
+ metadata: metadata,
1819
+ retry_policy: @config.rpcs.rename_tag_template_field_enum_value.retry_policy
1820
+ options.apply_defaults metadata: @config.metadata,
1821
+ retry_policy: @config.retry_policy
1822
+
1823
+ @data_catalog_stub.call_rpc :rename_tag_template_field_enum_value, request, options: options do |response, operation|
1824
+ yield response, operation if block_given?
1825
+ return response
1826
+ end
1827
+ rescue ::GRPC::BadStatus => e
1828
+ raise ::Google::Cloud::Error.from_error(e)
1829
+ end
1830
+
1748
1831
  ##
1749
1832
  # Deletes a field in a tag template and all uses of that field.
1750
1833
  # Users should enable the Data Catalog API in the project identified by
@@ -1846,13 +1929,13 @@ module Google
1846
1929
  # the default parameter values, pass an empty Hash as a request object (see above).
1847
1930
  #
1848
1931
  # @param parent [::String]
1849
- # Required. The name of the resource to attach this tag to. Tags can be
1850
- # attached to Entries. Example:
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:
1851
1934
  #
1852
- # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
1935
+ # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}`
1853
1936
  #
1854
- # Note that this Tag and its child resources may not actually be stored in
1855
- # the location in this name.
1937
+ # Note: The tag and its child resources might not be stored in
1938
+ # the location specified in its name.
1856
1939
  # @param tag [::Google::Cloud::DataCatalog::V1::Tag, ::Hash]
1857
1940
  # Required. The tag to create.
1858
1941
  #
@@ -1922,8 +2005,12 @@ module Google
1922
2005
  # @param tag [::Google::Cloud::DataCatalog::V1::Tag, ::Hash]
1923
2006
  # Required. The updated tag. The "name" field must be set.
1924
2007
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1925
- # The fields to update on the Tag. If absent or empty, all modifiable fields
1926
- # are updated. Currently the only modifiable field is the field `fields`.
2008
+ # Names of fields whose values to overwrite on a tag. Currently, a tag has
2009
+ # the only modifiable field with the name `fields`.
2010
+ #
2011
+ # In general, if this parameter is absent or empty, all modifiable fields
2012
+ # are overwritten. If such fields are non-required and omitted in the
2013
+ # request body, their values are emptied.
1927
2014
  #
1928
2015
  # @yield [response, operation] Access the result along with the RPC operation
1929
2016
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::Tag]
@@ -2057,8 +2144,8 @@ module Google
2057
2144
  # the default parameter values, pass an empty Hash as a request object (see above).
2058
2145
  #
2059
2146
  # @param parent [::String]
2060
- # Required. The name of the Data Catalog resource to list the tags of. The
2061
- # resource could be an {::Google::Cloud::DataCatalog::V1::Entry Entry} or an
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
2062
2149
  # {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
2063
2150
  #
2064
2151
  # Examples:
@@ -2463,7 +2550,7 @@ module Google
2463
2550
  config_attr :scope, nil, ::String, ::Array, nil
2464
2551
  config_attr :lib_name, nil, ::String, nil
2465
2552
  config_attr :lib_version, nil, ::String, nil
2466
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
2553
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
2467
2554
  config_attr :interceptors, nil, ::Array, nil
2468
2555
  config_attr :timeout, nil, ::Numeric, nil
2469
2556
  config_attr :metadata, nil, ::Hash, nil
@@ -2484,7 +2571,7 @@ module Google
2484
2571
  def rpcs
2485
2572
  @rpcs ||= begin
2486
2573
  parent_rpcs = nil
2487
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
2574
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
2488
2575
  Rpcs.new parent_rpcs
2489
2576
  end
2490
2577
  end
@@ -2603,6 +2690,11 @@ module Google
2603
2690
  #
2604
2691
  attr_reader :rename_tag_template_field
2605
2692
  ##
2693
+ # RPC-specific configuration for `rename_tag_template_field_enum_value`
2694
+ # @return [::Gapic::Config::Method]
2695
+ #
2696
+ attr_reader :rename_tag_template_field_enum_value
2697
+ ##
2606
2698
  # RPC-specific configuration for `delete_tag_template_field`
2607
2699
  # @return [::Gapic::Config::Method]
2608
2700
  #
@@ -2645,59 +2737,61 @@ module Google
2645
2737
 
2646
2738
  # @private
2647
2739
  def initialize parent_rpcs = nil
2648
- search_catalog_config = parent_rpcs&.search_catalog if parent_rpcs&.respond_to? :search_catalog
2740
+ search_catalog_config = parent_rpcs.search_catalog if parent_rpcs.respond_to? :search_catalog
2649
2741
  @search_catalog = ::Gapic::Config::Method.new search_catalog_config
2650
- create_entry_group_config = parent_rpcs&.create_entry_group if parent_rpcs&.respond_to? :create_entry_group
2742
+ create_entry_group_config = parent_rpcs.create_entry_group if parent_rpcs.respond_to? :create_entry_group
2651
2743
  @create_entry_group = ::Gapic::Config::Method.new create_entry_group_config
2652
- get_entry_group_config = parent_rpcs&.get_entry_group if parent_rpcs&.respond_to? :get_entry_group
2744
+ get_entry_group_config = parent_rpcs.get_entry_group if parent_rpcs.respond_to? :get_entry_group
2653
2745
  @get_entry_group = ::Gapic::Config::Method.new get_entry_group_config
2654
- update_entry_group_config = parent_rpcs&.update_entry_group if parent_rpcs&.respond_to? :update_entry_group
2746
+ update_entry_group_config = parent_rpcs.update_entry_group if parent_rpcs.respond_to? :update_entry_group
2655
2747
  @update_entry_group = ::Gapic::Config::Method.new update_entry_group_config
2656
- delete_entry_group_config = parent_rpcs&.delete_entry_group if parent_rpcs&.respond_to? :delete_entry_group
2748
+ delete_entry_group_config = parent_rpcs.delete_entry_group if parent_rpcs.respond_to? :delete_entry_group
2657
2749
  @delete_entry_group = ::Gapic::Config::Method.new delete_entry_group_config
2658
- list_entry_groups_config = parent_rpcs&.list_entry_groups if parent_rpcs&.respond_to? :list_entry_groups
2750
+ list_entry_groups_config = parent_rpcs.list_entry_groups if parent_rpcs.respond_to? :list_entry_groups
2659
2751
  @list_entry_groups = ::Gapic::Config::Method.new list_entry_groups_config
2660
- create_entry_config = parent_rpcs&.create_entry if parent_rpcs&.respond_to? :create_entry
2752
+ create_entry_config = parent_rpcs.create_entry if parent_rpcs.respond_to? :create_entry
2661
2753
  @create_entry = ::Gapic::Config::Method.new create_entry_config
2662
- update_entry_config = parent_rpcs&.update_entry if parent_rpcs&.respond_to? :update_entry
2754
+ update_entry_config = parent_rpcs.update_entry if parent_rpcs.respond_to? :update_entry
2663
2755
  @update_entry = ::Gapic::Config::Method.new update_entry_config
2664
- delete_entry_config = parent_rpcs&.delete_entry if parent_rpcs&.respond_to? :delete_entry
2756
+ delete_entry_config = parent_rpcs.delete_entry if parent_rpcs.respond_to? :delete_entry
2665
2757
  @delete_entry = ::Gapic::Config::Method.new delete_entry_config
2666
- get_entry_config = parent_rpcs&.get_entry if parent_rpcs&.respond_to? :get_entry
2758
+ get_entry_config = parent_rpcs.get_entry if parent_rpcs.respond_to? :get_entry
2667
2759
  @get_entry = ::Gapic::Config::Method.new get_entry_config
2668
- lookup_entry_config = parent_rpcs&.lookup_entry if parent_rpcs&.respond_to? :lookup_entry
2760
+ lookup_entry_config = parent_rpcs.lookup_entry if parent_rpcs.respond_to? :lookup_entry
2669
2761
  @lookup_entry = ::Gapic::Config::Method.new lookup_entry_config
2670
- list_entries_config = parent_rpcs&.list_entries if parent_rpcs&.respond_to? :list_entries
2762
+ list_entries_config = parent_rpcs.list_entries if parent_rpcs.respond_to? :list_entries
2671
2763
  @list_entries = ::Gapic::Config::Method.new list_entries_config
2672
- create_tag_template_config = parent_rpcs&.create_tag_template if parent_rpcs&.respond_to? :create_tag_template
2764
+ create_tag_template_config = parent_rpcs.create_tag_template if parent_rpcs.respond_to? :create_tag_template
2673
2765
  @create_tag_template = ::Gapic::Config::Method.new create_tag_template_config
2674
- get_tag_template_config = parent_rpcs&.get_tag_template if parent_rpcs&.respond_to? :get_tag_template
2766
+ get_tag_template_config = parent_rpcs.get_tag_template if parent_rpcs.respond_to? :get_tag_template
2675
2767
  @get_tag_template = ::Gapic::Config::Method.new get_tag_template_config
2676
- update_tag_template_config = parent_rpcs&.update_tag_template if parent_rpcs&.respond_to? :update_tag_template
2768
+ update_tag_template_config = parent_rpcs.update_tag_template if parent_rpcs.respond_to? :update_tag_template
2677
2769
  @update_tag_template = ::Gapic::Config::Method.new update_tag_template_config
2678
- delete_tag_template_config = parent_rpcs&.delete_tag_template if parent_rpcs&.respond_to? :delete_tag_template
2770
+ delete_tag_template_config = parent_rpcs.delete_tag_template if parent_rpcs.respond_to? :delete_tag_template
2679
2771
  @delete_tag_template = ::Gapic::Config::Method.new delete_tag_template_config
2680
- create_tag_template_field_config = parent_rpcs&.create_tag_template_field if parent_rpcs&.respond_to? :create_tag_template_field
2772
+ create_tag_template_field_config = parent_rpcs.create_tag_template_field if parent_rpcs.respond_to? :create_tag_template_field
2681
2773
  @create_tag_template_field = ::Gapic::Config::Method.new create_tag_template_field_config
2682
- update_tag_template_field_config = parent_rpcs&.update_tag_template_field if parent_rpcs&.respond_to? :update_tag_template_field
2774
+ update_tag_template_field_config = parent_rpcs.update_tag_template_field if parent_rpcs.respond_to? :update_tag_template_field
2683
2775
  @update_tag_template_field = ::Gapic::Config::Method.new update_tag_template_field_config
2684
- rename_tag_template_field_config = parent_rpcs&.rename_tag_template_field if parent_rpcs&.respond_to? :rename_tag_template_field
2776
+ rename_tag_template_field_config = parent_rpcs.rename_tag_template_field if parent_rpcs.respond_to? :rename_tag_template_field
2685
2777
  @rename_tag_template_field = ::Gapic::Config::Method.new rename_tag_template_field_config
2686
- delete_tag_template_field_config = parent_rpcs&.delete_tag_template_field if parent_rpcs&.respond_to? :delete_tag_template_field
2778
+ rename_tag_template_field_enum_value_config = parent_rpcs.rename_tag_template_field_enum_value if parent_rpcs.respond_to? :rename_tag_template_field_enum_value
2779
+ @rename_tag_template_field_enum_value = ::Gapic::Config::Method.new rename_tag_template_field_enum_value_config
2780
+ delete_tag_template_field_config = parent_rpcs.delete_tag_template_field if parent_rpcs.respond_to? :delete_tag_template_field
2687
2781
  @delete_tag_template_field = ::Gapic::Config::Method.new delete_tag_template_field_config
2688
- create_tag_config = parent_rpcs&.create_tag if parent_rpcs&.respond_to? :create_tag
2782
+ create_tag_config = parent_rpcs.create_tag if parent_rpcs.respond_to? :create_tag
2689
2783
  @create_tag = ::Gapic::Config::Method.new create_tag_config
2690
- update_tag_config = parent_rpcs&.update_tag if parent_rpcs&.respond_to? :update_tag
2784
+ update_tag_config = parent_rpcs.update_tag if parent_rpcs.respond_to? :update_tag
2691
2785
  @update_tag = ::Gapic::Config::Method.new update_tag_config
2692
- delete_tag_config = parent_rpcs&.delete_tag if parent_rpcs&.respond_to? :delete_tag
2786
+ delete_tag_config = parent_rpcs.delete_tag if parent_rpcs.respond_to? :delete_tag
2693
2787
  @delete_tag = ::Gapic::Config::Method.new delete_tag_config
2694
- list_tags_config = parent_rpcs&.list_tags if parent_rpcs&.respond_to? :list_tags
2788
+ list_tags_config = parent_rpcs.list_tags if parent_rpcs.respond_to? :list_tags
2695
2789
  @list_tags = ::Gapic::Config::Method.new list_tags_config
2696
- set_iam_policy_config = parent_rpcs&.set_iam_policy if parent_rpcs&.respond_to? :set_iam_policy
2790
+ set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
2697
2791
  @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
2698
- get_iam_policy_config = parent_rpcs&.get_iam_policy if parent_rpcs&.respond_to? :get_iam_policy
2792
+ get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
2699
2793
  @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
2700
- test_iam_permissions_config = parent_rpcs&.test_iam_permissions if parent_rpcs&.respond_to? :test_iam_permissions
2794
+ test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
2701
2795
  @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
2702
2796
 
2703
2797
  yield self if block_given?