Retail v2 API - Class CompletionServiceClientImpl (2.11.0)

public sealed class CompletionServiceClientImpl : CompletionServiceClient

Reference documentation and code samples for the Retail v2 API class CompletionServiceClientImpl.

CompletionService client wrapper implementation, for convenient use.

Inheritance

object > CompletionServiceClient > CompletionServiceClientImpl

Inherited Members

CompletionServiceClient.DefaultEndpoint

CompletionServiceClient.DefaultScopes

CompletionServiceClient.ServiceMetadata

CompletionServiceClient.CreateAsync(CancellationToken)

CompletionServiceClient.Create()

CompletionServiceClient.ShutdownDefaultChannelsAsync()

CompletionServiceClient.CompleteQueryAsync(CompleteQueryRequest, CancellationToken)

CompletionServiceClient.ImportCompletionDataAsync(ImportCompletionDataRequest, CancellationToken)

CompletionServiceClient.PollOnceImportCompletionData(string, CallSettings)

CompletionServiceClient.PollOnceImportCompletionDataAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

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.

Constructors

CompletionServiceClientImpl(CompletionServiceClient, CompletionServiceSettings, ILogger)

public CompletionServiceClientImpl(CompletionService.CompletionServiceClient grpcClient, CompletionServiceSettings settings, ILogger logger)

Constructs a client wrapper for the CompletionService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`CompletionServiceCompletionServiceClient` The underlying gRPC client.
`settings`	`CompletionServiceSettings` The base CompletionServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override CompletionService.CompletionServiceClient GrpcClient { get; }

The underlying gRPC CompletionService client

Property Value
Type	Description
`CompletionServiceCompletionServiceClient`

Overrides

CompletionServiceClient.GrpcClient

ImportCompletionDataOperationsClient

public override OperationsClient ImportCompletionDataOperationsClient { get; }

The long-running operations client for ImportCompletionData.

Property Value
Type	Description
`OperationsClient`

Overrides

CompletionServiceClient.ImportCompletionDataOperationsClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

CompletionServiceClient.LocationsClient

Methods

CompleteQuery(CompleteQueryRequest, CallSettings)

public override CompleteQueryResponse CompleteQuery(CompleteQueryRequest request, CallSettings callSettings = null)

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`	`CompleteQueryRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`CompleteQueryResponse`	The RPC response.

Overrides

CompletionServiceClient.CompleteQuery(CompleteQueryRequest, CallSettings)

CompleteQueryAsync(CompleteQueryRequest, CallSettings)

public override Task<CompleteQueryResponse> CompleteQueryAsync(CompleteQueryRequest request, CallSettings callSettings = null)

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`	`CompleteQueryRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskCompleteQueryResponse`	A Task containing the RPC response.

Overrides

CompletionServiceClient.CompleteQueryAsync(CompleteQueryRequest, CallSettings)

ImportCompletionData(ImportCompletionDataRequest, CallSettings)

public override Operation<ImportCompletionDataResponse, ImportMetadata> ImportCompletionData(ImportCompletionDataRequest request, CallSettings callSettings = null)

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`	`ImportCompletionDataRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationImportCompletionDataResponseImportMetadata`	The RPC response.

Overrides

CompletionServiceClient.ImportCompletionData(ImportCompletionDataRequest, CallSettings)

ImportCompletionDataAsync(ImportCompletionDataRequest, CallSettings)

public override Task<Operation<ImportCompletionDataResponse, ImportMetadata>> ImportCompletionDataAsync(ImportCompletionDataRequest request, CallSettings callSettings = null)

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`	`ImportCompletionDataRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationImportCompletionDataResponseImportMetadata`	A Task containing the RPC response.

Overrides

CompletionServiceClient.ImportCompletionDataAsync(ImportCompletionDataRequest, CallSettings)