google-apis-discoveryengine_v1beta 0.57.0 → 0.59.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.
@@ -88,6 +88,39 @@ module Google
88
88
  execute_or_queue_command(command, &block)
89
89
  end
90
90
 
91
+ # Gets the CmekConfig.
92
+ # @param [String] name
93
+ # Required. Resource name of CmekConfig, such as `projects/*/locations/*/
94
+ # cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not
95
+ # have permission to access the CmekConfig, regardless of whether or not it
96
+ # exists, a PERMISSION_DENIED error is returned.
97
+ # @param [String] fields
98
+ # Selector specifying which fields to include in a partial response.
99
+ # @param [String] quota_user
100
+ # Available to use for quota purposes for server-side applications. Can be any
101
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
102
+ # @param [Google::Apis::RequestOptions] options
103
+ # Request-specific options
104
+ #
105
+ # @yield [result, err] Result & error if block supplied
106
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig] parsed result object
107
+ # @yieldparam err [StandardError] error object if request failed
108
+ #
109
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig]
110
+ #
111
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
112
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
113
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
114
+ def get_project_location_single_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
115
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
116
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig::Representation
117
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig
118
+ command.params['name'] = name unless name.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
+
91
124
  # Obtains the time series data of organic or dedicated crawl rate for monitoring.
92
125
  # When dedicated crawl rate is not set, it will return vertex AI's organic
93
126
  # crawl rate time series. Organic crawl means Google automatically crawl the
@@ -202,6 +235,185 @@ module Google
202
235
  execute_or_queue_command(command, &block)
203
236
  end
204
237
 
238
+ # Provisions a CMEK key for use in a location of a customer's project. This
239
+ # method will also conduct location validation on the provided cmekConfig to
240
+ # make sure the key is valid and can be used in the selected location.
241
+ # @param [String] name
242
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
243
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
244
+ # `cmekConfig``.
245
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig] google_cloud_discoveryengine_v1beta_cmek_config_object
246
+ # @param [Boolean] set_default
247
+ # Set the following CmekConfig as the default to be used for child resources if
248
+ # one is not specified.
249
+ # @param [String] fields
250
+ # Selector specifying which fields to include in a partial response.
251
+ # @param [String] quota_user
252
+ # Available to use for quota purposes for server-side applications. Can be any
253
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
254
+ # @param [Google::Apis::RequestOptions] options
255
+ # Request-specific options
256
+ #
257
+ # @yield [result, err] Result & error if block supplied
258
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
259
+ # @yieldparam err [StandardError] error object if request failed
260
+ #
261
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
262
+ #
263
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
264
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
265
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
266
+ def update_project_location_cmek_config(name, google_cloud_discoveryengine_v1beta_cmek_config_object = nil, set_default: nil, fields: nil, quota_user: nil, options: nil, &block)
267
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
268
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig::Representation
269
+ command.request_object = google_cloud_discoveryengine_v1beta_cmek_config_object
270
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
271
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
272
+ command.params['name'] = name unless name.nil?
273
+ command.query['setDefault'] = set_default unless set_default.nil?
274
+ command.query['fields'] = fields unless fields.nil?
275
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
276
+ execute_or_queue_command(command, &block)
277
+ end
278
+
279
+ # De-provisions a CmekConfig.
280
+ # @param [String] name
281
+ # Required. The resource name of the CmekConfig to delete, such as `projects/`
282
+ # project`/locations/`location`/cmekConfigs/`cmek_config``.
283
+ # @param [String] fields
284
+ # Selector specifying which fields to include in a partial response.
285
+ # @param [String] quota_user
286
+ # Available to use for quota purposes for server-side applications. Can be any
287
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
288
+ # @param [Google::Apis::RequestOptions] options
289
+ # Request-specific options
290
+ #
291
+ # @yield [result, err] Result & error if block supplied
292
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
293
+ # @yieldparam err [StandardError] error object if request failed
294
+ #
295
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
296
+ #
297
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
298
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
299
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
300
+ def delete_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
301
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
302
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
303
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
304
+ command.params['name'] = name unless name.nil?
305
+ command.query['fields'] = fields unless fields.nil?
306
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
307
+ execute_or_queue_command(command, &block)
308
+ end
309
+
310
+ # Gets the CmekConfig.
311
+ # @param [String] name
312
+ # Required. Resource name of CmekConfig, such as `projects/*/locations/*/
313
+ # cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not
314
+ # have permission to access the CmekConfig, regardless of whether or not it
315
+ # exists, a PERMISSION_DENIED error is returned.
316
+ # @param [String] fields
317
+ # Selector specifying which fields to include in a partial response.
318
+ # @param [String] quota_user
319
+ # Available to use for quota purposes for server-side applications. Can be any
320
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
321
+ # @param [Google::Apis::RequestOptions] options
322
+ # Request-specific options
323
+ #
324
+ # @yield [result, err] Result & error if block supplied
325
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig] parsed result object
326
+ # @yieldparam err [StandardError] error object if request failed
327
+ #
328
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig]
329
+ #
330
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
333
+ def get_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
334
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
335
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig::Representation
336
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig
337
+ command.params['name'] = name unless name.nil?
338
+ command.query['fields'] = fields unless fields.nil?
339
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
340
+ execute_or_queue_command(command, &block)
341
+ end
342
+
343
+ # Lists all the CmekConfigs with the project.
344
+ # @param [String] parent
345
+ # Required. The parent location resource name, such as `projects/`project`/
346
+ # locations/`location``. If the caller does not have permission to list
347
+ # CmekConfigs under this location, regardless of whether or not a CmekConfig
348
+ # exists, a PERMISSION_DENIED error is returned.
349
+ # @param [String] fields
350
+ # Selector specifying which fields to include in a partial response.
351
+ # @param [String] quota_user
352
+ # Available to use for quota purposes for server-side applications. Can be any
353
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
354
+ # @param [Google::Apis::RequestOptions] options
355
+ # Request-specific options
356
+ #
357
+ # @yield [result, err] Result & error if block supplied
358
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse] parsed result object
359
+ # @yieldparam err [StandardError] error object if request failed
360
+ #
361
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse]
362
+ #
363
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
364
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
365
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
366
+ def list_project_location_cmek_configs(parent, fields: nil, quota_user: nil, options: nil, &block)
367
+ command = make_simple_command(:get, 'v1beta/{+parent}/cmekConfigs', options)
368
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse::Representation
369
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse
370
+ command.params['parent'] = parent unless parent.nil?
371
+ command.query['fields'] = fields unless fields.nil?
372
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
373
+ execute_or_queue_command(command, &block)
374
+ end
375
+
376
+ # Provisions a CMEK key for use in a location of a customer's project. This
377
+ # method will also conduct location validation on the provided cmekConfig to
378
+ # make sure the key is valid and can be used in the selected location.
379
+ # @param [String] name
380
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
381
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
382
+ # `cmekConfig``.
383
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig] google_cloud_discoveryengine_v1beta_cmek_config_object
384
+ # @param [Boolean] set_default
385
+ # Set the following CmekConfig as the default to be used for child resources if
386
+ # one is not specified.
387
+ # @param [String] fields
388
+ # Selector specifying which fields to include in a partial response.
389
+ # @param [String] quota_user
390
+ # Available to use for quota purposes for server-side applications. Can be any
391
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
392
+ # @param [Google::Apis::RequestOptions] options
393
+ # Request-specific options
394
+ #
395
+ # @yield [result, err] Result & error if block supplied
396
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
397
+ # @yieldparam err [StandardError] error object if request failed
398
+ #
399
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
400
+ #
401
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
402
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
403
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
404
+ def patch_project_location_cmek_config(name, google_cloud_discoveryengine_v1beta_cmek_config_object = nil, set_default: nil, fields: nil, quota_user: nil, options: nil, &block)
405
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
406
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig::Representation
407
+ command.request_object = google_cloud_discoveryengine_v1beta_cmek_config_object
408
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
409
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
410
+ command.params['name'] = name unless name.nil?
411
+ command.query['setDefault'] = set_default unless set_default.nil?
412
+ command.query['fields'] = fields unless fields.nil?
413
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
414
+ execute_or_queue_command(command, &block)
415
+ end
416
+
205
417
  # Gets the latest state of a long-running operation. Clients can use this method
206
418
  # to poll the operation result at intervals as recommended by the API service.
207
419
  # @param [String] name
@@ -8349,6 +8561,37 @@ module Google
8349
8561
  execute_or_queue_command(command, &block)
8350
8562
  end
8351
8563
 
8564
+ # Gets the latest state of a long-running operation. Clients can use this method
8565
+ # to poll the operation result at intervals as recommended by the API service.
8566
+ # @param [String] name
8567
+ # The name of the operation resource.
8568
+ # @param [String] fields
8569
+ # Selector specifying which fields to include in a partial response.
8570
+ # @param [String] quota_user
8571
+ # Available to use for quota purposes for server-side applications. Can be any
8572
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8573
+ # @param [Google::Apis::RequestOptions] options
8574
+ # Request-specific options
8575
+ #
8576
+ # @yield [result, err] Result & error if block supplied
8577
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
8578
+ # @yieldparam err [StandardError] error object if request failed
8579
+ #
8580
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
8581
+ #
8582
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8583
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8584
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8585
+ def get_project_location_podcast_operation(name, fields: nil, quota_user: nil, options: nil, &block)
8586
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
8587
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
8588
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
8589
+ command.params['name'] = name unless name.nil?
8590
+ command.query['fields'] = fields unless fields.nil?
8591
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8592
+ execute_or_queue_command(command, &block)
8593
+ end
8594
+
8352
8595
  # Ranks a list of text records based on the given input query.
8353
8596
  # @param [String] ranking_config
8354
8597
  # Required. The resource name of the rank service config, such as `projects/`
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.57.0
4
+ version: 0.59.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-09 00:00:00.000000000 Z
10
+ date: 2025-03-23 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.57.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.59.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
62
62
  rdoc_options: []
63
63
  require_paths: