google-apis-discoveryengine_v1 0.51.0 → 0.52.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.
@@ -198,6 +198,89 @@ module Google
198
198
  execute_or_queue_command(command, &block)
199
199
  end
200
200
 
201
+ # Creates a Collection and sets up the DataConnector for it. To stop a
202
+ # DataConnector after setup, use the CollectionService.DeleteCollection method.
203
+ # @param [String] parent
204
+ # Required. The parent of Collection, in the format of `projects/`project`/
205
+ # locations/`location``.
206
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest] google_cloud_discoveryengine_v1_set_up_data_connector_request_object
207
+ # @param [String] fields
208
+ # Selector specifying which fields to include in a partial response.
209
+ # @param [String] quota_user
210
+ # Available to use for quota purposes for server-side applications. Can be any
211
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
212
+ # @param [Google::Apis::RequestOptions] options
213
+ # Request-specific options
214
+ #
215
+ # @yield [result, err] Result & error if block supplied
216
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
217
+ # @yieldparam err [StandardError] error object if request failed
218
+ #
219
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
220
+ #
221
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
222
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
223
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
224
+ def set_project_location_up_data_connector(parent, google_cloud_discoveryengine_v1_set_up_data_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
225
+ command = make_simple_command(:post, 'v1/{+parent}:setUpDataConnector', options)
226
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest::Representation
227
+ command.request_object = google_cloud_discoveryengine_v1_set_up_data_connector_request_object
228
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
229
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
230
+ command.params['parent'] = parent unless parent.nil?
231
+ command.query['fields'] = fields unless fields.nil?
232
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
233
+ execute_or_queue_command(command, &block)
234
+ end
235
+
236
+ # Creates a Collection and sets up the DataConnector for it. To stop a
237
+ # DataConnector after setup, use the CollectionService.DeleteCollection method.
238
+ # @param [String] parent
239
+ # Required. The parent of Collection, in the format of `projects/`project`/
240
+ # locations/`location``.
241
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector] google_cloud_discoveryengine_v1_data_connector_object
242
+ # @param [String] collection_display_name
243
+ # Required. The display name of the Collection. Should be human readable, used
244
+ # to display collections in the Console Dashboard. UTF-8 encoded string with
245
+ # limit of 1024 characters.
246
+ # @param [String] collection_id
247
+ # Required. The ID to use for the Collection, which will become the final
248
+ # component of the Collection's resource name. A new Collection is created as
249
+ # part of the DataConnector setup. DataConnector is a singleton resource under
250
+ # Collection, managing all DataStores of the Collection. This field must conform
251
+ # to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
252
+ # limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
253
+ # @param [String] fields
254
+ # Selector specifying which fields to include in a partial response.
255
+ # @param [String] quota_user
256
+ # Available to use for quota purposes for server-side applications. Can be any
257
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
258
+ # @param [Google::Apis::RequestOptions] options
259
+ # Request-specific options
260
+ #
261
+ # @yield [result, err] Result & error if block supplied
262
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
263
+ # @yieldparam err [StandardError] error object if request failed
264
+ #
265
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
266
+ #
267
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
268
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
269
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
270
+ def set_project_location_up_data_connector_v2(parent, google_cloud_discoveryengine_v1_data_connector_object = nil, collection_display_name: nil, collection_id: nil, fields: nil, quota_user: nil, options: nil, &block)
271
+ command = make_simple_command(:post, 'v1/{+parent}:setUpDataConnectorV2', options)
272
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector::Representation
273
+ command.request_object = google_cloud_discoveryengine_v1_data_connector_object
274
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
275
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
276
+ command.params['parent'] = parent unless parent.nil?
277
+ command.query['collectionDisplayName'] = collection_display_name unless collection_display_name.nil?
278
+ command.query['collectionId'] = collection_id unless collection_id.nil?
279
+ command.query['fields'] = fields unless fields.nil?
280
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
281
+ execute_or_queue_command(command, &block)
282
+ end
283
+
201
284
  # Default ACL configuration for use in a location of a customer's project.
202
285
  # Updates will only reflect to new data stores. Existing data stores will still
203
286
  # use the old value.
@@ -414,6 +497,116 @@ module Google
414
497
  execute_or_queue_command(command, &block)
415
498
  end
416
499
 
500
+ # Deletes a Collection.
501
+ # @param [String] name
502
+ # Required. The full resource name of the Collection, in the format of `projects/
503
+ # `project`/locations/`location`/collections/`collection``.
504
+ # @param [String] fields
505
+ # Selector specifying which fields to include in a partial response.
506
+ # @param [String] quota_user
507
+ # Available to use for quota purposes for server-side applications. Can be any
508
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
509
+ # @param [Google::Apis::RequestOptions] options
510
+ # Request-specific options
511
+ #
512
+ # @yield [result, err] Result & error if block supplied
513
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
514
+ # @yieldparam err [StandardError] error object if request failed
515
+ #
516
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
517
+ #
518
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
519
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
520
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
521
+ def delete_project_location_collection(name, fields: nil, quota_user: nil, options: nil, &block)
522
+ command = make_simple_command(:delete, 'v1/{+name}', options)
523
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
524
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
525
+ command.params['name'] = name unless name.nil?
526
+ command.query['fields'] = fields unless fields.nil?
527
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
528
+ execute_or_queue_command(command, &block)
529
+ end
530
+
531
+ # Gets the DataConnector. DataConnector is a singleton resource for each
532
+ # Collection.
533
+ # @param [String] name
534
+ # Required. Full resource name of DataConnector, such as `projects/`project`/
535
+ # locations/`location`/collections/`collection_id`/dataConnector`. If the caller
536
+ # does not have permission to access the DataConnector, regardless of whether or
537
+ # not it exists, a PERMISSION_DENIED error is returned. If the requested
538
+ # DataConnector does not exist, a NOT_FOUND error is returned.
539
+ # @param [String] fields
540
+ # Selector specifying which fields to include in a partial response.
541
+ # @param [String] quota_user
542
+ # Available to use for quota purposes for server-side applications. Can be any
543
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
544
+ # @param [Google::Apis::RequestOptions] options
545
+ # Request-specific options
546
+ #
547
+ # @yield [result, err] Result & error if block supplied
548
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector] parsed result object
549
+ # @yieldparam err [StandardError] error object if request failed
550
+ #
551
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector]
552
+ #
553
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
554
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
555
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
556
+ def get_project_location_collection_data_connector(name, fields: nil, quota_user: nil, options: nil, &block)
557
+ command = make_simple_command(:get, 'v1/{+name}', options)
558
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector::Representation
559
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector
560
+ command.params['name'] = name unless name.nil?
561
+ command.query['fields'] = fields unless fields.nil?
562
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
563
+ execute_or_queue_command(command, &block)
564
+ end
565
+
566
+ # Updates a DataConnector.
567
+ # @param [String] name
568
+ # Output only. The full resource name of the Data Connector. Format: `projects/*/
569
+ # locations/*/collections/*/dataConnector`.
570
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector] google_cloud_discoveryengine_v1_data_connector_object
571
+ # @param [String] update_mask
572
+ # Indicates which fields in the provided DataConnector to update. Supported
573
+ # field paths include: - refresh_interval - params - auto_run_disabled -
574
+ # action_config - action_config.action_params - action_config.service_name -
575
+ # destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled
576
+ # - incremental_refresh_interval Note: Support for these fields may vary
577
+ # depending on the connector type. For example, not all connectors support `
578
+ # destination_configs`. If an unsupported or unknown field path is provided, the
579
+ # request will return an INVALID_ARGUMENT error.
580
+ # @param [String] fields
581
+ # Selector specifying which fields to include in a partial response.
582
+ # @param [String] quota_user
583
+ # Available to use for quota purposes for server-side applications. Can be any
584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
585
+ # @param [Google::Apis::RequestOptions] options
586
+ # Request-specific options
587
+ #
588
+ # @yield [result, err] Result & error if block supplied
589
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector] parsed result object
590
+ # @yieldparam err [StandardError] error object if request failed
591
+ #
592
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector]
593
+ #
594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
597
+ def update_project_location_collection_data_connector(name, google_cloud_discoveryengine_v1_data_connector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
598
+ command = make_simple_command(:patch, 'v1/{+name}', options)
599
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector::Representation
600
+ command.request_object = google_cloud_discoveryengine_v1_data_connector_object
601
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector::Representation
602
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataConnector
603
+ command.params['name'] = name unless name.nil?
604
+ command.query['updateMask'] = update_mask unless update_mask.nil?
605
+ command.query['fields'] = fields unless fields.nil?
606
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
607
+ execute_or_queue_command(command, &block)
608
+ end
609
+
417
610
  # Gets the latest state of a long-running operation. Clients can use this method
418
611
  # to poll the operation result at intervals as recommended by the API service.
419
612
  # @param [String] name
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.51.0
4
+ version: 0.52.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -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_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.51.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.52.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
62
62
  rdoc_options: []
63
63
  require_paths: