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

#initializeDiscoveryEngineService

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

#keyString

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_userString

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



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1892

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



3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3688

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



5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5661

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_branch_get_documents_metadata(parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse

Gets index freshness metadata for Documents. Supported for website search only.

Parameters:

  • parent (String)

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

  • matcher_fhir_matcher_fhir_resources (Array<String>, String) (defaults to: nil)

    Required. The FHIR resources to match by. Format: projects/project/locations/ location/datasets/dataset/fhirStores/fhir_store/fhir/resource_type/ fhir_resource_id

  • matcher_uris_matcher_uris (Array<String>, String) (defaults to: nil)

    The exact URIs to match by.

  • 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



541
542
543
544
545
546
547
548
549
550
551
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 541

def (parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/batchGetDocumentsMetadata', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['matcher.fhirMatcher.fhirResources'] = matcher_fhir_matcher_fhir_resources unless matcher_fhir_matcher_fhir_resources.nil?
  command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.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



2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2480

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



2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2226

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_branch_get_documents_metadata(parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse

Gets index freshness metadata for Documents. Supported for website search only.

Parameters:

  • parent (String)

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

  • matcher_fhir_matcher_fhir_resources (Array<String>, String) (defaults to: nil)

    Required. The FHIR resources to match by. Format: projects/project/locations/ location/datasets/dataset/fhirStores/fhir_store/fhir/resource_type/ fhir_resource_id

  • matcher_uris_matcher_uris (Array<String>, String) (defaults to: nil)

    The exact URIs to match by.

  • 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



4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4413

def (parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/batchGetDocumentsMetadata', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['matcher.fhirMatcher.fhirResources'] = matcher_fhir_matcher_fhir_resources unless matcher_fhir_matcher_fhir_resources.nil?
  command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.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



6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6097

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



861
862
863
864
865
866
867
868
869
870
871
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 861

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



4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4733

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



6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6857

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



6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6551

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



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

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



6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6398

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



6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6774

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



4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4118

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/locations/location/collections/collection/dataStores/ data_store_id/conversations/conversation_id`. Useprojects/project/ locations/location/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



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1233

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/locations/location/collections/collection/dataStores/ data_store_id/conversations/conversation_id`. Useprojects/project/ locations/location/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



3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3390

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/locations/location/collections/collection/dataStores/ data_store_id/conversations/conversation_id`. Useprojects/project/ locations/location/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



5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5105

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, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: 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)
  • cmek_config_name (String) (defaults to: nil)

    Resource name of the CmekConfig to use for protecting this DataStore.

  • 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.

  • disable_cmek (Boolean) (defaults to: nil)

    DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

  • skip_default_schema_creation (Boolean) (defaults to: nil)

    A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if data_store.starting_schema is specified.

  • 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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 270

def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: 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['cmekConfigName'] = cmek_config_name unless cmek_config_name.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['disableCmek'] = disable_cmek unless disable_cmek.nil?
  command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.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



584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 584

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/ locations/location/collections/collection_id/dataStores/data_store_id or `projects/`project`/locations/`location`/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



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1043

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/ locations/location/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



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1268

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



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1635

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/ locations/location/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



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

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



2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2515

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



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

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/ locations/location/collections/collection_id/dataStores/data_store_id or `projects/`project`/locations/`location`/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



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

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/ locations/location/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



3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3425

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/ locations/location/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



3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3801

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, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: 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)
  • cmek_config_name (String) (defaults to: nil)

    Resource name of the CmekConfig to use for protecting this DataStore.

  • 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.

  • disable_cmek (Boolean) (defaults to: nil)

    DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

  • skip_default_schema_creation (Boolean) (defaults to: nil)

    A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if data_store.starting_schema is specified.

  • 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



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

def create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: 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['cmekConfigName'] = cmek_config_name unless cmek_config_name.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['disableCmek'] = disable_cmek unless disable_cmek.nil?
  command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.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



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

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/ locations/location/collections/collection_id/dataStores/data_store_id or `projects/`project`/locations/`location`/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



4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4915

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/ locations/location/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



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5140

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



5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5475

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/ locations/location/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



5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5774

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



6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6132

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



311
312
313
314
315
316
317
318
319
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 311

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



622
623
624
625
626
627
628
629
630
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 622

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/locations/location/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



1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1079

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/locations/location/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



1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1303

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



1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1670

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/locations/location/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



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

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



2552
2553
2554
2555
2556
2557
2558
2559
2560
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2552

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



3047
3048
3049
3050
3051
3052
3053
3054
3055
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3047

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/locations/location/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



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

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/locations/location/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



3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3460

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/locations/location/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



3836
3837
3838
3839
3840
3841
3842
3843
3844
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3836

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



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

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



4494
4495
4496
4497
4498
4499
4500
4501
4502
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4494

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/locations/location/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



4951
4952
4953
4954
4955
4956
4957
4958
4959
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4951

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/locations/location/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



5175
5176
5177
5178
5179
5180
5181
5182
5183
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5175

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



5510
5511
5512
5513
5514
5515
5516
5517
5518
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5510

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/locations/location/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



5809
5810
5811
5812
5813
5814
5815
5816
5817
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5809

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



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

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



2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2260

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



5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5993

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



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

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



6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6027

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



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2339

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



345
346
347
348
349
350
351
352
353
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 345

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



657
658
659
660
661
662
663
664
665
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 657

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



894
895
896
897
898
899
900
901
902
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 894

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/ locations/location/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



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

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/locations/location/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



1335
1336
1337
1338
1339
1340
1341
1342
1343
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1335

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



1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1487

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



1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1558

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



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

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



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

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/ locations/location/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



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

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/ locations/location/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



2192
2193
2194
2195
2196
2197
2198
2199
2200
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2192

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



379
380
381
382
383
384
385
386
387
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 379

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



2406
2407
2408
2409
2410
2411
2412
2413
2414
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2406

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



2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2587

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



2699
2700
2701
2702
2703
2704
2705
2706
2707
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2699

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



3078
3079
3080
3081
3082
3083
3084
3085
3086
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3078

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/ locations/location/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



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

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/locations/location/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



3492
3493
3494
3495
3496
3497
3498
3499
3500
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3492

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



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

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/ locations/location/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



3868
3869
3870
3871
3872
3873
3874
3875
3876
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3868

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/ locations/location/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



3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3988

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



4019
4020
4021
4022
4023
4024
4025
4026
4027
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4019

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



4252
4253
4254
4255
4256
4257
4258
4259
4260
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4252

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



4529
4530
4531
4532
4533
4534
4535
4536
4537
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4529

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



4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4766

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/ locations/location/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



4983
4984
4985
4986
4987
4988
4989
4990
4991
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4983

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/locations/location/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



5207
5208
5209
5210
5211
5212
5213
5214
5215
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5207

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



5327
5328
5329
5330
5331
5332
5333
5334
5335
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5327

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



5398
5399
5400
5401
5402
5403
5404
5405
5406
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5398

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



5542
5543
5544
5545
5546
5547
5548
5549
5550
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5542

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/ locations/location/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



5841
5842
5843
5844
5845
5846
5847
5848
5849
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5841

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/ locations/location/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



5961
5962
5963
5964
5965
5966
5967
5968
5969
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5961

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



4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4286

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



6204
6205
6206
6207
6208
6209
6210
6211
6212
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6204

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_identity_mapping_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



6584
6585
6586
6587
6588
6589
6590
6591
6592
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6584

def get_project_location_identity_mapping_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_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



6655
6656
6657
6658
6659
6660
6661
6662
6663
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6655

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



6890
6891
6892
6893
6894
6895
6896
6897
6898
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6890

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



692
693
694
695
696
697
698
699
700
701
702
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 692

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_completion_suggestion(parent, google_cloud_discoveryengine_v1_import_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Imports CompletionSuggestions for a DataStore.

Parameters:

  • parent (String)

    Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern projects/*/locations/*/collections/* /dataStores/*

  • google_cloud_discoveryengine_v1_import_completion_suggestions_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest) (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



967
968
969
970
971
972
973
974
975
976
977
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 967

def import_project_location_collection_data_store_completion_suggestion(parent, google_cloud_discoveryengine_v1_import_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/completionSuggestions:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_completion_suggestions_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



2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2771

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



2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2891

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



4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4564

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_completion_suggestion(parent, google_cloud_discoveryengine_v1_import_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Imports CompletionSuggestions for a DataStore.

Parameters:

  • parent (String)

    Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern projects/*/locations/*/collections/* /dataStores/*

  • google_cloud_discoveryengine_v1_import_completion_suggestions_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest) (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



4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4839

def import_project_location_data_store_completion_suggestion(parent, google_cloud_discoveryengine_v1_import_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/completionSuggestions:import', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_import_completion_suggestions_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



6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6317

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



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6437

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



739
740
741
742
743
744
745
746
747
748
749
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 739

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



931
932
933
934
935
936
937
938
939
940
941
942
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 931

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/locations/ location/collections/collection_id/dataStores/data_store_idor `projects/ `project`/locations/`location`/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



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1154

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/locations/ location/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



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1379

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_custom_models(data_store, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse

Gets a list of all the custom models.

Parameters:

  • data_store (String)

    Required. The resource name of the parent Data Store, such as projects/*/ locations/global/collections/default_collection/dataStores/default_data_store. This field is used to identify the data store where to fetch the models from.

  • 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



1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1456

def list_project_location_collection_data_store_custom_models(data_store, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+dataStore}/customModels', options)
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListCustomModelsResponse
  command.params['dataStore'] = data_store unless data_store.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



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1524

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



1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1595

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



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

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



1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1743

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/locations/ location/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



2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2116

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



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2443

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



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2736

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



2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2630

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



425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 425

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/locations/ location/collections/collection_id/dataStores/data_store_idor `projects/ `project`/locations/`location`/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



3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3311

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/locations/ location/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



3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3536

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



3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3649

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/locations/ location/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



3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3912

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



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3116

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



4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4056

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



4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4611

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



4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4803

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/locations/ location/collections/collection_id/dataStores/data_store_idor `projects/ `project`/locations/`location`/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



5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5026

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/locations/ location/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



5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5251

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



5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5364

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



5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5435

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



5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5583

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/locations/ location/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



5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5885

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



6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6247

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



4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4332

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_identity_mapping_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



6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6621

def list_project_location_identity_mapping_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_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



6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6692

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



6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6927

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



465
466
467
468
469
470
471
472
473
474
475
476
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 465

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



780
781
782
783
784
785
786
787
788
789
790
791
792
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 780

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



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1194

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



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1421

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



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1782

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



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2157

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



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

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/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



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3157

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



3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3351

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



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

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



3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3953

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



4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4372

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



4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4652

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



5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5066

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



5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5293

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



5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5622

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



5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5926

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



6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6283

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



821
822
823
824
825
826
827
828
829
830
831
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 821

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_completion_suggestion(parent, google_cloud_discoveryengine_v1_purge_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Permanently deletes all CompletionSuggestions for a DataStore.

Parameters:

  • parent (String)

    Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects//locations//collections//dataStores/.

  • google_cloud_discoveryengine_v1_purge_completion_suggestions_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest) (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



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1001

def purge_project_location_collection_data_store_completion_suggestion(parent, google_cloud_discoveryengine_v1_purge_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/completionSuggestions:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_completion_suggestions_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



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2805

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_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

Parameters:

  • parent (String)

    Required. The resource name of the catalog under which the events are created. The format is projects/project/locations/global/collections/collection/ dataStores/dataStore``.

  • google_cloud_discoveryengine_v1_purge_user_events_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest) (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



2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2929

def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_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

#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



4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4693

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_completion_suggestion(parent, google_cloud_discoveryengine_v1_purge_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Permanently deletes all CompletionSuggestions for a DataStore.

Parameters:

  • parent (String)

    Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects//locations//collections//dataStores/.

  • google_cloud_discoveryengine_v1_purge_completion_suggestions_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest) (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



4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 4873

def purge_project_location_data_store_completion_suggestion(parent, google_cloud_discoveryengine_v1_purge_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/completionSuggestions:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_completion_suggestions_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



6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6351

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

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

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

Parameters:

  • parent (String)

    Required. The resource name of the catalog under which the events are created. The format is projects/project/locations/global/collections/collection/ dataStores/dataStore``.

  • google_cloud_discoveryengine_v1_purge_user_events_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest) (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



6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6475

def purge_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:purge', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_purge_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

#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/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



6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6727

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



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1932

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



3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3728

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



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5701

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



2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2373

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



6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6061

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



1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 1970

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



3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 3766

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



5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 5739

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

#train_project_location_collection_data_store_custom_model(data_store, google_cloud_discoveryengine_v1_train_custom_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation

Trains a custom model.

Parameters:

  • data_store (String)

    Required. The resource name of the Data Store, such as projects/*/locations/ global/collections/default_collection/dataStores/default_data_store. This field is used to identify the data store where to train the models.

  • google_cloud_discoveryengine_v1_train_custom_model_request_object (Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequest) (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



501
502
503
504
505
506
507
508
509
510
511
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 501

def train_project_location_collection_data_store_custom_model(data_store, google_cloud_discoveryengine_v1_train_custom_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+dataStore}:trainCustomModel', options)
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TrainCustomModelRequest::Representation
  command.request_object = google_cloud_discoveryengine_v1_train_custom_model_request_object
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
  command.params['dataStore'] = data_store unless data_store.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



2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 2970

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



6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6516

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



6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
# File 'lib/google/apis/discoveryengine_v1/service.rb', line 6816

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