google-apis-dataplex_v1 0.73.0 → 0.74.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.
@@ -51,6 +51,106 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Create an EncryptionConfig.
55
+ # @param [String] parent
56
+ # Required. The location at which the EncryptionConfig is to be created.
57
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig] google_cloud_dataplex_v1_encryption_config_object
58
+ # @param [String] encryption_config_id
59
+ # Required. The ID of the EncryptionConfig to create. Currently, only a value of
60
+ # "default" is supported.
61
+ # @param [String] fields
62
+ # Selector specifying which fields to include in a partial response.
63
+ # @param [String] quota_user
64
+ # Available to use for quota purposes for server-side applications. Can be any
65
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
66
+ # @param [Google::Apis::RequestOptions] options
67
+ # Request-specific options
68
+ #
69
+ # @yield [result, err] Result & error if block supplied
70
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
71
+ # @yieldparam err [StandardError] error object if request failed
72
+ #
73
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
74
+ #
75
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
76
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
77
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
78
+ def create_organization_location_encryption_config(parent, google_cloud_dataplex_v1_encryption_config_object = nil, encryption_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
79
+ command = make_simple_command(:post, 'v1/{+parent}/encryptionConfigs', options)
80
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig::Representation
81
+ command.request_object = google_cloud_dataplex_v1_encryption_config_object
82
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
83
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
84
+ command.params['parent'] = parent unless parent.nil?
85
+ command.query['encryptionConfigId'] = encryption_config_id unless encryption_config_id.nil?
86
+ command.query['fields'] = fields unless fields.nil?
87
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
88
+ execute_or_queue_command(command, &block)
89
+ end
90
+
91
+ # Delete an EncryptionConfig.
92
+ # @param [String] name
93
+ # Required. The name of the EncryptionConfig to delete.
94
+ # @param [String] etag
95
+ # Optional. Etag of the EncryptionConfig. This is a strong etag.
96
+ # @param [String] fields
97
+ # Selector specifying which fields to include in a partial response.
98
+ # @param [String] quota_user
99
+ # Available to use for quota purposes for server-side applications. Can be any
100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
101
+ # @param [Google::Apis::RequestOptions] options
102
+ # Request-specific options
103
+ #
104
+ # @yield [result, err] Result & error if block supplied
105
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
109
+ #
110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
113
+ def delete_organization_location_encryption_config(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
114
+ command = make_simple_command(:delete, 'v1/{+name}', options)
115
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
116
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
117
+ command.params['name'] = name unless name.nil?
118
+ command.query['etag'] = etag unless etag.nil?
119
+ command.query['fields'] = fields unless fields.nil?
120
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
121
+ execute_or_queue_command(command, &block)
122
+ end
123
+
124
+ # Get an EncryptionConfig.
125
+ # @param [String] name
126
+ # Required. The name of the EncryptionConfig to fetch.
127
+ # @param [String] fields
128
+ # Selector specifying which fields to include in a partial response.
129
+ # @param [String] quota_user
130
+ # Available to use for quota purposes for server-side applications. Can be any
131
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
132
+ # @param [Google::Apis::RequestOptions] options
133
+ # Request-specific options
134
+ #
135
+ # @yield [result, err] Result & error if block supplied
136
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig] parsed result object
137
+ # @yieldparam err [StandardError] error object if request failed
138
+ #
139
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig]
140
+ #
141
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
142
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
143
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
144
+ def get_organization_location_encryption_config(name, fields: nil, quota_user: nil, options: nil, &block)
145
+ command = make_simple_command(:get, 'v1/{+name}', options)
146
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig::Representation
147
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig
148
+ command.params['name'] = name unless name.nil?
149
+ command.query['fields'] = fields unless fields.nil?
150
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
151
+ execute_or_queue_command(command, &block)
152
+ end
153
+
54
154
  # Gets the access control policy for a resource. Returns an empty policy if the
55
155
  # resource exists and does not have a policy set.
56
156
  # @param [String] resource
@@ -96,6 +196,102 @@ module Google
96
196
  execute_or_queue_command(command, &block)
97
197
  end
98
198
 
199
+ # List EncryptionConfigs.
200
+ # @param [String] parent
201
+ # Required. The location for which the EncryptionConfig is to be listed.
202
+ # @param [String] filter
203
+ # Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (
204
+ # These values will be matched anywhere it may appear in the object's field
205
+ # values) * filter=some_value Using fields: (These values will be matched only
206
+ # in the specified field) * filter=some_field=some_value Supported fields: *
207
+ # name, key, create_time, update_time, encryption_state Example: * filter=name=
208
+ # organizations/123/locations/us-central1/encryptionConfigs/test-config
209
+ # conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-
210
+ # central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <,
211
+ # >=, <=, !=, =, :), * filter=create_time>2024-05-01T00:00:00.000Z
212
+ # @param [String] order_by
213
+ # Optional. Order by fields for the result.
214
+ # @param [Fixnum] page_size
215
+ # Optional. Maximum number of EncryptionConfigs to return. The service may
216
+ # return fewer than this value. If unspecified, at most 10 EncryptionConfigs
217
+ # will be returned. The maximum value is 1000; values above 1000 will be coerced
218
+ # to 1000.
219
+ # @param [String] page_token
220
+ # Optional. Page token received from a previous ListEncryptionConfigs call.
221
+ # Provide this to retrieve the subsequent page. When paginating, the parameters -
222
+ # filter and order_by provided to ListEncryptionConfigs must match the call
223
+ # that provided the page token.
224
+ # @param [String] fields
225
+ # Selector specifying which fields to include in a partial response.
226
+ # @param [String] quota_user
227
+ # Available to use for quota purposes for server-side applications. Can be any
228
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
229
+ # @param [Google::Apis::RequestOptions] options
230
+ # Request-specific options
231
+ #
232
+ # @yield [result, err] Result & error if block supplied
233
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEncryptionConfigsResponse] parsed result object
234
+ # @yieldparam err [StandardError] error object if request failed
235
+ #
236
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEncryptionConfigsResponse]
237
+ #
238
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
239
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
240
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
241
+ def list_organization_location_encryption_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
242
+ command = make_simple_command(:get, 'v1/{+parent}/encryptionConfigs', options)
243
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEncryptionConfigsResponse::Representation
244
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEncryptionConfigsResponse
245
+ command.params['parent'] = parent unless parent.nil?
246
+ command.query['filter'] = filter unless filter.nil?
247
+ command.query['orderBy'] = order_by unless order_by.nil?
248
+ command.query['pageSize'] = page_size unless page_size.nil?
249
+ command.query['pageToken'] = page_token unless page_token.nil?
250
+ command.query['fields'] = fields unless fields.nil?
251
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
252
+ execute_or_queue_command(command, &block)
253
+ end
254
+
255
+ # Update an EncryptionConfig.
256
+ # @param [String] name
257
+ # Identifier. The resource name of the EncryptionConfig. Format: organizations/`
258
+ # organization`/locations/`location`/encryptionConfigs/`encryption_config`
259
+ # Global location is not supported.
260
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig] google_cloud_dataplex_v1_encryption_config_object
261
+ # @param [String] update_mask
262
+ # Optional. Mask of fields to update. The service treats an omitted field mask
263
+ # as an implied field mask equivalent to all fields that are populated (have a
264
+ # non-empty value).
265
+ # @param [String] fields
266
+ # Selector specifying which fields to include in a partial response.
267
+ # @param [String] quota_user
268
+ # Available to use for quota purposes for server-side applications. Can be any
269
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
270
+ # @param [Google::Apis::RequestOptions] options
271
+ # Request-specific options
272
+ #
273
+ # @yield [result, err] Result & error if block supplied
274
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
275
+ # @yieldparam err [StandardError] error object if request failed
276
+ #
277
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
278
+ #
279
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
280
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
281
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
282
+ def patch_organization_location_encryption_config(name, google_cloud_dataplex_v1_encryption_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
283
+ command = make_simple_command(:patch, 'v1/{+name}', options)
284
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig::Representation
285
+ command.request_object = google_cloud_dataplex_v1_encryption_config_object
286
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
287
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
288
+ command.params['name'] = name unless name.nil?
289
+ command.query['updateMask'] = update_mask unless update_mask.nil?
290
+ command.query['fields'] = fields unless fields.nil?
291
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
292
+ execute_or_queue_command(command, &block)
293
+ end
294
+
99
295
  # Sets the access control policy on the specified resource. Replaces any
100
296
  # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
101
297
  # errors.
@@ -461,6 +657,8 @@ module Google
461
657
  # Optional. The scope under which the search should be operating. It must either
462
658
  # be organizations/ or projects/. If it is unspecified, it defaults to the
463
659
  # organization where the project provided in name is located.
660
+ # @param [Boolean] semantic_search
661
+ # Optional. Internal only.
464
662
  # @param [String] fields
465
663
  # Selector specifying which fields to include in a partial response.
466
664
  # @param [String] quota_user
@@ -478,7 +676,7 @@ module Google
478
676
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
479
677
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
480
678
  # @raise [Google::Apis::AuthorizationError] Authorization is required
481
- def search_project_location_entries(name, order_by: nil, page_size: nil, page_token: nil, query: nil, scope: nil, fields: nil, quota_user: nil, options: nil, &block)
679
+ def search_project_location_entries(name, order_by: nil, page_size: nil, page_token: nil, query: nil, scope: nil, semantic_search: nil, fields: nil, quota_user: nil, options: nil, &block)
482
680
  command = make_simple_command(:post, 'v1/{+name}:searchEntries', options)
483
681
  command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1SearchEntriesResponse::Representation
484
682
  command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1SearchEntriesResponse
@@ -488,6 +686,7 @@ module Google
488
686
  command.query['pageToken'] = page_token unless page_token.nil?
489
687
  command.query['query'] = query unless query.nil?
490
688
  command.query['scope'] = scope unless scope.nil?
689
+ command.query['semanticSearch'] = semantic_search unless semantic_search.nil?
491
690
  command.query['fields'] = fields unless fields.nil?
492
691
  command.query['quotaUser'] = quota_user unless quota_user.nil?
493
692
  execute_or_queue_command(command, &block)
@@ -2869,6 +3068,107 @@ module Google
2869
3068
  execute_or_queue_command(command, &block)
2870
3069
  end
2871
3070
 
3071
+ # Creates an Entry Link.
3072
+ # @param [String] parent
3073
+ # Required. The resource name of the parent Entry Group: projects/`project`/
3074
+ # locations/`location`/entryGroups/`entry_group`.
3075
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink] google_cloud_dataplex_v1_entry_link_object
3076
+ # @param [String] entry_link_id
3077
+ # Required. Entry Link identifier * Must contain only lowercase letters, numbers
3078
+ # and hyphens. * Must start with a letter. * Must be between 1-63 characters. *
3079
+ # Must end with a number or a letter. * Must be unique within the EntryGroup.
3080
+ # @param [String] fields
3081
+ # Selector specifying which fields to include in a partial response.
3082
+ # @param [String] quota_user
3083
+ # Available to use for quota purposes for server-side applications. Can be any
3084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3085
+ # @param [Google::Apis::RequestOptions] options
3086
+ # Request-specific options
3087
+ #
3088
+ # @yield [result, err] Result & error if block supplied
3089
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink] parsed result object
3090
+ # @yieldparam err [StandardError] error object if request failed
3091
+ #
3092
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink]
3093
+ #
3094
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3095
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3096
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3097
+ def create_project_location_entry_group_entry_link(parent, google_cloud_dataplex_v1_entry_link_object = nil, entry_link_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3098
+ command = make_simple_command(:post, 'v1/{+parent}/entryLinks', options)
3099
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink::Representation
3100
+ command.request_object = google_cloud_dataplex_v1_entry_link_object
3101
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink::Representation
3102
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink
3103
+ command.params['parent'] = parent unless parent.nil?
3104
+ command.query['entryLinkId'] = entry_link_id unless entry_link_id.nil?
3105
+ command.query['fields'] = fields unless fields.nil?
3106
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3107
+ execute_or_queue_command(command, &block)
3108
+ end
3109
+
3110
+ # Deletes an Entry Link.
3111
+ # @param [String] name
3112
+ # Required. The resource name of the Entry Link: projects/`project`/locations/`
3113
+ # location`/entryGroups/`entry_group`/entryLinks/`entry_link`.
3114
+ # @param [String] fields
3115
+ # Selector specifying which fields to include in a partial response.
3116
+ # @param [String] quota_user
3117
+ # Available to use for quota purposes for server-side applications. Can be any
3118
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3119
+ # @param [Google::Apis::RequestOptions] options
3120
+ # Request-specific options
3121
+ #
3122
+ # @yield [result, err] Result & error if block supplied
3123
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink] parsed result object
3124
+ # @yieldparam err [StandardError] error object if request failed
3125
+ #
3126
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink]
3127
+ #
3128
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3129
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3130
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3131
+ def delete_project_location_entry_group_entry_link(name, fields: nil, quota_user: nil, options: nil, &block)
3132
+ command = make_simple_command(:delete, 'v1/{+name}', options)
3133
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink::Representation
3134
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink
3135
+ command.params['name'] = name unless name.nil?
3136
+ command.query['fields'] = fields unless fields.nil?
3137
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3138
+ execute_or_queue_command(command, &block)
3139
+ end
3140
+
3141
+ # Gets an entry link.
3142
+ # @param [String] name
3143
+ # Required. The resource name of the Entry Link: projects/`project`/locations/`
3144
+ # location`/entryGroups/`entry_group`/entryLinks/`entry_link`.
3145
+ # @param [String] fields
3146
+ # Selector specifying which fields to include in a partial response.
3147
+ # @param [String] quota_user
3148
+ # Available to use for quota purposes for server-side applications. Can be any
3149
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3150
+ # @param [Google::Apis::RequestOptions] options
3151
+ # Request-specific options
3152
+ #
3153
+ # @yield [result, err] Result & error if block supplied
3154
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink] parsed result object
3155
+ # @yieldparam err [StandardError] error object if request failed
3156
+ #
3157
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink]
3158
+ #
3159
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3160
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3161
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3162
+ def get_project_location_entry_group_entry_link(name, fields: nil, quota_user: nil, options: nil, &block)
3163
+ command = make_simple_command(:get, 'v1/{+name}', options)
3164
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink::Representation
3165
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLink
3166
+ command.params['name'] = name unless name.nil?
3167
+ command.query['fields'] = fields unless fields.nil?
3168
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3169
+ execute_or_queue_command(command, &block)
3170
+ end
3171
+
2872
3172
  # Gets the access control policy for a resource. Returns an empty policy if the
2873
3173
  # resource exists and does not have a policy set.
2874
3174
  # @param [String] resource
@@ -3312,23 +3612,17 @@ module Google
3312
3612
  execute_or_queue_command(command, &block)
3313
3613
  end
3314
3614
 
3315
- # Gets the access control policy for a resource. Returns an empty policy if the
3316
- # resource exists and does not have a policy set.
3317
- # @param [String] resource
3318
- # REQUIRED: The resource for which the policy is being requested. See Resource
3319
- # names (https://cloud.google.com/apis/design/resource_names) for the
3320
- # appropriate value for this field.
3321
- # @param [Fixnum] options_requested_policy_version
3322
- # Optional. The maximum policy version that will be used to format the policy.
3323
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
3324
- # rejected.Requests for policies with any conditional role bindings must specify
3325
- # version 3. Policies with no conditional role bindings may specify any valid
3326
- # value or leave the field unset.The policy in the response might use the policy
3327
- # version that you specified, or it might use a lower policy version. For
3328
- # example, if you specify version 3, but the policy has no conditional role
3329
- # bindings, the response uses version 1.To learn which resources support
3330
- # conditions in their IAM policies, see the IAM documentation (https://cloud.
3331
- # google.com/iam/help/conditions/resource-policies).
3615
+ # Creates a new Glossary resource.
3616
+ # @param [String] parent
3617
+ # Required. The parent resource where this Glossary will be created. Format:
3618
+ # projects/`projectId`/locations/`locationId` where locationId refers to a GCP
3619
+ # region.
3620
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary] google_cloud_dataplex_v1_glossary_object
3621
+ # @param [String] glossary_id
3622
+ # Required. Glossary ID: Glossary identifier.
3623
+ # @param [Boolean] validate_only
3624
+ # Optional. Validates the request without actually creating the glossary.
3625
+ # Default: false.
3332
3626
  # @param [String] fields
3333
3627
  # Selector specifying which fields to include in a partial response.
3334
3628
  # @param [String] quota_user
@@ -3338,33 +3632,37 @@ module Google
3338
3632
  # Request-specific options
3339
3633
  #
3340
3634
  # @yield [result, err] Result & error if block supplied
3341
- # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
3635
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
3342
3636
  # @yieldparam err [StandardError] error object if request failed
3343
3637
  #
3344
- # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
3638
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
3345
3639
  #
3346
3640
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3347
3641
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3348
3642
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3349
- def get_project_location_glossary_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
3350
- command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
3351
- command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
3352
- command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
3353
- command.params['resource'] = resource unless resource.nil?
3354
- command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
3643
+ def create_project_location_glossary(parent, google_cloud_dataplex_v1_glossary_object = nil, glossary_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
3644
+ command = make_simple_command(:post, 'v1/{+parent}/glossaries', options)
3645
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary::Representation
3646
+ command.request_object = google_cloud_dataplex_v1_glossary_object
3647
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
3648
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
3649
+ command.params['parent'] = parent unless parent.nil?
3650
+ command.query['glossaryId'] = glossary_id unless glossary_id.nil?
3651
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
3355
3652
  command.query['fields'] = fields unless fields.nil?
3356
3653
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3357
3654
  execute_or_queue_command(command, &block)
3358
3655
  end
3359
3656
 
3360
- # Sets the access control policy on the specified resource. Replaces any
3361
- # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
3362
- # errors.
3363
- # @param [String] resource
3364
- # REQUIRED: The resource for which the policy is being specified. See Resource
3365
- # names (https://cloud.google.com/apis/design/resource_names) for the
3366
- # appropriate value for this field.
3367
- # @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
3657
+ # Deletes a Glossary resource. All the categories and terms within the glossary
3658
+ # must be deleted before a glossary can be deleted.
3659
+ # @param [String] name
3660
+ # Required. The name of the Glossary to delete. Format: projects/`project`/
3661
+ # locations/`location`/glossary/`glossary`
3662
+ # @param [String] etag
3663
+ # Optional. The etag of the Glossary. If this is provided, it must match the
3664
+ # server's etag. If the etag is provided and does not match the server-computed
3665
+ # etag, the request must fail with a ABORTED error code.
3368
3666
  # @param [String] fields
3369
3667
  # Selector specifying which fields to include in a partial response.
3370
3668
  # @param [String] quota_user
@@ -3374,7 +3672,210 @@ module Google
3374
3672
  # Request-specific options
3375
3673
  #
3376
3674
  # @yield [result, err] Result & error if block supplied
3377
- # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
3675
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
3676
+ # @yieldparam err [StandardError] error object if request failed
3677
+ #
3678
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
3679
+ #
3680
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3681
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3682
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3683
+ def delete_project_location_glossary(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
3684
+ command = make_simple_command(:delete, 'v1/{+name}', options)
3685
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
3686
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
3687
+ command.params['name'] = name unless name.nil?
3688
+ command.query['etag'] = etag unless etag.nil?
3689
+ command.query['fields'] = fields unless fields.nil?
3690
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3691
+ execute_or_queue_command(command, &block)
3692
+ end
3693
+
3694
+ # Retrieves a specified Glossary resource.
3695
+ # @param [String] name
3696
+ # Required. The name of the Glossary to retrieve. Format: projects/`project`/
3697
+ # locations/`location`/glossaries/`glossary`
3698
+ # @param [String] fields
3699
+ # Selector specifying which fields to include in a partial response.
3700
+ # @param [String] quota_user
3701
+ # Available to use for quota purposes for server-side applications. Can be any
3702
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3703
+ # @param [Google::Apis::RequestOptions] options
3704
+ # Request-specific options
3705
+ #
3706
+ # @yield [result, err] Result & error if block supplied
3707
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary] parsed result object
3708
+ # @yieldparam err [StandardError] error object if request failed
3709
+ #
3710
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary]
3711
+ #
3712
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3713
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3714
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3715
+ def get_project_location_glossary(name, fields: nil, quota_user: nil, options: nil, &block)
3716
+ command = make_simple_command(:get, 'v1/{+name}', options)
3717
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary::Representation
3718
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary
3719
+ command.params['name'] = name unless name.nil?
3720
+ command.query['fields'] = fields unless fields.nil?
3721
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3722
+ execute_or_queue_command(command, &block)
3723
+ end
3724
+
3725
+ # Gets the access control policy for a resource. Returns an empty policy if the
3726
+ # resource exists and does not have a policy set.
3727
+ # @param [String] resource
3728
+ # REQUIRED: The resource for which the policy is being requested. See Resource
3729
+ # names (https://cloud.google.com/apis/design/resource_names) for the
3730
+ # appropriate value for this field.
3731
+ # @param [Fixnum] options_requested_policy_version
3732
+ # Optional. The maximum policy version that will be used to format the policy.
3733
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
3734
+ # rejected.Requests for policies with any conditional role bindings must specify
3735
+ # version 3. Policies with no conditional role bindings may specify any valid
3736
+ # value or leave the field unset.The policy in the response might use the policy
3737
+ # version that you specified, or it might use a lower policy version. For
3738
+ # example, if you specify version 3, but the policy has no conditional role
3739
+ # bindings, the response uses version 1.To learn which resources support
3740
+ # conditions in their IAM policies, see the IAM documentation (https://cloud.
3741
+ # google.com/iam/help/conditions/resource-policies).
3742
+ # @param [String] fields
3743
+ # Selector specifying which fields to include in a partial response.
3744
+ # @param [String] quota_user
3745
+ # Available to use for quota purposes for server-side applications. Can be any
3746
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3747
+ # @param [Google::Apis::RequestOptions] options
3748
+ # Request-specific options
3749
+ #
3750
+ # @yield [result, err] Result & error if block supplied
3751
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
3752
+ # @yieldparam err [StandardError] error object if request failed
3753
+ #
3754
+ # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
3755
+ #
3756
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3757
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3758
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3759
+ def get_project_location_glossary_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
3760
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
3761
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
3762
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
3763
+ command.params['resource'] = resource unless resource.nil?
3764
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
3765
+ command.query['fields'] = fields unless fields.nil?
3766
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3767
+ execute_or_queue_command(command, &block)
3768
+ end
3769
+
3770
+ # Lists Glossary resources in a project and location.
3771
+ # @param [String] parent
3772
+ # Required. The parent, which has this collection of glossaries. Format:
3773
+ # projects/`project`/locations/`location` Location is the GCP region.
3774
+ # @param [String] filter
3775
+ # Optional. Filter expression that filters glossaries listed in the response.
3776
+ # Initially, no filter is supported.
3777
+ # @param [String] order_by
3778
+ # Optional. Order by expression that orders glossaries listed in the response.
3779
+ # Order by fields are: name or create_time for the result. If not specified, the
3780
+ # ordering is undefined.
3781
+ # @param [Fixnum] page_size
3782
+ # Optional. The maximum number of glossaries to return. The service may return
3783
+ # fewer than this value. If unspecified, at most 50 glossaries will be returned.
3784
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
3785
+ # @param [String] page_token
3786
+ # Optional. A page token, received from a previous ListGlossaries call. Provide
3787
+ # this to retrieve the subsequent page. When paginating, all other parameters
3788
+ # provided to ListGlossaries must match the call that provided the page token.
3789
+ # @param [String] fields
3790
+ # Selector specifying which fields to include in a partial response.
3791
+ # @param [String] quota_user
3792
+ # Available to use for quota purposes for server-side applications. Can be any
3793
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3794
+ # @param [Google::Apis::RequestOptions] options
3795
+ # Request-specific options
3796
+ #
3797
+ # @yield [result, err] Result & error if block supplied
3798
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossariesResponse] parsed result object
3799
+ # @yieldparam err [StandardError] error object if request failed
3800
+ #
3801
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossariesResponse]
3802
+ #
3803
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3804
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3805
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3806
+ def list_project_location_glossaries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3807
+ command = make_simple_command(:get, 'v1/{+parent}/glossaries', options)
3808
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossariesResponse::Representation
3809
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossariesResponse
3810
+ command.params['parent'] = parent unless parent.nil?
3811
+ command.query['filter'] = filter unless filter.nil?
3812
+ command.query['orderBy'] = order_by unless order_by.nil?
3813
+ command.query['pageSize'] = page_size unless page_size.nil?
3814
+ command.query['pageToken'] = page_token unless page_token.nil?
3815
+ command.query['fields'] = fields unless fields.nil?
3816
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3817
+ execute_or_queue_command(command, &block)
3818
+ end
3819
+
3820
+ # Updates a Glossary resource.
3821
+ # @param [String] name
3822
+ # Output only. Identifier. The resource name of the Glossary. Format: projects/`
3823
+ # projectId`/locations/`locationId`/glossaries/`glossaryId`
3824
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary] google_cloud_dataplex_v1_glossary_object
3825
+ # @param [String] update_mask
3826
+ # Required. The list of fields to update.
3827
+ # @param [Boolean] validate_only
3828
+ # Optional. Validates the request without actually updating the glossary.
3829
+ # Default: false.
3830
+ # @param [String] fields
3831
+ # Selector specifying which fields to include in a partial response.
3832
+ # @param [String] quota_user
3833
+ # Available to use for quota purposes for server-side applications. Can be any
3834
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3835
+ # @param [Google::Apis::RequestOptions] options
3836
+ # Request-specific options
3837
+ #
3838
+ # @yield [result, err] Result & error if block supplied
3839
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
3840
+ # @yieldparam err [StandardError] error object if request failed
3841
+ #
3842
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
3843
+ #
3844
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3845
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3846
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3847
+ def patch_project_location_glossary(name, google_cloud_dataplex_v1_glossary_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
3848
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3849
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary::Representation
3850
+ command.request_object = google_cloud_dataplex_v1_glossary_object
3851
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
3852
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
3853
+ command.params['name'] = name unless name.nil?
3854
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3855
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
3856
+ command.query['fields'] = fields unless fields.nil?
3857
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3858
+ execute_or_queue_command(command, &block)
3859
+ end
3860
+
3861
+ # Sets the access control policy on the specified resource. Replaces any
3862
+ # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
3863
+ # errors.
3864
+ # @param [String] resource
3865
+ # REQUIRED: The resource for which the policy is being specified. See Resource
3866
+ # names (https://cloud.google.com/apis/design/resource_names) for the
3867
+ # appropriate value for this field.
3868
+ # @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
3869
+ # @param [String] fields
3870
+ # Selector specifying which fields to include in a partial response.
3871
+ # @param [String] quota_user
3872
+ # Available to use for quota purposes for server-side applications. Can be any
3873
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3874
+ # @param [Google::Apis::RequestOptions] options
3875
+ # Request-specific options
3876
+ #
3877
+ # @yield [result, err] Result & error if block supplied
3878
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
3378
3879
  # @yieldparam err [StandardError] error object if request failed
3379
3880
  #
3380
3881
  # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
@@ -3433,6 +3934,111 @@ module Google
3433
3934
  execute_or_queue_command(command, &block)
3434
3935
  end
3435
3936
 
3937
+ # GlossaryCategory APIs are CCFE passthrough APIs. Creates a new
3938
+ # GlossaryCategory resource.
3939
+ # @param [String] parent
3940
+ # Required. The parent resource where this GlossaryCategory will be created.
3941
+ # Format: projects/`projectId`/locations/`locationId`/glossaries/`glossaryId`
3942
+ # where locationId refers to a GCP region.
3943
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory] google_cloud_dataplex_v1_glossary_category_object
3944
+ # @param [String] category_id
3945
+ # Required. Category ID: GlossaryCategory identifier.
3946
+ # @param [String] fields
3947
+ # Selector specifying which fields to include in a partial response.
3948
+ # @param [String] quota_user
3949
+ # Available to use for quota purposes for server-side applications. Can be any
3950
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3951
+ # @param [Google::Apis::RequestOptions] options
3952
+ # Request-specific options
3953
+ #
3954
+ # @yield [result, err] Result & error if block supplied
3955
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory] parsed result object
3956
+ # @yieldparam err [StandardError] error object if request failed
3957
+ #
3958
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory]
3959
+ #
3960
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3961
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3962
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3963
+ def create_project_location_glossary_category(parent, google_cloud_dataplex_v1_glossary_category_object = nil, category_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3964
+ command = make_simple_command(:post, 'v1/{+parent}/categories', options)
3965
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory::Representation
3966
+ command.request_object = google_cloud_dataplex_v1_glossary_category_object
3967
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory::Representation
3968
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory
3969
+ command.params['parent'] = parent unless parent.nil?
3970
+ command.query['categoryId'] = category_id unless category_id.nil?
3971
+ command.query['fields'] = fields unless fields.nil?
3972
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3973
+ execute_or_queue_command(command, &block)
3974
+ end
3975
+
3976
+ # Deletes a GlossaryCategory resource. All the categories and terms nested
3977
+ # directly under the category will be moved one level up to the parent in the
3978
+ # hierarchy.
3979
+ # @param [String] name
3980
+ # Required. The name of the GlossaryCategory to delete. Format: projects/`
3981
+ # project`/locations/`location`/glossary/`glossary`/categories/`
3982
+ # glossary_category`
3983
+ # @param [String] fields
3984
+ # Selector specifying which fields to include in a partial response.
3985
+ # @param [String] quota_user
3986
+ # Available to use for quota purposes for server-side applications. Can be any
3987
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3988
+ # @param [Google::Apis::RequestOptions] options
3989
+ # Request-specific options
3990
+ #
3991
+ # @yield [result, err] Result & error if block supplied
3992
+ # @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
3993
+ # @yieldparam err [StandardError] error object if request failed
3994
+ #
3995
+ # @return [Google::Apis::DataplexV1::Empty]
3996
+ #
3997
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3998
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3999
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4000
+ def delete_project_location_glossary_category(name, fields: nil, quota_user: nil, options: nil, &block)
4001
+ command = make_simple_command(:delete, 'v1/{+name}', options)
4002
+ command.response_representation = Google::Apis::DataplexV1::Empty::Representation
4003
+ command.response_class = Google::Apis::DataplexV1::Empty
4004
+ command.params['name'] = name unless name.nil?
4005
+ command.query['fields'] = fields unless fields.nil?
4006
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4007
+ execute_or_queue_command(command, &block)
4008
+ end
4009
+
4010
+ # Retrieves a specified GlossaryCategory resource.
4011
+ # @param [String] name
4012
+ # Required. The name of the GlossaryCategory to retrieve. Format: projects/`
4013
+ # project`/locations/`location`/glossaries/`glossary`/categories/`
4014
+ # glossary_category`
4015
+ # @param [String] fields
4016
+ # Selector specifying which fields to include in a partial response.
4017
+ # @param [String] quota_user
4018
+ # Available to use for quota purposes for server-side applications. Can be any
4019
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4020
+ # @param [Google::Apis::RequestOptions] options
4021
+ # Request-specific options
4022
+ #
4023
+ # @yield [result, err] Result & error if block supplied
4024
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory] parsed result object
4025
+ # @yieldparam err [StandardError] error object if request failed
4026
+ #
4027
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory]
4028
+ #
4029
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4030
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4031
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4032
+ def get_project_location_glossary_category(name, fields: nil, quota_user: nil, options: nil, &block)
4033
+ command = make_simple_command(:get, 'v1/{+name}', options)
4034
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory::Representation
4035
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory
4036
+ command.params['name'] = name unless name.nil?
4037
+ command.query['fields'] = fields unless fields.nil?
4038
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4039
+ execute_or_queue_command(command, &block)
4040
+ end
4041
+
3436
4042
  # Gets the access control policy for a resource. Returns an empty policy if the
3437
4043
  # resource exists and does not have a policy set.
3438
4044
  # @param [String] resource
@@ -3478,6 +4084,99 @@ module Google
3478
4084
  execute_or_queue_command(command, &block)
3479
4085
  end
3480
4086
 
4087
+ # Lists GlossaryCategory resources in a glossary.
4088
+ # @param [String] parent
4089
+ # Required. The parent, which has this collection of categories. Format:
4090
+ # projects/`project`/locations/`location`/glossaries/`glossary` Location is the
4091
+ # GCP region.
4092
+ # @param [String] filter
4093
+ # Optional. Filter expression that filters categories listed in the response.
4094
+ # Filters supported: List GlossaryCategories based on immediate parent in the
4095
+ # resource hierarchy. This will only return the GlossaryCategories nested
4096
+ # directly under the parent and no other subsequent nested categories will be
4097
+ # returned.
4098
+ # @param [String] order_by
4099
+ # Optional. Order by expression that orders categories listed in the response.
4100
+ # Order by fields are: name or create_time for the result. If not specified, the
4101
+ # ordering is undefined.
4102
+ # @param [Fixnum] page_size
4103
+ # Optional. The maximum number of categories to return. The service may return
4104
+ # fewer than this value. If unspecified, at most 50 categories will be returned.
4105
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
4106
+ # @param [String] page_token
4107
+ # Optional. A page token, received from a previous ListGlossaryCategories call.
4108
+ # Provide this to retrieve the subsequent page. When paginating, all other
4109
+ # parameters provided to ListGlossaryCategories must match the call that
4110
+ # provided the page token.
4111
+ # @param [String] fields
4112
+ # Selector specifying which fields to include in a partial response.
4113
+ # @param [String] quota_user
4114
+ # Available to use for quota purposes for server-side applications. Can be any
4115
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4116
+ # @param [Google::Apis::RequestOptions] options
4117
+ # Request-specific options
4118
+ #
4119
+ # @yield [result, err] Result & error if block supplied
4120
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryCategoriesResponse] parsed result object
4121
+ # @yieldparam err [StandardError] error object if request failed
4122
+ #
4123
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryCategoriesResponse]
4124
+ #
4125
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4126
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4127
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4128
+ def list_project_location_glossary_categories(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4129
+ command = make_simple_command(:get, 'v1/{+parent}/categories', options)
4130
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryCategoriesResponse::Representation
4131
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryCategoriesResponse
4132
+ command.params['parent'] = parent unless parent.nil?
4133
+ command.query['filter'] = filter unless filter.nil?
4134
+ command.query['orderBy'] = order_by unless order_by.nil?
4135
+ command.query['pageSize'] = page_size unless page_size.nil?
4136
+ command.query['pageToken'] = page_token unless page_token.nil?
4137
+ command.query['fields'] = fields unless fields.nil?
4138
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4139
+ execute_or_queue_command(command, &block)
4140
+ end
4141
+
4142
+ # Updates a GlossaryCategory resource.
4143
+ # @param [String] name
4144
+ # Output only. Identifier. The resource name of the GlossaryCategory. Format:
4145
+ # projects/`projectId`/locations/`locationId`/glossaries/`glossaryId`/categories/
4146
+ # `categoryId`
4147
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory] google_cloud_dataplex_v1_glossary_category_object
4148
+ # @param [String] update_mask
4149
+ # Required. The list of fields to update.
4150
+ # @param [String] fields
4151
+ # Selector specifying which fields to include in a partial response.
4152
+ # @param [String] quota_user
4153
+ # Available to use for quota purposes for server-side applications. Can be any
4154
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4155
+ # @param [Google::Apis::RequestOptions] options
4156
+ # Request-specific options
4157
+ #
4158
+ # @yield [result, err] Result & error if block supplied
4159
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory] parsed result object
4160
+ # @yieldparam err [StandardError] error object if request failed
4161
+ #
4162
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory]
4163
+ #
4164
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4165
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4166
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4167
+ def patch_project_location_glossary_category(name, google_cloud_dataplex_v1_glossary_category_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4168
+ command = make_simple_command(:patch, 'v1/{+name}', options)
4169
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory::Representation
4170
+ command.request_object = google_cloud_dataplex_v1_glossary_category_object
4171
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory::Representation
4172
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory
4173
+ command.params['name'] = name unless name.nil?
4174
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4175
+ command.query['fields'] = fields unless fields.nil?
4176
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4177
+ execute_or_queue_command(command, &block)
4178
+ end
4179
+
3481
4180
  # Sets the access control policy on the specified resource. Replaces any
3482
4181
  # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
3483
4182
  # errors.
@@ -3554,6 +4253,107 @@ module Google
3554
4253
  execute_or_queue_command(command, &block)
3555
4254
  end
3556
4255
 
4256
+ # GlossaryTerm APIs are CCFE passthrough APIs. Creates a new GlossaryTerm
4257
+ # resource.
4258
+ # @param [String] parent
4259
+ # Required. The parent resource where this GlossaryTerm will be created. Format:
4260
+ # projects/`projectId`/locations/`locationId`/glossaries/`glossaryId` where
4261
+ # locationId refers to a GCP region.
4262
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm] google_cloud_dataplex_v1_glossary_term_object
4263
+ # @param [String] term_id
4264
+ # Required. Term ID: GlossaryTerm identifier.
4265
+ # @param [String] fields
4266
+ # Selector specifying which fields to include in a partial response.
4267
+ # @param [String] quota_user
4268
+ # Available to use for quota purposes for server-side applications. Can be any
4269
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4270
+ # @param [Google::Apis::RequestOptions] options
4271
+ # Request-specific options
4272
+ #
4273
+ # @yield [result, err] Result & error if block supplied
4274
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm] parsed result object
4275
+ # @yieldparam err [StandardError] error object if request failed
4276
+ #
4277
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm]
4278
+ #
4279
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4280
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4281
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4282
+ def create_project_location_glossary_term(parent, google_cloud_dataplex_v1_glossary_term_object = nil, term_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4283
+ command = make_simple_command(:post, 'v1/{+parent}/terms', options)
4284
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm::Representation
4285
+ command.request_object = google_cloud_dataplex_v1_glossary_term_object
4286
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm::Representation
4287
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm
4288
+ command.params['parent'] = parent unless parent.nil?
4289
+ command.query['termId'] = term_id unless term_id.nil?
4290
+ command.query['fields'] = fields unless fields.nil?
4291
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4292
+ execute_or_queue_command(command, &block)
4293
+ end
4294
+
4295
+ # Deletes a GlossaryTerm resource.
4296
+ # @param [String] name
4297
+ # Required. The name of the GlossaryTerm to delete. Format: projects/`project`/
4298
+ # locations/`location`/glossary/`glossary`/terms/`glossary_term`
4299
+ # @param [String] fields
4300
+ # Selector specifying which fields to include in a partial response.
4301
+ # @param [String] quota_user
4302
+ # Available to use for quota purposes for server-side applications. Can be any
4303
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4304
+ # @param [Google::Apis::RequestOptions] options
4305
+ # Request-specific options
4306
+ #
4307
+ # @yield [result, err] Result & error if block supplied
4308
+ # @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
4309
+ # @yieldparam err [StandardError] error object if request failed
4310
+ #
4311
+ # @return [Google::Apis::DataplexV1::Empty]
4312
+ #
4313
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4314
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4315
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4316
+ def delete_project_location_glossary_term(name, fields: nil, quota_user: nil, options: nil, &block)
4317
+ command = make_simple_command(:delete, 'v1/{+name}', options)
4318
+ command.response_representation = Google::Apis::DataplexV1::Empty::Representation
4319
+ command.response_class = Google::Apis::DataplexV1::Empty
4320
+ command.params['name'] = name unless name.nil?
4321
+ command.query['fields'] = fields unless fields.nil?
4322
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4323
+ execute_or_queue_command(command, &block)
4324
+ end
4325
+
4326
+ # Retrieves a specified GlossaryTerm resource.
4327
+ # @param [String] name
4328
+ # Required. The name of the GlossaryTerm to retrieve. Format: projects/`project`/
4329
+ # locations/`location`/glossaries/`glossary`/terms/`glossary_term`
4330
+ # @param [String] fields
4331
+ # Selector specifying which fields to include in a partial response.
4332
+ # @param [String] quota_user
4333
+ # Available to use for quota purposes for server-side applications. Can be any
4334
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4335
+ # @param [Google::Apis::RequestOptions] options
4336
+ # Request-specific options
4337
+ #
4338
+ # @yield [result, err] Result & error if block supplied
4339
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm] parsed result object
4340
+ # @yieldparam err [StandardError] error object if request failed
4341
+ #
4342
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm]
4343
+ #
4344
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4345
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4346
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4347
+ def get_project_location_glossary_term(name, fields: nil, quota_user: nil, options: nil, &block)
4348
+ command = make_simple_command(:get, 'v1/{+name}', options)
4349
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm::Representation
4350
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm
4351
+ command.params['name'] = name unless name.nil?
4352
+ command.query['fields'] = fields unless fields.nil?
4353
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4354
+ execute_or_queue_command(command, &block)
4355
+ end
4356
+
3557
4357
  # Gets the access control policy for a resource. Returns an empty policy if the
3558
4358
  # resource exists and does not have a policy set.
3559
4359
  # @param [String] resource
@@ -3599,6 +4399,97 @@ module Google
3599
4399
  execute_or_queue_command(command, &block)
3600
4400
  end
3601
4401
 
4402
+ # Lists GlossaryTerm resources in a glossary.
4403
+ # @param [String] parent
4404
+ # Required. The parent, which has this collection of terms. Format: projects/`
4405
+ # project`/locations/`location`/glossaries/`glossary` Location is the GCP region.
4406
+ # @param [String] filter
4407
+ # Optional. Filter expression that filters terms listed in the response. Filters
4408
+ # supported: List GlossaryTerms based on immediate parent in the resource
4409
+ # hierarchy. This will only return the terms nested directly under the parent
4410
+ # and no other subsequent nested terms will be returned.
4411
+ # @param [String] order_by
4412
+ # Optional. Order by expression that orders terms listed in the response. Order
4413
+ # by fields are: name or create_time for the result. If not specified, the
4414
+ # ordering is undefined.
4415
+ # @param [Fixnum] page_size
4416
+ # Optional. The maximum number of terms to return. The service may return fewer
4417
+ # than this value. If unspecified, at most 50 terms will be returned. The
4418
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
4419
+ # @param [String] page_token
4420
+ # Optional. A page token, received from a previous ListGlossaryTerms call.
4421
+ # Provide this to retrieve the subsequent page. When paginating, all other
4422
+ # parameters provided to ListGlossaryTerms must match the call that provided the
4423
+ # page token.
4424
+ # @param [String] fields
4425
+ # Selector specifying which fields to include in a partial response.
4426
+ # @param [String] quota_user
4427
+ # Available to use for quota purposes for server-side applications. Can be any
4428
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4429
+ # @param [Google::Apis::RequestOptions] options
4430
+ # Request-specific options
4431
+ #
4432
+ # @yield [result, err] Result & error if block supplied
4433
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryTermsResponse] parsed result object
4434
+ # @yieldparam err [StandardError] error object if request failed
4435
+ #
4436
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryTermsResponse]
4437
+ #
4438
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4439
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4440
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4441
+ def list_project_location_glossary_terms(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4442
+ command = make_simple_command(:get, 'v1/{+parent}/terms', options)
4443
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryTermsResponse::Representation
4444
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListGlossaryTermsResponse
4445
+ command.params['parent'] = parent unless parent.nil?
4446
+ command.query['filter'] = filter unless filter.nil?
4447
+ command.query['orderBy'] = order_by unless order_by.nil?
4448
+ command.query['pageSize'] = page_size unless page_size.nil?
4449
+ command.query['pageToken'] = page_token unless page_token.nil?
4450
+ command.query['fields'] = fields unless fields.nil?
4451
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4452
+ execute_or_queue_command(command, &block)
4453
+ end
4454
+
4455
+ # Updates a GlossaryTerm resource.
4456
+ # @param [String] name
4457
+ # Output only. Identifier. The resource name of the GlossaryTerm. Format:
4458
+ # projects/`projectId`/locations/`locationId`/glossaries/`glossaryId`/terms/`
4459
+ # termId`
4460
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm] google_cloud_dataplex_v1_glossary_term_object
4461
+ # @param [String] update_mask
4462
+ # Required. The list of fields to update.
4463
+ # @param [String] fields
4464
+ # Selector specifying which fields to include in a partial response.
4465
+ # @param [String] quota_user
4466
+ # Available to use for quota purposes for server-side applications. Can be any
4467
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4468
+ # @param [Google::Apis::RequestOptions] options
4469
+ # Request-specific options
4470
+ #
4471
+ # @yield [result, err] Result & error if block supplied
4472
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm] parsed result object
4473
+ # @yieldparam err [StandardError] error object if request failed
4474
+ #
4475
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm]
4476
+ #
4477
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4478
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4479
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4480
+ def patch_project_location_glossary_term(name, google_cloud_dataplex_v1_glossary_term_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4481
+ command = make_simple_command(:patch, 'v1/{+name}', options)
4482
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm::Representation
4483
+ command.request_object = google_cloud_dataplex_v1_glossary_term_object
4484
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm::Representation
4485
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm
4486
+ command.params['name'] = name unless name.nil?
4487
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4488
+ command.query['fields'] = fields unless fields.nil?
4489
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4490
+ execute_or_queue_command(command, &block)
4491
+ end
4492
+
3602
4493
  # Sets the access control policy on the specified resource. Replaces any
3603
4494
  # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
3604
4495
  # errors.