Class: Google::Apis::DiscoveryengineV1::DiscoveryEngineService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/discoveryengine_v1/service.rb

Overview

Discovery Engine API

Discovery Engine API.

Examples:

require 'google/apis/discoveryengine_v1'

Discoveryengine = Google::Apis::DiscoveryengineV1 # Alias the module
service = Discoveryengine::DiscoveryEngineService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://discoveryengine.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DiscoveryEngineService

Returns a new instance of DiscoveryEngineService.



47
48
49
50
51
52
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-discoveryengine_v1',
        client_version: Google::Apis::DiscoveryengineV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#answer_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse

Answer query method.

Parameters:

  • serving_config (String) —

    Required. The resource name of the Search serving config, such as projects/*/ locations/global/collections/default_collection/engines/*/servingConfigs/ default_serving_config, or projects/*/locations/global/collections/ default_collection/dataStores/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

  • google_cloud_discoveryengine_v1_answer_query_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1703

def answer_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#answer_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse

Answer query method.

Parameters:

  • serving_config (String) —

    Required. The resource name of the Search serving config, such as projects/*/ locations/global/collections/default_collection/engines/*/servingConfigs/ default_serving_config, or projects/*/locations/global/collections/ default_collection/dataStores/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

  • google_cloud_discoveryengine_v1_answer_query_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3463

def answer_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#answer_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse

Answer query method.

Parameters:

  • serving_config (String) —

    Required. The resource name of the Search serving config, such as projects/*/ locations/global/collections/default_collection/engines/*/servingConfigs/ default_serving_config, or projects/*/locations/global/collections/ default_collection/dataStores/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

  • google_cloud_discoveryengine_v1_answer_query_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5315

def answer_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_collection_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates TargetSite in a batch.

Parameters:

  • parent (String) —

    Required. The parent resource shared by all TargetSites being created. projects/project/locations/location/collections/collection/dataStores/ data_store/siteSearchEngine. The parent field in the CreateBookRequest messages must either be empty or match this field.

  • google_cloud_discoveryengine_v1_batch_create_target_sites_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2292

def batch_project_location_collection_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/targetSites:batchCreate', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_batch_create_target_sites_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

Parameters:

  • parent (String) —

    Required. The parent resource shared by all TargetSites being verified. projects/project/locations/location/collections/collection/dataStores/ data_store/siteSearchEngine.

  • google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2038

def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:batchVerifyTargetSites', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates TargetSite in a batch.

Parameters:

  • parent (String) —

    Required. The parent resource shared by all TargetSites being created. projects/project/locations/location/collections/collection/dataStores/ data_store/siteSearchEngine. The parent field in the CreateBookRequest messages must either be empty or match this field.

  • google_cloud_discoveryengine_v1_batch_create_target_sites_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5752

def batch_project_location_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/targetSites:batchCreate', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_batch_create_target_sites_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • google_longrunning_cancel_operation_request_object (Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 772

def cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • google_longrunning_cancel_operation_request_object (Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4455

def cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • google_longrunning_cancel_operation_request_object (Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6403

def cancel_project_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse

Performs a grounding check.

Parameters:

  • grounding_config (String) —

    Required. The resource name of the grounding config, such as projects/*/ locations/global/groundingConfigs/default_grounding_config.

  • google_cloud_discoveryengine_v1_check_grounding_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6168

def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+groundingConfig}:check', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_check_grounding_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse
  command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleApiHttpBody

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Parameters:

  • parent (String) —

    Required. The parent DataStore resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store``.

  • ets (Fixnum) (defaults to: nil) —

    The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

  • uri (String) (defaults to: nil) —

    The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

  • user_event (String) (defaults to: nil) —

    Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2664

def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userEvents:collect', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['ets'] = ets unless ets.nil?
  command.query['uri'] = uri unless uri.nil?
  command.query['userEvent'] = user_event unless user_event.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#collect_project_location_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleApiHttpBody

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Parameters:

  • parent (String) —

    Required. The parent DataStore resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store``.

  • ets (Fixnum) (defaults to: nil) —

    The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

  • uri (String) (defaults to: nil) —

    The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

  • user_event (String) (defaults to: nil) —

    Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6053

def collect_project_location_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userEvents:collect', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['ets'] = ets unless ets.nil?
  command.query['uri'] = uri unless uri.nil?
  command.query['userEvent'] = user_event unless user_event.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#collect_project_location_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleApiHttpBody

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Parameters:

  • parent (String) —

    Required. The parent DataStore resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store``.

  • ets (Fixnum) (defaults to: nil) —

    The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

  • uri (String) (defaults to: nil) —

    The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

  • user_event (String) (defaults to: nil) —

    Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6320

def collect_project_location_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userEvents:collect', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['ets'] = ets unless ets.nil?
  command.query['uri'] = uri unless uri.nil?
  command.query['userEvent'] = user_event unless user_event.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_project_location_collection_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompleteQueryResponse

Completes the specified user input with keyword suggestions.

Parameters:

  • data_store (String) —

    Required. The parent data store resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/ dataStores/default_data_store.

  • include_tail_suggestions (Boolean) (defaults to: nil) —

    Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

  • query (String) (defaults to: nil) —

    Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

  • query_model (String) (defaults to: nil) —

    Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * document - Using suggestions generated from user- imported documents. * search-history - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * user-event - Using suggestions generated from user- imported search events. * document-completable - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * document is the default model for regular dataStores. * search- history is the default model for site search dataStores.

  • user_pseudo_id (String) (defaults to: nil) —

    A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as unknown_visitor. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 211

def complete_project_location_collection_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+dataStore}:completeQuery', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompleteQueryResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompleteQueryResponse
  command.params['dataStore'] = data_store unless data_store.nil?
  command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
  command.query['query'] = query unless query.nil?
  command.query['queryModel'] = query_model unless query_model.nil?
  command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_project_location_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompleteQueryResponse

Completes the specified user input with keyword suggestions.

Parameters:

  • data_store (String) —

    Required. The parent data store resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/ dataStores/default_data_store.

  • include_tail_suggestions (Boolean) (defaults to: nil) —

    Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

  • query (String) (defaults to: nil) —

    Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

  • query_model (String) (defaults to: nil) —

    Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * document - Using suggestions generated from user- imported documents. * search-history - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * user-event - Using suggestions generated from user- imported search events. * document-completable - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * document is the default model for regular dataStores. * search- history is the default model for site search dataStores.

  • user_pseudo_id (String) (defaults to: nil) —

    A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as unknown_visitor. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3894

def complete_project_location_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+dataStore}:completeQuery', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompleteQueryResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompleteQueryResponse
  command.params['dataStore'] = data_store unless data_store.nil?
  command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
  command.query['query'] = query unless query.nil?
  command.query['queryModel'] = query_model unless query_model.nil?
  command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#converse_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse

Converses a conversation.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id`. Useprojects/project_number /locations/location_id/collections/collection/dataStores/data_store_id/ conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

  • google_cloud_discoveryengine_v1_converse_conversation_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1075

def converse_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:converse', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_converse_conversation_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse

Converses a conversation.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id`. Useprojects/project_number /locations/location_id/collections/collection/dataStores/data_store_id/ conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

  • google_cloud_discoveryengine_v1_converse_conversation_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3164

def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:converse', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_converse_conversation_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#converse_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse

Converses a conversation.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id`. Useprojects/project_number /locations/location_id/collections/collection/dataStores/data_store_id/ conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

  • google_cloud_discoveryengine_v1_converse_conversation_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4758

def converse_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:converse', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_converse_conversation_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection``.

  • google_cloud_discoveryengine_v1_data_store_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore) (defaults to: nil)
  • create_advanced_site_search (Boolean) (defaults to: nil) —

    A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

  • data_store_id (String) (defaults to: nil) —

    Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC- 1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 259

def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dataStores', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.request_object = google_cloud_discoveryengine_v1_data_store_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
  command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Creates a Document.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection/dataStores/data_store/branches/branch``.

  • google_cloud_discoveryengine_v1_document_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document) (defaults to: nil)
  • document_id (String) (defaults to: nil) —

    Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 495

def create_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/documents', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.request_object = google_cloud_discoveryengine_v1_document_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
  command.params['parent'] = parent unless parent.nil?
  command.query['documentId'] = document_id unless document_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_idor `projects/`project_number`/locations/`location_id`/ collections/`collection_id`/engines/`engine_id.

  • google_cloud_discoveryengine_v1_control_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control) (defaults to: nil)
  • control_id (String) (defaults to: nil) —

    Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 885

def create_project_location_collection_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/controls', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.request_object = google_cloud_discoveryengine_v1_control_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['parent'] = parent unless parent.nil?
  command.query['controlId'] = control_id unless control_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id``

  • google_cloud_discoveryengine_v1_conversation_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1111

def create_project_location_collection_data_store_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.request_object = google_cloud_discoveryengine_v1_conversation_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store_schema(parent, google_cloud_discoveryengine_v1_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a Schema.

Parameters:

  • parent (String) —

    Required. The parent data store resource name, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store`` .

  • google_cloud_discoveryengine_v1_schema_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema) (defaults to: nil)
  • schema_id (String) (defaults to: nil) —

    Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1446

def create_project_location_collection_data_store_schema(parent, google_cloud_discoveryengine_v1_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/schemas', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
  command.request_object = google_cloud_discoveryengine_v1_schema_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['schemaId'] = schema_id unless schema_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id``

  • google_cloud_discoveryengine_v1_session_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1817

def create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.request_object = google_cloud_discoveryengine_v1_session_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a TargetSite.

Parameters:

  • parent (String) —

    Required. Parent resource name of TargetSite, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine.

  • google_cloud_discoveryengine_v1_target_site_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2327

def create_project_location_collection_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/targetSites', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite::Representation
  command.request_object = google_cloud_discoveryengine_v1_target_site_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_engine(parent, google_cloud_discoveryengine_v1_engine_object = nil, engine_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a Engine.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection``.

  • google_cloud_discoveryengine_v1_engine_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine) (defaults to: nil)
  • engine_id (String) (defaults to: nil) —

    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2784

def create_project_location_collection_engine(parent, google_cloud_discoveryengine_v1_engine_object = nil, engine_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/engines', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine::Representation
  command.request_object = google_cloud_discoveryengine_v1_engine_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['engineId'] = engine_id unless engine_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_engine_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_idor `projects/`project_number`/locations/`location_id`/ collections/`collection_id`/engines/`engine_id.

  • google_cloud_discoveryengine_v1_control_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control) (defaults to: nil)
  • control_id (String) (defaults to: nil) —

    Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2974

def create_project_location_collection_engine_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/controls', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.request_object = google_cloud_discoveryengine_v1_control_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['parent'] = parent unless parent.nil?
  command.query['controlId'] = control_id unless control_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id``

  • google_cloud_discoveryengine_v1_conversation_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3200

def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.request_object = google_cloud_discoveryengine_v1_conversation_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id``

  • google_cloud_discoveryengine_v1_session_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3577

def create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.request_object = google_cloud_discoveryengine_v1_session_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection``.

  • google_cloud_discoveryengine_v1_data_store_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore) (defaults to: nil)
  • create_advanced_site_search (Boolean) (defaults to: nil) —

    A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

  • data_store_id (String) (defaults to: nil) —

    Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC- 1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3942

def create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dataStores', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.request_object = google_cloud_discoveryengine_v1_data_store_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
  command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Creates a Document.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection/dataStores/data_store/branches/branch``.

  • google_cloud_discoveryengine_v1_document_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document) (defaults to: nil)
  • document_id (String) (defaults to: nil) —

    Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4178

def create_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/documents', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.request_object = google_cloud_discoveryengine_v1_document_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
  command.params['parent'] = parent unless parent.nil?
  command.query['documentId'] = document_id unless document_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_idor `projects/`project_number`/locations/`location_id`/ collections/`collection_id`/engines/`engine_id.

  • google_cloud_discoveryengine_v1_control_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control) (defaults to: nil)
  • control_id (String) (defaults to: nil) —

    Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4568

def create_project_location_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/controls', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.request_object = google_cloud_discoveryengine_v1_control_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['parent'] = parent unless parent.nil?
  command.query['controlId'] = control_id unless control_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id``

  • google_cloud_discoveryengine_v1_conversation_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4794

def create_project_location_data_store_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.request_object = google_cloud_discoveryengine_v1_conversation_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store_schema(parent, google_cloud_discoveryengine_v1_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a Schema.

Parameters:

  • parent (String) —

    Required. The parent data store resource name, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store`` .

  • google_cloud_discoveryengine_v1_schema_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema) (defaults to: nil)
  • schema_id (String) (defaults to: nil) —

    Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5129

def create_project_location_data_store_schema(parent, google_cloud_discoveryengine_v1_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/schemas', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
  command.request_object = google_cloud_discoveryengine_v1_schema_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['schemaId'] = schema_id unless schema_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent data store. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id``

  • google_cloud_discoveryengine_v1_session_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5429

def create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.request_object = google_cloud_discoveryengine_v1_session_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Creates a TargetSite.

Parameters:

  • parent (String) —

    Required. Parent resource name of TargetSite, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine.

  • google_cloud_discoveryengine_v1_target_site_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5787

def create_project_location_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/targetSites', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite::Representation
  command.request_object = google_cloud_discoveryengine_v1_target_site_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a DataStore.

Parameters:

  • name (String) —

    Required. Full resource name of DataStore, such as projects/project/ locations/location/collections/collection_id/dataStores/data_store_id``. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



297
298
299
300
301
302
303
304
305
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 297

def delete_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Document.

Parameters:

  • name (String) —

    Required. Full resource name of Document, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch/documents/document`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIEDerror is returned. If the Document to delete does not exist, aNOT_FOUND` error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



533
534
535
536
537
538
539
540
541
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 533

def delete_project_location_collection_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Control to delete. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_id/controls/control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



921
922
923
924
925
926
927
928
929
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 921

def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to delete. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1146

def delete_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a Schema.

Parameters:

  • name (String) —

    Required. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1481

def delete_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Session to delete. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/sessions/session_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1852
1853
1854
1855
1856
1857
1858
1859
1860
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1852

def delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a TargetSite.

Parameters:

  • name (String) —

    Required. Full resource name of TargetSite, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine/targetSites/target_site``. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2364
2365
2366
2367
2368
2369
2370
2371
2372
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2364

def delete_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a Engine.

Parameters:

  • name (String) —

    Required. Full resource name of Engine, such as projects/project/locations/ location/collections/collection_id/engines/engine_id``. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2821
2822
2823
2824
2825
2826
2827
2828
2829
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2821

def delete_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Control to delete. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_id/controls/control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3010
3011
3012
3013
3014
3015
3016
3017
3018
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3010

def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to delete. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3235
3236
3237
3238
3239
3240
3241
3242
3243
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3235

def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Session to delete. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/sessions/session_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3612
3613
3614
3615
3616
3617
3618
3619
3620
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3612

def delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a DataStore.

Parameters:

  • name (String) —

    Required. Full resource name of DataStore, such as projects/project/ locations/location/collections/collection_id/dataStores/data_store_id``. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3980
3981
3982
3983
3984
3985
3986
3987
3988
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3980

def delete_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Document.

Parameters:

  • name (String) —

    Required. Full resource name of Document, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch/documents/document`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIEDerror is returned. If the Document to delete does not exist, aNOT_FOUND` error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4216
4217
4218
4219
4220
4221
4222
4223
4224
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4216

def delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Control to delete. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_id/controls/control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4604
4605
4606
4607
4608
4609
4610
4611
4612
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4604

def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to delete. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4829
4830
4831
4832
4833
4834
4835
4836
4837
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4829

def delete_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a Schema.

Parameters:

  • name (String) —

    Required. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5164
5165
5166
5167
5168
5169
5170
5171
5172
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5164

def delete_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Session to delete. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/sessions/session_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5464
5465
5466
5467
5468
5469
5470
5471
5472
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5464

def delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes a TargetSite.

Parameters:

  • name (String) —

    Required. Full resource name of TargetSite, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine/targetSites/target_site``. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5824
5825
5826
5827
5828
5829
5830
5831
5832
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5824

def delete_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Downgrade from advanced site search to basic site search.

Parameters:

  • site_search_engine (String) —

    Required. Full resource name of the SiteSearchEngine, such as projects/ project/locations/location/dataStores/data_store_id/siteSearchEngine.

  • google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2072

def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Downgrade from advanced site search to basic site search.

Parameters:

  • site_search_engine (String) —

    Required. Full resource name of the SiteSearchEngine, such as projects/ project/locations/location/dataStores/data_store_id/siteSearchEngine.

  • google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5648

def disable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Upgrade from basic site search to advanced site search.

Parameters:

  • site_search_engine (String) —

    Required. Full resource name of the SiteSearchEngine, such as projects/ project/locations/location/dataStores/data_store_id/siteSearchEngine.

  • google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2106

def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Upgrade from basic site search to advanced site search.

Parameters:

  • site_search_engine (String) —

    Required. Full resource name of the SiteSearchEngine, such as projects/ project/locations/location/dataStores/data_store_id/siteSearchEngine.

  • google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5682

def enable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_collection_data_store_site_search_engine_domain_verification_status(site_search_engine, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

Parameters:

  • site_search_engine (String) —

    Required. The site search engine resource under which we fetch all the domain verification status. projects/project/locations/location/collections/ collection/dataStores/data_store/siteSearchEngine.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous FetchDomainVerificationStatus call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FetchDomainVerificationStatus must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2151

def fetch_project_location_collection_data_store_site_search_engine_domain_verification_status(site_search_engine, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+siteSearchEngine}:fetchDomainVerificationStatus', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_connector_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



112
113
114
115
116
117
118
119
120
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 112

def get_project_location_collection_data_connector_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore

Gets a DataStore.

Parameters:

  • name (String) —

    Required. Full resource name of DataStore, such as projects/project/ locations/location/collections/collection_id/dataStores/data_store_id``. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



331
332
333
334
335
336
337
338
339
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 331

def get_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Gets a Document.

Parameters:

  • name (String) —

    Required. Full resource name of Document, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch/documents/document`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIEDerror is returned. If the requested Document does not exist, aNOT_FOUND` error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



568
569
570
571
572
573
574
575
576
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 568

def get_project_location_collection_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



805
806
807
808
809
810
811
812
813
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 805

def get_project_location_collection_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Gets a Control.

Parameters:

  • name (String) —

    Required. The resource name of the Control to get. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_id/controls/control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



953
954
955
956
957
958
959
960
961
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 953

def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Gets a Conversation.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1178
1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1178

def get_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1298

def get_project_location_collection_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1369

def get_project_location_collection_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema

Gets a Schema.

Parameters:

  • name (String) —

    Required. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1513

def get_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1627
1628
1629
1630
1631
1632
1633
1634
1635
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1627

def get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Gets a Session.

Parameters:

  • name (String) —

    Required. The resource name of the Session to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/sessions/session_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1884
1885
1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1884

def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer

Gets a Answer.

Parameters:

  • name (String) —

    Required. The resource name of the Answer to get. Format: projects/ project_number/locations/location_id/collections/collection/engines/ engine_id/sessions/session_id/answers/answer_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2004
2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2004

def get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteSearchEngine

Gets the SiteSearchEngine.

Parameters:

  • name (String) —

    Required. Resource name of SiteSearchEngine, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine. If the caller does not have permission to access the [ SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



365
366
367
368
369
370
371
372
373
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 365

def get_project_location_collection_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteSearchEngine::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteSearchEngine
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2218
2219
2220
2221
2222
2223
2224
2225
2226
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2218

def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite

Gets a TargetSite.

Parameters:

  • name (String) —

    Required. Full resource name of TargetSite, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine/targetSites/target_site``. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2399
2400
2401
2402
2403
2404
2405
2406
2407
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2399

def get_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2511
2512
2513
2514
2515
2516
2517
2518
2519
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2511

def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine

Gets a Engine.

Parameters:

  • name (String) —

    Required. Full resource name of Engine, such as projects/project/locations/ location/collections/collection_id/engines/engine_id``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2852
2853
2854
2855
2856
2857
2858
2859
2860
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2852

def get_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Gets a Control.

Parameters:

  • name (String) —

    Required. The resource name of the Control to get. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_id/controls/control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3042

def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Gets a Conversation.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3267
3268
3269
3270
3271
3272
3273
3274
3275
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3267

def get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3387
3388
3389
3390
3391
3392
3393
3394
3395
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3387

def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Gets a Session.

Parameters:

  • name (String) —

    Required. The resource name of the Session to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/sessions/session_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3644
3645
3646
3647
3648
3649
3650
3651
3652
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3644

def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer

Gets a Answer.

Parameters:

  • name (String) —

    Required. The resource name of the Answer to get. Format: projects/ project_number/locations/location_id/collections/collection/engines/ engine_id/sessions/session_id/answers/answer_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3764
3765
3766
3767
3768
3769
3770
3771
3772
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3764

def get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3795
3796
3797
3798
3799
3800
3801
3802
3803
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3795

def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore

Gets a DataStore.

Parameters:

  • name (String) —

    Required. Full resource name of DataStore, such as projects/project/ locations/location/collections/collection_id/dataStores/data_store_id``. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4014
4015
4016
4017
4018
4019
4020
4021
4022
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4014

def get_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Gets a Document.

Parameters:

  • name (String) —

    Required. Full resource name of Document, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch/documents/document`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIEDerror is returned. If the requested Document does not exist, aNOT_FOUND` error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4251
4252
4253
4254
4255
4256
4257
4258
4259
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4251

def get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4488
4489
4490
4491
4492
4493
4494
4495
4496
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4488

def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Gets a Control.

Parameters:

  • name (String) —

    Required. The resource name of the Control to get. Format: projects/ project_number/locations/location_id/collections/collection_id/dataStores/ data_store_id/controls/control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4636
4637
4638
4639
4640
4641
4642
4643
4644
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4636

def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Gets a Conversation.

Parameters:

  • name (String) —

    Required. The resource name of the Conversation to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/conversations/conversation_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4861
4862
4863
4864
4865
4866
4867
4868
4869
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4861

def get_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4981
4982
4983
4984
4985
4986
4987
4988
4989
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4981

def get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5052
5053
5054
5055
5056
5057
5058
5059
5060
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5052

def get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema

Gets a Schema.

Parameters:

  • name (String) —

    Required. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5196
5197
5198
5199
5200
5201
5202
5203
5204
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5196

def get_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Gets a Session.

Parameters:

  • name (String) —

    Required. The resource name of the Session to get. Format: projects/ project_number/locations/location_id/collections/collection/dataStores/ data_store_id/sessions/session_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5496
5497
5498
5499
5500
5501
5502
5503
5504
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5496

def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer

Gets a Answer.

Parameters:

  • name (String) —

    Required. The resource name of the Answer to get. Format: projects/ project_number/locations/location_id/collections/collection/engines/ engine_id/sessions/session_id/answers/answer_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5616
5617
5618
5619
5620
5621
5622
5623
5624
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5616

def get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteSearchEngine

Gets the SiteSearchEngine.

Parameters:

  • name (String) —

    Required. Resource name of SiteSearchEngine, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine. If the caller does not have permission to access the [ SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4048
4049
4050
4051
4052
4053
4054
4055
4056
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4048

def get_project_location_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteSearchEngine::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteSearchEngine
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite

Gets a TargetSite.

Parameters:

  • name (String) —

    Required. Full resource name of TargetSite, such as projects/project/ locations/location/collections/collection/dataStores/data_store/ siteSearchEngine/targetSites/target_site``. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5859
5860
5861
5862
5863
5864
5865
5866
5867
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5859

def get_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6201
6202
6203
6204
6205
6206
6207
6208
6209
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6201

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6436
6437
6438
6439
6440
6441
6442
6443
6444
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6436

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Bulk import of multiple Documents. Request processing may be synchronous. Non- existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch``. Requires create/update permission.

  • google_cloud_discoveryengine_v1_import_documents_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportDocumentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 603

def import_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/documents:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportDocumentsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_documents_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_collection_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Imports all SuggestionDenyListEntry for a DataStore.

Parameters:

  • parent (String) —

    Required. The parent data store resource name for which to import denylist entries. Follows pattern projects//locations//collections//dataStores/.

  • google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2583

def import_project_location_collection_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/suggestionDenyListEntries:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation. metadata is of type ImportMetadata.

Parameters:

  • parent (String) —

    Required. Parent DataStore resource name, of the form projects/project/ locations/location/collections/collection/dataStores/data_store``

  • google_cloud_discoveryengine_v1_import_user_events_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportUserEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2703

def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportUserEventsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_user_events_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Bulk import of multiple Documents. Request processing may be synchronous. Non- existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch``. Requires create/update permission.

  • google_cloud_discoveryengine_v1_import_documents_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportDocumentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4286

def import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/documents:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportDocumentsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_documents_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Imports all SuggestionDenyListEntry for a DataStore.

Parameters:

  • parent (String) —

    Required. The parent data store resource name for which to import denylist entries. Follows pattern projects//locations//collections//dataStores/.

  • google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5972

def import_project_location_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/suggestionDenyListEntries:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_suggestion_deny_list_entries_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation. metadata is of type ImportMetadata.

Parameters:

  • parent (String) —

    Required. Parent DataStore resource name, of the form projects/project/ locations/location/collections/collection/dataStores/data_store``

  • google_cloud_discoveryengine_v1_import_user_events_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportUserEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6092

def import_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportUserEventsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_user_events_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_connector_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 149

def list_project_location_collection_data_connector_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDocumentsResponse

Gets a list of Documents.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch`. Usedefault_branchas the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED` error is returned.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

  • page_token (String) (defaults to: nil) —

    A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService. ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 650

def list_project_location_collection_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/documents', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDocumentsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDocumentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 842

def list_project_location_collection_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse

Lists all Controls by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection_id/dataStores/data_store_id or `projects/`project_number`/locations/`location_id`/collections/` collection_id`/engines/`engine_id.

  • filter (String) (defaults to: nil) —

    Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 996

def list_project_location_collection_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/controls', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse

Lists all Conversations by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection/dataStores/data_store_id``

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  • order_by (String) (defaults to: nil) —

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * update_time * create_time * conversation_name Example: "update_time desc" "create_time"

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListConversations call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1222

def list_project_location_collection_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1335

def list_project_location_collection_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1406

def list_project_location_collection_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_schema_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1664

def list_project_location_collection_data_store_schema_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSchemasResponse

Gets a list of Schemas.

Parameters:

  • parent (String) —

    Required. The parent data store resource name, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store`` .

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1554

def list_project_location_collection_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schemas', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSchemasResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSchemasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse

Lists all Sessions by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection/dataStores/data_store_id``

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  • order_by (String) (defaults to: nil) —

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * update_time * create_time * session_name Example: "update_time desc" "create_time"

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListSessions call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1928

def list_project_location_collection_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2255

def list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2548

def list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListTargetSitesResponse

Gets a list of TargetSites.

Parameters:

  • parent (String) —

    Required. The parent site search engine resource name, such as projects/ project/locations/location/collections/collection/dataStores/data_store/ siteSearchEngine. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2442

def list_project_location_collection_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/targetSites', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListTargetSitesResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListTargetSitesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDataStoresResponse

Lists all the DataStores associated with the project.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/project/ locations/location/collections/collection_id``. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

  • filter (String) (defaults to: nil) —

    Filter by solution type . For example: filter = 'solution_type: SOLUTION_TYPE_SEARCH'

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.

  • page_token (String) (defaults to: nil) —

    A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService. ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 411

def list_project_location_collection_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dataStores', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDataStoresResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDataStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse

Lists all Controls by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection_id/dataStores/data_store_id or `projects/`project_number`/locations/`location_id`/collections/` collection_id`/engines/`engine_id.

  • filter (String) (defaults to: nil) —

    Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3085

def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/controls', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_engine_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse

Lists all Conversations by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection/dataStores/data_store_id``

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  • order_by (String) (defaults to: nil) —

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * update_time * create_time * conversation_name Example: "update_time desc" "create_time"

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListConversations call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3311

def list_project_location_collection_engine_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3424

def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_engine_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse

Lists all Sessions by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection/dataStores/data_store_id``

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  • order_by (String) (defaults to: nil) —

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * update_time * create_time * session_name Example: "update_time desc" "create_time"

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListSessions call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3688

def list_project_location_collection_engine_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListEnginesResponse

Lists all the Engines associated with the project.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection_id``.

  • filter (String) (defaults to: nil) —

    Optional. Filter by solution type. For example: solution_type= SOLUTION_TYPE_SEARCH

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Not supported.

  • page_token (String) (defaults to: nil) —

    Optional. Not supported.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2890

def list_project_location_collection_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/engines', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListEnginesResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListEnginesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3832

def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDocumentsResponse

Gets a list of Documents.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch`. Usedefault_branchas the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED` error is returned.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

  • page_token (String) (defaults to: nil) —

    A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService. ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4333

def list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/documents', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDocumentsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDocumentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4525

def list_project_location_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse

Lists all Controls by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection_id/dataStores/data_store_id or `projects/`project_number`/locations/`location_id`/collections/` collection_id`/engines/`engine_id.

  • filter (String) (defaults to: nil) —

    Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4679

def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/controls', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse

Lists all Conversations by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection/dataStores/data_store_id``

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  • order_by (String) (defaults to: nil) —

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * update_time * create_time * conversation_name Example: "update_time desc" "create_time"

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListConversations call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4905

def list_project_location_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListConversationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5018

def list_project_location_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5089

def list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSchemasResponse

Gets a list of Schemas.

Parameters:

  • parent (String) —

    Required. The parent data store resource name, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store`` .

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5237

def list_project_location_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schemas', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSchemasResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSchemasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse

Lists all Sessions by their parent DataStore.

Parameters:

  • parent (String) —

    Required. The data store resource name. Format: projects/project_number/ locations/location_id/collections/collection/dataStores/data_store_id``

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  • order_by (String) (defaults to: nil) —

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * update_time * create_time * session_name Example: "update_time desc" "create_time"

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListSessions call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5540

def list_project_location_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListTargetSitesResponse

Gets a list of TargetSites.

Parameters:

  • parent (String) —

    Required. The parent site search engine resource name, such as projects/ project/locations/location/collections/collection/dataStores/data_store/ siteSearchEngine. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5902

def list_project_location_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/targetSites', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListTargetSitesResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListTargetSitesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDataStoresResponse

Lists all the DataStores associated with the project.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/project/ locations/location/collections/collection_id``. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

  • filter (String) (defaults to: nil) —

    Filter by solution type . For example: filter = 'solution_type: SOLUTION_TYPE_SEARCH'

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.

  • page_token (String) (defaults to: nil) —

    A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService. ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4094

def list_project_location_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dataStores', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDataStoresResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListDataStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6238

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6473

def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store(name, google_cloud_discoveryengine_v1_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore

Updates a DataStore

Parameters:

  • name (String) —

    Immutable. The full resource name of the data store. Format: projects/ project/locations/location/collections/collection_id/dataStores/ data_store_id``. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  • google_cloud_discoveryengine_v1_data_store_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 451

def patch_project_location_collection_data_store(name, google_cloud_discoveryengine_v1_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.request_object = google_cloud_discoveryengine_v1_data_store_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store_branch_document(name, google_cloud_discoveryengine_v1_document_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Updates a Document.

Parameters:

  • name (String) —

    Immutable. The full resource name of the document. Format: projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch/documents/document_id``. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  • google_cloud_discoveryengine_v1_document_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true and the Document is not found, a new Document is be created.

  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 691

def patch_project_location_collection_data_store_branch_document(name, google_cloud_discoveryengine_v1_document_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.request_object = google_cloud_discoveryengine_v1_document_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/dataStore/*/ controls/*

  • google_cloud_discoveryengine_v1_control_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1036

def patch_project_location_collection_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.request_object = google_cloud_discoveryengine_v1_control_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/project/locations/global/ collections/collection/dataStore/*/conversations/* or projects/project/ locations/global/collections/collection/engines/*/conversations/*.

  • google_cloud_discoveryengine_v1_conversation_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1264

def patch_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.request_object = google_cloud_discoveryengine_v1_conversation_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store_schema(name, google_cloud_discoveryengine_v1_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Updates a Schema.

Parameters:

  • name (String) —

    Immutable. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema``. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  • google_cloud_discoveryengine_v1_schema_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the Schema is not found, a new Schema is created. In this situation, update_mask is ignored.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1593

def patch_project_location_collection_data_store_schema(name, google_cloud_discoveryengine_v1_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
  command.request_object = google_cloud_discoveryengine_v1_schema_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/project/locations/global/ collections/collection/engines/engine/sessions/*

  • google_cloud_discoveryengine_v1_session_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1969

def patch_project_location_collection_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.request_object = google_cloud_discoveryengine_v1_session_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Updates a TargetSite.

Parameters:

  • name (String) —

    Output only. The fully qualified resource name of the target site. projects/ project/locations/location/collections/collection/dataStores/data_store/ siteSearchEngine/targetSites/target_site`Thetarget_site_id` is system- generated.

  • google_cloud_discoveryengine_v1_target_site_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2478

def patch_project_location_collection_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite::Representation
  command.request_object = google_cloud_discoveryengine_v1_target_site_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_engine(name, google_cloud_discoveryengine_v1_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine

Updates an Engine

Parameters:

  • name (String) —

    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/project_number/locations/location/collections/collection/ engines/engine`` engine should be 1-63 characters, and valid characters are / a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.

  • google_cloud_discoveryengine_v1_engine_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2931

def patch_project_location_collection_engine(name, google_cloud_discoveryengine_v1_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine::Representation
  command.request_object = google_cloud_discoveryengine_v1_engine_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_engine_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/dataStore/*/ controls/*

  • google_cloud_discoveryengine_v1_control_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3125

def patch_project_location_collection_engine_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.request_object = google_cloud_discoveryengine_v1_control_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/project/locations/global/ collections/collection/dataStore/*/conversations/* or projects/project/ locations/global/collections/collection/engines/*/conversations/*.

  • google_cloud_discoveryengine_v1_conversation_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3353

def patch_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.request_object = google_cloud_discoveryengine_v1_conversation_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_collection_engine_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/project/locations/global/ collections/collection/engines/engine/sessions/*

  • google_cloud_discoveryengine_v1_session_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3729

def patch_project_location_collection_engine_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.request_object = google_cloud_discoveryengine_v1_session_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store(name, google_cloud_discoveryengine_v1_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore

Updates a DataStore

Parameters:

  • name (String) —

    Immutable. The full resource name of the data store. Format: projects/ project/locations/location/collections/collection_id/dataStores/ data_store_id``. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  • google_cloud_discoveryengine_v1_data_store_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4134

def patch_project_location_data_store(name, google_cloud_discoveryengine_v1_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.request_object = google_cloud_discoveryengine_v1_data_store_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1_document_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Updates a Document.

Parameters:

  • name (String) —

    Immutable. The full resource name of the document. Format: projects/project/ locations/location/collections/collection/dataStores/data_store/branches/ branch/documents/document_id``. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  • google_cloud_discoveryengine_v1_document_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true and the Document is not found, a new Document is be created.

  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4374

def patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1_document_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.request_object = google_cloud_discoveryengine_v1_document_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/dataStore/*/ controls/*

  • google_cloud_discoveryengine_v1_control_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4719

def patch_project_location_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.request_object = google_cloud_discoveryengine_v1_control_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/project/locations/global/ collections/collection/dataStore/*/conversations/* or projects/project/ locations/global/collections/collection/engines/*/conversations/*.

  • google_cloud_discoveryengine_v1_conversation_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4947

def patch_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.request_object = google_cloud_discoveryengine_v1_conversation_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store_schema(name, google_cloud_discoveryengine_v1_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Updates a Schema.

Parameters:

  • name (String) —

    Immutable. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema``. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  • google_cloud_discoveryengine_v1_schema_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the Schema is not found, a new Schema is created. In this situation, update_mask is ignored.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5276

def patch_project_location_data_store_schema(name, google_cloud_discoveryengine_v1_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema::Representation
  command.request_object = google_cloud_discoveryengine_v1_schema_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/project/locations/global/ collections/collection/engines/engine/sessions/*

  • google_cloud_discoveryengine_v1_session_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5581

def patch_project_location_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.request_object = google_cloud_discoveryengine_v1_session_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Updates a TargetSite.

Parameters:

  • name (String) —

    Output only. The fully qualified resource name of the target site. projects/ project/locations/location/collections/collection/dataStores/data_store/ siteSearchEngine/targetSites/target_site`Thetarget_site_id` is system- generated.

  • google_cloud_discoveryengine_v1_target_site_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5938

def patch_project_location_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TargetSite::Representation
  command.request_object = google_cloud_discoveryengine_v1_target_site_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#provision_project(name, google_cloud_discoveryengine_v1_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the Terms for data use, and optionally specify in request to provide consent to that service terms.

Parameters:

  • name (String) —

    Required. Full resource name of a Project, such as projects/ project_id_or_number``.

  • google_cloud_discoveryengine_v1_provision_project_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 79

def provision_project(name, google_cloud_discoveryengine_v1_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:provision', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_provision_project_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection/dataStores/data_store/branches/branch``.

  • google_cloud_discoveryengine_v1_purge_documents_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 732

def purge_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/documents:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_documents_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_collection_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Permanently deletes all SuggestionDenyListEntry for a DataStore.

Parameters:

  • parent (String) —

    Required. The parent data store resource name for which to import denylist entries. Follows pattern projects//locations//collections//dataStores/.

  • google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2617

def purge_project_location_collection_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/suggestionDenyListEntries:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.

Parameters:

  • parent (String) —

    Required. The parent resource name, such as projects/project/locations/ location/collections/collection/dataStores/data_store/branches/branch``.

  • google_cloud_discoveryengine_v1_purge_documents_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4415

def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/documents:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_documents_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Permanently deletes all SuggestionDenyListEntry for a DataStore.

Parameters:

  • parent (String) —

    Required. The parent data store resource name for which to import denylist entries. Follows pattern projects//locations//collections//dataStores/.

  • google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6006

def purge_project_location_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/suggestionDenyListEntries:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_suggestion_deny_list_entries_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1_rank_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse

Ranks a list of text records based on the given input query.

Parameters:

  • ranking_config (String) —

    Required. The resource name of the rank service config, such as projects/ project_num/locations/location_id/rankingConfigs/default_ranking_config.

  • google_cloud_discoveryengine_v1_rank_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6273

def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+rankingConfig}:rank', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_rank_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse
  command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse

Makes a recommendation, which requires a contextual user event.

Parameters:

  • serving_config (String) —

    Required. Full resource name of a ServingConfig: projects/*/locations/global/ collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/ collections/*/dataStores/*/servingConfigs/* One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine projects/*/ locations/global/collections/*/engines/my-engine, you can use projects/*/ locations/global/collections/*/engines/my-engine/servingConfigs/my-engine for your RecommendationService.Recommend requests.

  • google_cloud_discoveryengine_v1_recommend_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1743

def recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:recommend', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_recommend_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse

Makes a recommendation, which requires a contextual user event.

Parameters:

  • serving_config (String) —

    Required. Full resource name of a ServingConfig: projects/*/locations/global/ collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/ collections/*/dataStores/*/servingConfigs/* One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine projects/*/ locations/global/collections/*/engines/my-engine, you can use projects/*/ locations/global/collections/*/engines/my-engine/servingConfigs/my-engine for your RecommendationService.Recommend requests.

  • google_cloud_discoveryengine_v1_recommend_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3503

def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:recommend', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_recommend_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#recommend_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse

Makes a recommendation, which requires a contextual user event.

Parameters:

  • serving_config (String) —

    Required. Full resource name of a ServingConfig: projects/*/locations/global/ collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/ collections/*/dataStores/*/servingConfigs/* One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine projects/*/ locations/global/collections/*/engines/my-engine, you can use projects/*/ locations/global/collections/*/engines/my-engine/servingConfigs/my-engine for your RecommendationService.Recommend requests.

  • google_cloud_discoveryengine_v1_recommend_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5355

def recommend_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:recommend', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_recommend_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Request on-demand recrawl for a list of URIs.

Parameters:

  • site_search_engine (String) —

    Required. Full resource name of the SiteSearchEngine, such as projects/*/ locations/*/collections/*/dataStores/*/siteSearchEngine.

  • google_cloud_discoveryengine_v1_recrawl_uris_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecrawlUrisRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2185

def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+siteSearchEngine}:recrawlUris', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecrawlUrisRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_recrawl_uris_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#recrawl_project_location_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Request on-demand recrawl for a list of URIs.

Parameters:

  • site_search_engine (String) —

    Required. Full resource name of the SiteSearchEngine, such as projects/*/ locations/*/collections/*/dataStores/*/siteSearchEngine.

  • google_cloud_discoveryengine_v1_recrawl_uris_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecrawlUrisRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5716

def recrawl_project_location_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+siteSearchEngine}:recrawlUris', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecrawlUrisRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_recrawl_uris_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_collection_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse

Performs a search.

Parameters:

  • serving_config (String) —

    Required. The resource name of the Search serving config, such as projects/*/ locations/global/collections/default_collection/engines/*/servingConfigs/ default_serving_config, or projects/*/locations/global/collections/ default_collection/dataStores/default_data_store/servingConfigs/ default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

  • google_cloud_discoveryengine_v1_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1781

def search_project_location_collection_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:search', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse

Performs a search.

Parameters:

  • serving_config (String) —

    Required. The resource name of the Search serving config, such as projects/*/ locations/global/collections/default_collection/engines/*/servingConfigs/ default_serving_config, or projects/*/locations/global/collections/ default_collection/dataStores/default_data_store/servingConfigs/ default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

  • google_cloud_discoveryengine_v1_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3541

def search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:search', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse

Performs a search.

Parameters:

  • serving_config (String) —

    Required. The resource name of the Search serving config, such as projects/*/ locations/global/collections/default_collection/engines/*/servingConfigs/ default_serving_config, or projects/*/locations/global/collections/ default_collection/dataStores/default_data_store/servingConfigs/ default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

  • google_cloud_discoveryengine_v1_search_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5393

def search_project_location_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+servingConfig}:search', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_search_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent

Writes a single user event.

Parameters:

  • parent (String) —

    Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/project/locations/location/ collections/collection/dataStores/data_store. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/`project`/locations/` location.

  • google_cloud_discoveryengine_v1_user_event_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent) (defaults to: nil)
  • write_async (Boolean) (defaults to: nil) —

    If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2744

def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
  command.params['parent'] = parent unless parent.nil?
  command.query['writeAsync'] = write_async unless write_async.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent

Writes a single user event.

Parameters:

  • parent (String) —

    Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/project/locations/location/ collections/collection/dataStores/data_store. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/`project`/locations/` location.

  • google_cloud_discoveryengine_v1_user_event_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent) (defaults to: nil)
  • write_async (Boolean) (defaults to: nil) —

    If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6133

def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
  command.params['parent'] = parent unless parent.nil?
  command.query['writeAsync'] = write_async unless write_async.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_project_location_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent

Writes a single user event.

Parameters:

  • parent (String) —

    Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/project/locations/location/ collections/collection/dataStores/data_store. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/`project`/locations/` location.

  • google_cloud_discoveryengine_v1_user_event_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent) (defaults to: nil)
  • write_async (Boolean) (defaults to: nil) —

    If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
 
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6362

def write_project_location_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
  command.params['parent'] = parent unless parent.nil?
  command.query['writeAsync'] = write_async unless write_async.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end