Discovery Engine v1 API - Class CompletionServiceClientImpl (1.5.0)

Version 1.5.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public sealed class CompletionServiceClientImpl : CompletionServiceClient

Reference documentation and code samples for the Discovery Engine v1 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.ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest, CancellationToken)

CompletionServiceClient.PollOnceImportSuggestionDenyListEntries(string, CallSettings)

CompletionServiceClient.PollOnceImportSuggestionDenyListEntriesAsync(string, CallSettings)

CompletionServiceClient.PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest, CancellationToken)

CompletionServiceClient.PollOncePurgeSuggestionDenyListEntries(string, CallSettings)

CompletionServiceClient.PollOncePurgeSuggestionDenyListEntriesAsync(string, CallSettings)

CompletionServiceClient.ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest, CancellationToken)

CompletionServiceClient.PollOnceImportCompletionSuggestions(string, CallSettings)

CompletionServiceClient.PollOnceImportCompletionSuggestionsAsync(string, CallSettings)

CompletionServiceClient.PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest, CancellationToken)

CompletionServiceClient.PollOncePurgeCompletionSuggestions(string, CallSettings)

CompletionServiceClient.PollOncePurgeCompletionSuggestionsAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for Auto-Completion.

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

ImportCompletionSuggestionsOperationsClient

public override OperationsClient ImportCompletionSuggestionsOperationsClient { get; }

The long-running operations client for ImportCompletionSuggestions.

Property Value
Type	Description
OperationsClient

Overrides

CompletionServiceClient.ImportCompletionSuggestionsOperationsClient

ImportSuggestionDenyListEntriesOperationsClient

public override OperationsClient ImportSuggestionDenyListEntriesOperationsClient { get; }

The long-running operations client for ImportSuggestionDenyListEntries.

Property Value
Type	Description
OperationsClient

Overrides

CompletionServiceClient.ImportSuggestionDenyListEntriesOperationsClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

CompletionServiceClient.LocationsClient

PurgeCompletionSuggestionsOperationsClient

public override OperationsClient PurgeCompletionSuggestionsOperationsClient { get; }

The long-running operations client for PurgeCompletionSuggestions.

Property Value
Type	Description
OperationsClient

Overrides

CompletionServiceClient.PurgeCompletionSuggestionsOperationsClient

PurgeSuggestionDenyListEntriesOperationsClient

public override OperationsClient PurgeSuggestionDenyListEntriesOperationsClient { get; }

The long-running operations client for PurgeSuggestionDenyListEntries.

Property Value
Type	Description
OperationsClient

Overrides

CompletionServiceClient.PurgeSuggestionDenyListEntriesOperationsClient

Methods

CompleteQuery(CompleteQueryRequest, CallSettings)

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

Completes the specified user input with keyword suggestions.

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

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)

ImportCompletionSuggestions(ImportCompletionSuggestionsRequest, CallSettings)

public override Operation<ImportCompletionSuggestionsResponse, ImportCompletionSuggestionsMetadata> ImportCompletionSuggestions(ImportCompletionSuggestionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ImportCompletionSuggestionsRequest 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
OperationImportCompletionSuggestionsResponseImportCompletionSuggestionsMetadata	The RPC response.

Overrides

CompletionServiceClient.ImportCompletionSuggestions(ImportCompletionSuggestionsRequest, CallSettings)

ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest, CallSettings)

public override Task<Operation<ImportCompletionSuggestionsResponse, ImportCompletionSuggestionsMetadata>> ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ImportCompletionSuggestionsRequest 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
TaskOperationImportCompletionSuggestionsResponseImportCompletionSuggestionsMetadata	A Task containing the RPC response.

Overrides

CompletionServiceClient.ImportCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest, CallSettings)

ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest, CallSettings)

public override Operation<ImportSuggestionDenyListEntriesResponse, ImportSuggestionDenyListEntriesMetadata> ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ImportSuggestionDenyListEntriesRequest 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
OperationImportSuggestionDenyListEntriesResponseImportSuggestionDenyListEntriesMetadata	The RPC response.

Overrides

CompletionServiceClient.ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest, CallSettings)

ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest, CallSettings)

public override Task<Operation<ImportSuggestionDenyListEntriesResponse, ImportSuggestionDenyListEntriesMetadata>> ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ImportSuggestionDenyListEntriesRequest 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
TaskOperationImportSuggestionDenyListEntriesResponseImportSuggestionDenyListEntriesMetadata	A Task containing the RPC response.

Overrides

CompletionServiceClient.ImportSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest, CallSettings)

PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest, CallSettings)

public override Operation<PurgeCompletionSuggestionsResponse, PurgeCompletionSuggestionsMetadata> PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	PurgeCompletionSuggestionsRequest 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
OperationPurgeCompletionSuggestionsResponsePurgeCompletionSuggestionsMetadata	The RPC response.

Overrides

CompletionServiceClient.PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest, CallSettings)

PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest, CallSettings)

public override Task<Operation<PurgeCompletionSuggestionsResponse, PurgeCompletionSuggestionsMetadata>> PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	PurgeCompletionSuggestionsRequest 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
TaskOperationPurgeCompletionSuggestionsResponsePurgeCompletionSuggestionsMetadata	A Task containing the RPC response.

Overrides

CompletionServiceClient.PurgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest, CallSettings)

PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest, CallSettings)

public override Operation<PurgeSuggestionDenyListEntriesResponse, PurgeSuggestionDenyListEntriesMetadata> PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	PurgeSuggestionDenyListEntriesRequest 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
OperationPurgeSuggestionDenyListEntriesResponsePurgeSuggestionDenyListEntriesMetadata	The RPC response.

Overrides

CompletionServiceClient.PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest, CallSettings)

PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest, CallSettings)

public override Task<Operation<PurgeSuggestionDenyListEntriesResponse, PurgeSuggestionDenyListEntriesMetadata>> PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	PurgeSuggestionDenyListEntriesRequest 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
TaskOperationPurgeSuggestionDenyListEntriesResponsePurgeSuggestionDenyListEntriesMetadata	A Task containing the RPC response.

Overrides

CompletionServiceClient.PurgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest, CallSettings)