Class CompletionServiceClientImpl (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class CompletionServiceClientImpl : CompletionServiceClient

CompletionService client wrapper implementation, for convenient use.

Inheritance

Object > CompletionServiceClient > CompletionServiceClientImpl

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Auto-completion service for retail.

This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Constructors

CompletionServiceClientImpl(CompletionService.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
NameDescription
grpcClientCompletionService.CompletionServiceClient

The underlying gRPC client.

settingsCompletionServiceSettings

The base CompletionServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override CompletionService.CompletionServiceClient GrpcClient { get; }

The underlying gRPC CompletionService client

Property Value
TypeDescription
CompletionService.CompletionServiceClient
Overrides

ImportCompletionDataOperationsClient

public override OperationsClient ImportCompletionDataOperationsClient { get; }

The long-running operations client for ImportCompletionData.

Property Value
TypeDescription
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

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. Please enable Retail Search on Cloud Console before using this feature.

Parameters
NameDescription
requestCompleteQueryRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
CompleteQueryResponse

The RPC response.

Overrides

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. Please enable Retail Search on Cloud Console before using this feature.

Parameters
NameDescription
requestCompleteQueryRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<CompleteQueryResponse>

A Task containing the RPC response.

Overrides

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. Please enable Retail Search on Cloud Console before using this feature.

Parameters
NameDescription
requestImportCompletionDataRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ImportCompletionDataResponse, ImportMetadata>

The RPC response.

Overrides

ImportCompletionDataAsync(ImportCompletionDataRequest, CallSettings)

public override async 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. Please enable Retail Search on Cloud Console before using this feature.

Parameters
NameDescription
requestImportCompletionDataRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ImportCompletionDataResponse, ImportMetadata>>

A Task containing the RPC response.

Overrides