Namespace google::cloud::retail_v2 (2.17.0)

Classes

CatalogServiceClient

Service for managing catalog configuration.

CatalogServiceConnection

The CatalogServiceConnection object for CatalogServiceClient.

CatalogServiceConnectionIdempotencyPolicy

CatalogServiceLimitedErrorCountRetryPolicy

A retry policy for CatalogServiceConnection based on counting errors.

CatalogServiceLimitedTimeRetryPolicy

A retry policy for CatalogServiceConnection based on elapsed time.

CatalogServiceRetryPolicy

The retry policy for CatalogServiceConnection.

CompletionServiceClient

Autocomplete service for retail.

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 modifying Control.

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.

ModelServiceClient

Service for performing CRUD operations on models.

ModelServiceConnection

The ModelServiceConnection object for ModelServiceClient.

ModelServiceConnectionIdempotencyPolicy

ModelServiceLimitedErrorCountRetryPolicy

A retry policy for ModelServiceConnection based on counting errors.

ModelServiceLimitedTimeRetryPolicy

A retry policy for ModelServiceConnection based on elapsed time.

ModelServiceRetryPolicy

The retry policy for ModelServiceConnection.

PredictionServiceClient

Service for making recommendation prediction.

PredictionServiceConnection

The PredictionServiceConnection object for PredictionServiceClient.

PredictionServiceConnectionIdempotencyPolicy

PredictionServiceLimitedErrorCountRetryPolicy

A retry policy for PredictionServiceConnection based on counting errors.

PredictionServiceLimitedTimeRetryPolicy

A retry policy for PredictionServiceConnection based on elapsed time.

PredictionServiceRetryPolicy

The retry policy for PredictionServiceConnection.

ProductServiceClient

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

ProductServiceConnection

The ProductServiceConnection object for ProductServiceClient.

ProductServiceConnectionIdempotencyPolicy

ProductServiceLimitedErrorCountRetryPolicy

A retry policy for ProductServiceConnection based on counting errors.

ProductServiceLimitedTimeRetryPolicy

A retry policy for ProductServiceConnection based on elapsed time.

ProductServiceRetryPolicy

The retry policy for ProductServiceConnection.

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.

ServingConfigServiceClient

Service for modifying ServingConfig.

ServingConfigServiceConnection

The ServingConfigServiceConnection object for ServingConfigServiceClient.

ServingConfigServiceConnectionIdempotencyPolicy

ServingConfigServiceLimitedErrorCountRetryPolicy

A retry policy for ServingConfigServiceConnection based on counting errors.

ServingConfigServiceLimitedTimeRetryPolicy

A retry policy for ServingConfigServiceConnection based on elapsed time.

ServingConfigServiceRetryPolicy

The retry policy for ServingConfigServiceConnection.

UserEventServiceClient

Service for ingesting end user actions on the customer website.

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

CatalogServiceBackoffPolicyOption

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

CatalogServiceConnectionIdempotencyPolicyOption

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

CatalogServiceRetryPolicyOption

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

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.

ModelServiceBackoffPolicyOption

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

ModelServiceConnectionIdempotencyPolicyOption

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

ModelServicePollingPolicyOption

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

ModelServiceRetryPolicyOption

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

PredictionServiceBackoffPolicyOption

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

PredictionServiceConnectionIdempotencyPolicyOption

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

PredictionServiceRetryPolicyOption

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

ProductServiceBackoffPolicyOption

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

ProductServiceConnectionIdempotencyPolicyOption

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

ProductServicePollingPolicyOption

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

ProductServiceRetryPolicyOption

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.

ServingConfigServiceBackoffPolicyOption

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

ServingConfigServiceConnectionIdempotencyPolicyOption

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

ServingConfigServiceRetryPolicyOption

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

MakeCatalogServiceConnection(Options)

A factory function to construct an object of type CatalogServiceConnection.

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

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

Parameter
Name Description
options

(optional) Configure the CatalogServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< CatalogServiceConnection >

MakeDefaultCatalogServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< CatalogServiceConnectionIdempotencyPolicy >

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 >

MakeModelServiceConnection(Options)

A factory function to construct an object of type ModelServiceConnection.

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

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

Parameter
Name Description
options

(optional) Configure the ModelServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< ModelServiceConnection >

MakeDefaultModelServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< ModelServiceConnectionIdempotencyPolicy >

MakePredictionServiceConnection(Options)

A factory function to construct an object of type PredictionServiceConnection.

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

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

Parameter
Name Description
options

(optional) Configure the PredictionServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< PredictionServiceConnection >

MakeDefaultPredictionServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< PredictionServiceConnectionIdempotencyPolicy >

MakeProductServiceConnection(Options)

A factory function to construct an object of type ProductServiceConnection.

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

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

Parameter
Name Description
options

(optional) Configure the ProductServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< ProductServiceConnection >

MakeDefaultProductServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< ProductServiceConnectionIdempotencyPolicy >

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 >

MakeServingConfigServiceConnection(Options)

A factory function to construct an object of type ServingConfigServiceConnection.

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

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

Parameter
Name Description
options

(optional) Configure the ServingConfigServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< ServingConfigServiceConnection >

MakeDefaultServingConfigServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< ServingConfigServiceConnectionIdempotencyPolicy >

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 >

Type Aliases

CatalogServicePolicyOptionList

Alias Of: OptionList< CatalogServiceRetryPolicyOption, CatalogServiceBackoffPolicyOption, CatalogServiceConnectionIdempotencyPolicyOption >

The options applicable to CatalogService.

CompletionServicePolicyOptionList

Alias Of: OptionList< CompletionServiceRetryPolicyOption, CompletionServiceBackoffPolicyOption, CompletionServicePollingPolicyOption, CompletionServiceConnectionIdempotencyPolicyOption >

The options applicable to CompletionService.

ControlServicePolicyOptionList

Alias Of: OptionList< ControlServiceRetryPolicyOption, ControlServiceBackoffPolicyOption, ControlServiceConnectionIdempotencyPolicyOption >

The options applicable to ControlService.

ModelServicePolicyOptionList

Alias Of: OptionList< ModelServiceRetryPolicyOption, ModelServiceBackoffPolicyOption, ModelServicePollingPolicyOption, ModelServiceConnectionIdempotencyPolicyOption >

The options applicable to ModelService.

PredictionServicePolicyOptionList

Alias Of: OptionList< PredictionServiceRetryPolicyOption, PredictionServiceBackoffPolicyOption, PredictionServiceConnectionIdempotencyPolicyOption >

The options applicable to PredictionService.

ProductServicePolicyOptionList

Alias Of: OptionList< ProductServiceRetryPolicyOption, ProductServiceBackoffPolicyOption, ProductServicePollingPolicyOption, ProductServiceConnectionIdempotencyPolicyOption >

The options applicable to ProductService.

SearchServicePolicyOptionList

Alias Of: OptionList< SearchServiceRetryPolicyOption, SearchServiceBackoffPolicyOption, SearchServiceConnectionIdempotencyPolicyOption >

The options applicable to SearchService.

ServingConfigServicePolicyOptionList

Alias Of: OptionList< ServingConfigServiceRetryPolicyOption, ServingConfigServiceBackoffPolicyOption, ServingConfigServiceConnectionIdempotencyPolicyOption >

The options applicable to ServingConfigService.

UserEventServicePolicyOptionList

Alias Of: OptionList< UserEventServiceRetryPolicyOption, UserEventServiceBackoffPolicyOption, UserEventServicePollingPolicyOption, UserEventServiceConnectionIdempotencyPolicyOption >

The options applicable to UserEventService.