Discovery Engine v1 API - Class CompletionService.CompletionServiceClient (1.5.0)

public class CompletionService.CompletionServiceClient : ClientBase<CompletionService.CompletionServiceClient>

Reference documentation and code samples for the Discovery Engine v1 API class 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.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.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(ClientBaseConfiguration)

protected CompletionServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CompleteQuery(CompleteQueryRequest, CallOptions)

public virtual CompleteQueryResponse CompleteQuery(CompleteQueryRequest request, CallOptions options)

Completes the specified user input with keyword suggestions.

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, DateTime?, CancellationToken)

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

Completes the specified user input with keyword suggestions.

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`	`System.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 user input with keyword suggestions.

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

Returns
Type	Description
`AsyncUnaryCallCompleteQueryResponse`	The call object.

CompleteQueryAsync(CompleteQueryRequest, Metadata, DateTime?, CancellationToken)

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

Completes the specified user input with keyword suggestions.

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`	`System.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
`AsyncUnaryCallCompleteQueryResponse`	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
`LocationsLocationsClient`	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

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

ImportCompletionSuggestions(ImportCompletionSuggestionsRequest, CallOptions)

public virtual Operation ImportCompletionSuggestions(ImportCompletionSuggestionsRequest request, CallOptions options)

Imports [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

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

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

ImportCompletionSuggestions(ImportCompletionSuggestionsRequest, Metadata, DateTime?, CancellationToken)

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

Imports [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

Parameters
Name	Description
`request`	`ImportCompletionSuggestionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest request, CallOptions options)

Imports [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest, Metadata, DateTime?, CancellationToken)

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

Imports [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

Parameters
Name	Description
`request`	`ImportCompletionSuggestionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallOperation`	The call object.

ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest, CallOptions)

public virtual Operation ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest request, CallOptions options)

Imports all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

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

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

ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest, Metadata, DateTime?, CancellationToken)

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

Imports all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

Parameters
Name	Description
`request`	`ImportSuggestionDenyListEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest request, CallOptions options)

Imports all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest, Metadata, DateTime?, CancellationToken)

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

Imports all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

Parameters
Name	Description
`request`	`ImportSuggestionDenyListEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallOperation`	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`CompletionServiceCompletionServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1.CompletionService.CompletionServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest, CallOptions)

public virtual Operation PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest request, CallOptions options)

Permanently deletes all [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

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

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

PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest, Metadata, DateTime?, CancellationToken)

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

Permanently deletes all [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

Parameters
Name	Description
`request`	`PurgeCompletionSuggestionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest request, CallOptions options)

Permanently deletes all [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest, Metadata, DateTime?, CancellationToken)

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

Permanently deletes all [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s for a DataStore.

Parameters
Name	Description
`request`	`PurgeCompletionSuggestionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallOperation`	The call object.

PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest, CallOptions)

public virtual Operation PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest request, CallOptions options)

Permanently deletes all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

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

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

PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest, Metadata, DateTime?, CancellationToken)

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

Permanently deletes all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

Parameters
Name	Description
`request`	`PurgeSuggestionDenyListEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest request, CallOptions options)

Permanently deletes all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest, Metadata, DateTime?, CancellationToken)

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

Permanently deletes all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] for a DataStore.

Parameters
Name	Description
`request`	`PurgeSuggestionDenyListEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallOperation`	The call object.