Namespace google::cloud::discoveryengine_v1 (2.27.0-rc)

Classes

CompletionServiceClient

Service for Auto-Completion.

CompletionServiceConnection

The CompletionServiceConnection object for CompletionServiceClient.

CompletionServiceConnectionIdempotencyPolicy

CompletionServiceLimitedErrorCountRetryPolicy

A retry policy for CompletionServiceConnection based on counting errors.

CompletionServiceLimitedTimeRetryPolicy

A retry policy for CompletionServiceConnection based on elapsed time.

CompletionServiceRetryPolicy

The retry policy for CompletionServiceConnection.

ControlServiceClient

Service for performing CRUD operations on Controls.

ControlServiceConnection

The ControlServiceConnection object for ControlServiceClient.

ControlServiceConnectionIdempotencyPolicy

ControlServiceLimitedErrorCountRetryPolicy

A retry policy for ControlServiceConnection based on counting errors.

ControlServiceLimitedTimeRetryPolicy

A retry policy for ControlServiceConnection based on elapsed time.

ControlServiceRetryPolicy

The retry policy for ControlServiceConnection.

ConversationalSearchServiceClient

Service for conversational search.

ConversationalSearchServiceConnection

The ConversationalSearchServiceConnection object for ConversationalSearchServiceClient.

ConversationalSearchServiceConnectionIdempotencyPolicy

ConversationalSearchServiceLimitedErrorCountRetryPolicy

A retry policy for ConversationalSearchServiceConnection based on counting errors.

ConversationalSearchServiceLimitedTimeRetryPolicy

A retry policy for ConversationalSearchServiceConnection based on elapsed time.

ConversationalSearchServiceRetryPolicy

The retry policy for ConversationalSearchServiceConnection.

DataStoreServiceClient

Service for managing DataStore configuration.

DataStoreServiceConnection

The DataStoreServiceConnection object for DataStoreServiceClient.

DataStoreServiceConnectionIdempotencyPolicy

DataStoreServiceLimitedErrorCountRetryPolicy

A retry policy for DataStoreServiceConnection based on counting errors.

DataStoreServiceLimitedTimeRetryPolicy

A retry policy for DataStoreServiceConnection based on elapsed time.

DataStoreServiceRetryPolicy

The retry policy for DataStoreServiceConnection.

DocumentServiceClient

Service for ingesting Document information of the customer's website.

DocumentServiceConnection

The DocumentServiceConnection object for DocumentServiceClient.

DocumentServiceConnectionIdempotencyPolicy

DocumentServiceLimitedErrorCountRetryPolicy

A retry policy for DocumentServiceConnection based on counting errors.

DocumentServiceLimitedTimeRetryPolicy

A retry policy for DocumentServiceConnection based on elapsed time.

DocumentServiceRetryPolicy

The retry policy for DocumentServiceConnection.

EngineServiceClient

Service for managing Engine configuration.

EngineServiceConnection

The EngineServiceConnection object for EngineServiceClient.

EngineServiceConnectionIdempotencyPolicy

EngineServiceLimitedErrorCountRetryPolicy

A retry policy for EngineServiceConnection based on counting errors.

EngineServiceLimitedTimeRetryPolicy

A retry policy for EngineServiceConnection based on elapsed time.

EngineServiceRetryPolicy

The retry policy for EngineServiceConnection.

GroundedGenerationServiceClient

Service for grounded generation.

GroundedGenerationServiceConnection

The GroundedGenerationServiceConnection object for GroundedGenerationServiceClient.

GroundedGenerationServiceConnectionIdempotencyPolicy

GroundedGenerationServiceLimitedErrorCountRetryPolicy

A retry policy for GroundedGenerationServiceConnection based on counting errors.

GroundedGenerationServiceLimitedTimeRetryPolicy

A retry policy for GroundedGenerationServiceConnection based on elapsed time.

GroundedGenerationServiceRetryPolicy

The retry policy for GroundedGenerationServiceConnection.

ProjectServiceClient

Service for operations on the Project.

ProjectServiceConnection

The ProjectServiceConnection object for ProjectServiceClient.

ProjectServiceConnectionIdempotencyPolicy

ProjectServiceLimitedErrorCountRetryPolicy

A retry policy for ProjectServiceConnection based on counting errors.

ProjectServiceLimitedTimeRetryPolicy

A retry policy for ProjectServiceConnection based on elapsed time.

ProjectServiceRetryPolicy

The retry policy for ProjectServiceConnection.

RankServiceClient

Service for ranking text records.

RankServiceConnection

The RankServiceConnection object for RankServiceClient.

RankServiceConnectionIdempotencyPolicy

RankServiceLimitedErrorCountRetryPolicy

A retry policy for RankServiceConnection based on counting errors.

RankServiceLimitedTimeRetryPolicy

A retry policy for RankServiceConnection based on elapsed time.

RankServiceRetryPolicy

The retry policy for RankServiceConnection.

RecommendationServiceClient

Service for making recommendations.

RecommendationServiceConnection

The RecommendationServiceConnection object for RecommendationServiceClient.

RecommendationServiceConnectionIdempotencyPolicy

RecommendationServiceLimitedErrorCountRetryPolicy

A retry policy for RecommendationServiceConnection based on counting errors.

RecommendationServiceLimitedTimeRetryPolicy

A retry policy for RecommendationServiceConnection based on elapsed time.

RecommendationServiceRetryPolicy

The retry policy for RecommendationServiceConnection.

SchemaServiceClient

Service for managing Schemas.

SchemaServiceConnection

The SchemaServiceConnection object for SchemaServiceClient.

SchemaServiceConnectionIdempotencyPolicy

SchemaServiceLimitedErrorCountRetryPolicy

A retry policy for SchemaServiceConnection based on counting errors.

SchemaServiceLimitedTimeRetryPolicy

A retry policy for SchemaServiceConnection based on elapsed time.

SchemaServiceRetryPolicy

The retry policy for SchemaServiceConnection.

SearchServiceClient

Service for search.

SearchServiceConnection

The SearchServiceConnection object for SearchServiceClient.

SearchServiceConnectionIdempotencyPolicy

SearchServiceLimitedErrorCountRetryPolicy

A retry policy for SearchServiceConnection based on counting errors.

SearchServiceLimitedTimeRetryPolicy

A retry policy for SearchServiceConnection based on elapsed time.

SearchServiceRetryPolicy

The retry policy for SearchServiceConnection.

SiteSearchEngineServiceClient

Service for managing site search related resources.

SiteSearchEngineServiceConnection

The SiteSearchEngineServiceConnection object for SiteSearchEngineServiceClient.

SiteSearchEngineServiceConnectionIdempotencyPolicy

SiteSearchEngineServiceLimitedErrorCountRetryPolicy

A retry policy for SiteSearchEngineServiceConnection based on counting errors.

SiteSearchEngineServiceLimitedTimeRetryPolicy

A retry policy for SiteSearchEngineServiceConnection based on elapsed time.

SiteSearchEngineServiceRetryPolicy

The retry policy for SiteSearchEngineServiceConnection.

UserEventServiceClient

Service for ingesting end user actions on a website to Discovery Engine API.

UserEventServiceConnection

The UserEventServiceConnection object for UserEventServiceClient.

UserEventServiceConnectionIdempotencyPolicy

UserEventServiceLimitedErrorCountRetryPolicy

A retry policy for UserEventServiceConnection based on counting errors.

UserEventServiceLimitedTimeRetryPolicy

A retry policy for UserEventServiceConnection based on elapsed time.

UserEventServiceRetryPolicy

The retry policy for UserEventServiceConnection.

Structs

CompletionServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

CompletionServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

CompletionServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

CompletionServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

ControlServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

ControlServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

ControlServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

ConversationalSearchServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

ConversationalSearchServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

ConversationalSearchServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

DataStoreServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

DataStoreServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

DataStoreServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

DataStoreServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

DocumentServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

DocumentServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

DocumentServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

DocumentServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

EngineServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

EngineServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

EngineServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

EngineServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

GroundedGenerationServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

GroundedGenerationServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

GroundedGenerationServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

ProjectServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

ProjectServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

ProjectServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

ProjectServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

RankServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

RankServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

RankServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

RecommendationServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

RecommendationServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

RecommendationServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

SchemaServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

SchemaServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

SchemaServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

SchemaServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

SearchServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

SearchServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

SearchServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

SiteSearchEngineServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

SiteSearchEngineServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

SiteSearchEngineServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

SiteSearchEngineServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

UserEventServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

UserEventServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

UserEventServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

UserEventServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

Functions

MakeCompletionServiceConnection(Options)

A factory function to construct an object of type CompletionServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of CompletionServiceClient.

The optional options argument may be used to configure aspects of the returned CompletionServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the CompletionServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< CompletionServiceConnection >

MakeDefaultCompletionServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< CompletionServiceConnectionIdempotencyPolicy >

MakeControlServiceConnection(Options)

A factory function to construct an object of type ControlServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of ControlServiceClient.

The optional options argument may be used to configure aspects of the returned ControlServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the ControlServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< ControlServiceConnection >

MakeDefaultControlServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< ControlServiceConnectionIdempotencyPolicy >

MakeConversationalSearchServiceConnection(Options)

A factory function to construct an object of type ConversationalSearchServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of ConversationalSearchServiceClient.

The optional options argument may be used to configure aspects of the returned ConversationalSearchServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the ConversationalSearchServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< ConversationalSearchServiceConnection >

MakeDefaultConversationalSearchServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< ConversationalSearchServiceConnectionIdempotencyPolicy >

MakeDataStoreServiceConnection(Options)

A factory function to construct an object of type DataStoreServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of DataStoreServiceClient.

The optional options argument may be used to configure aspects of the returned DataStoreServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the DataStoreServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< DataStoreServiceConnection >

MakeDefaultDataStoreServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< DataStoreServiceConnectionIdempotencyPolicy >

MakeDocumentServiceConnection(Options)

A factory function to construct an object of type DocumentServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of DocumentServiceClient.

The optional options argument may be used to configure aspects of the returned DocumentServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the DocumentServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< DocumentServiceConnection >

MakeDefaultDocumentServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< DocumentServiceConnectionIdempotencyPolicy >

MakeEngineServiceConnection(Options)

A factory function to construct an object of type EngineServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of EngineServiceClient.

The optional options argument may be used to configure aspects of the returned EngineServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the EngineServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< EngineServiceConnection >

MakeDefaultEngineServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< EngineServiceConnectionIdempotencyPolicy >

MakeGroundedGenerationServiceConnection(Options)

A factory function to construct an object of type GroundedGenerationServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of GroundedGenerationServiceClient.

The optional options argument may be used to configure aspects of the returned GroundedGenerationServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the GroundedGenerationServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< GroundedGenerationServiceConnection >

MakeDefaultGroundedGenerationServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< GroundedGenerationServiceConnectionIdempotencyPolicy >

MakeProjectServiceConnection(Options)

A factory function to construct an object of type ProjectServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of ProjectServiceClient.

The optional options argument may be used to configure aspects of the returned ProjectServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the ProjectServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< ProjectServiceConnection >

MakeDefaultProjectServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< ProjectServiceConnectionIdempotencyPolicy >

MakeRankServiceConnection(Options)

A factory function to construct an object of type RankServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of RankServiceClient.

The optional options argument may be used to configure aspects of the returned RankServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the RankServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< RankServiceConnection >

MakeDefaultRankServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< RankServiceConnectionIdempotencyPolicy >

MakeRecommendationServiceConnection(Options)

A factory function to construct an object of type RecommendationServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of RecommendationServiceClient.

The optional options argument may be used to configure aspects of the returned RecommendationServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the RecommendationServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< RecommendationServiceConnection >

MakeDefaultRecommendationServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< RecommendationServiceConnectionIdempotencyPolicy >

MakeSchemaServiceConnection(Options)

A factory function to construct an object of type SchemaServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of SchemaServiceClient.

The optional options argument may be used to configure aspects of the returned SchemaServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the SchemaServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< SchemaServiceConnection >

MakeDefaultSchemaServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< SchemaServiceConnectionIdempotencyPolicy >

MakeSearchServiceConnection(Options)

A factory function to construct an object of type SearchServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of SearchServiceClient.

The optional options argument may be used to configure aspects of the returned SearchServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the SearchServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< SearchServiceConnection >

MakeDefaultSearchServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< SearchServiceConnectionIdempotencyPolicy >

MakeSiteSearchEngineServiceConnection(Options)

A factory function to construct an object of type SiteSearchEngineServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of SiteSearchEngineServiceClient.

The optional options argument may be used to configure aspects of the returned SiteSearchEngineServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the SiteSearchEngineServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< SiteSearchEngineServiceConnection >

MakeDefaultSiteSearchEngineServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< SiteSearchEngineServiceConnectionIdempotencyPolicy >

MakeUserEventServiceConnection(Options)

A factory function to construct an object of type UserEventServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of UserEventServiceClient.

The optional options argument may be used to configure aspects of the returned UserEventServiceConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the UserEventServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< UserEventServiceConnection >

MakeDefaultUserEventServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< UserEventServiceConnectionIdempotencyPolicy >