pub struct CompletionService { /* private fields */ }completion-service only.Expand description
Implements a client for the Discovery Engine API.
§Example
let client = CompletionService::builder().build().await?;
// use `client` to make requests to the Discovery Engine API.§Service Description
Service for Auto-Completion.
§Configuration
To configure CompletionService use the with_* methods in the type returned
by builder(). The default configuration should
work for most applications. Common configuration changes include
- with_endpoint(): by default this client uses the global default endpoint
(
https://discoveryengine.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default. - with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.
§Pooling and Cloning
CompletionService holds a connection pool internally, it is advised to
create one and the reuse it. You do not need to wrap CompletionService in
an Rc or Arc to reuse it, because it
already uses an Arc internally.
Implementations§
Source§impl CompletionService
impl CompletionService
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a builder for CompletionService.
let client = CompletionService::builder().build().await?;Sourcepub fn from_stub<T>(stub: T) -> Selfwhere
T: CompletionService + 'static,
pub fn from_stub<T>(stub: T) -> Selfwhere
T: CompletionService + 'static,
Creates a new client from the provided stub.
The most common case for calling this function is in tests mocking the client’s behavior.
Sourcepub fn complete_query(&self) -> CompleteQuery
pub fn complete_query(&self) -> CompleteQuery
Completes the specified user input with keyword suggestions.
Sourcepub fn import_suggestion_deny_list_entries(
&self,
) -> ImportSuggestionDenyListEntries
pub fn import_suggestion_deny_list_entries( &self, ) -> ImportSuggestionDenyListEntries
Imports all SuggestionDenyListEntry for a DataStore.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn purge_suggestion_deny_list_entries(
&self,
) -> PurgeSuggestionDenyListEntries
pub fn purge_suggestion_deny_list_entries( &self, ) -> PurgeSuggestionDenyListEntries
Permanently deletes all SuggestionDenyListEntry for a DataStore.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn import_completion_suggestions(&self) -> ImportCompletionSuggestions
pub fn import_completion_suggestions(&self) -> ImportCompletionSuggestions
Imports CompletionSuggestions for a DataStore.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn purge_completion_suggestions(&self) -> PurgeCompletionSuggestions
pub fn purge_completion_suggestions(&self) -> PurgeCompletionSuggestions
Permanently deletes all CompletionSuggestions for a DataStore.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn list_operations(&self) -> ListOperations
pub fn list_operations(&self) -> ListOperations
Provides the Operations service functionality in this service.
Sourcepub fn get_operation(&self) -> GetOperation
pub fn get_operation(&self) -> GetOperation
Provides the Operations service functionality in this service.
Sourcepub fn cancel_operation(&self) -> CancelOperation
pub fn cancel_operation(&self) -> CancelOperation
Provides the Operations service functionality in this service.
Trait Implementations§
Source§impl Clone for CompletionService
impl Clone for CompletionService
Source§fn clone(&self) -> CompletionService
fn clone(&self) -> CompletionService
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more