Autocomplete service for retail.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
CompletionServiceClient(CompletionServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
CompletionServiceClient const &
|
CompletionServiceClient(CompletionServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
CompletionServiceClient &&
|
CompletionServiceClient(std::shared_ptr< CompletionServiceConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< CompletionServiceConnection >
|
opts |
Options
|
Operators
operator=(CompletionServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
CompletionServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
CompletionServiceClient & | |
operator=(CompletionServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
CompletionServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
CompletionServiceClient & | |
Functions
CompleteQuery(google::cloud::retail::v2::CompleteQueryRequest const &, Options)
Completes the specified prefix with keyword suggestions.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::retail::v2::CompleteQueryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::retail::v2::CompleteQueryResponse > | the result of the RPC. The response message type (google.cloud.retail.v2.CompleteQueryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ImportCompletionData(google::cloud::retail::v2::ImportCompletionDataRequest const &, Options)
Bulk import of processed completion dataset.
Request processing is asynchronous. Partial updating is not supported.
The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::retail::v2::ImportCompletionDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::retail::v2::ImportCompletionDataResponse > > | A |