Class CompletionService.CompletionServiceClient (1.3.0)

public class CompletionServiceClient : ClientBase<CompletionService.CompletionServiceClient>

Client for CompletionService

Inheritance

Object > ClientBase > ClientBase<CompletionService.CompletionServiceClient> > CompletionService.CompletionServiceClient

Inherited Members

ClientBase<CompletionService.CompletionServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CompletionServiceClient()

protected CompletionServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CompletionServiceClient(CallInvoker)

public CompletionServiceClient(CallInvoker callInvoker)

Creates a new client for CompletionService that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

CompletionServiceClient(ChannelBase)

public CompletionServiceClient(ChannelBase channel)

Creates a new client for CompletionService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

CompletionServiceClient(ClientBase.ClientBaseConfiguration)

protected CompletionServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CompleteQuery(CompleteQueryRequest, CallOptions)

public virtual CompleteQueryResponse CompleteQuery(CompleteQueryRequest request, CallOptions options)

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`CompleteQueryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`CompleteQueryResponse`	The response received from the server.

CompleteQuery(CompleteQueryRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CompleteQueryResponse CompleteQuery(CompleteQueryRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`CompleteQueryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`CompleteQueryResponse`	The response received from the server.

CompleteQueryAsync(CompleteQueryRequest, CallOptions)

public virtual AsyncUnaryCall<CompleteQueryResponse> CompleteQueryAsync(CompleteQueryRequest request, CallOptions options)

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`CompleteQueryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<CompleteQueryResponse>`	The call object.

CompleteQueryAsync(CompleteQueryRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CompleteQueryResponse> CompleteQueryAsync(CompleteQueryRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`CompleteQueryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<CompleteQueryResponse>`	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`Operations.OperationsClient`	A new Operations client for the same target as this client.

ImportCompletionData(ImportCompletionDataRequest, CallOptions)

public virtual Operation ImportCompletionData(ImportCompletionDataRequest request, CallOptions options)

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`ImportCompletionDataRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportCompletionData(ImportCompletionDataRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ImportCompletionData(ImportCompletionDataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`ImportCompletionDataRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportCompletionDataAsync(ImportCompletionDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportCompletionDataAsync(ImportCompletionDataRequest request, CallOptions options)

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`ImportCompletionDataRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

ImportCompletionDataAsync(ImportCompletionDataRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportCompletionDataAsync(ImportCompletionDataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`ImportCompletionDataRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override CompletionService.CompletionServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`CompletionService.CompletionServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Retail.V2.CompletionService.CompletionServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)