Struct aws_sdk_cloudsearchdomain::client::fluent_builders::Suggest

pub struct Suggest<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to Suggest.

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Implementations

impl<C, M, R> Suggest<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<SuggestOutput, SdkError<SuggestError>> where
    R::Policy: SmithyRetryPolicy<SuggestInputOperationOutputAlias, SuggestOutput, SuggestError, SuggestInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn query(self, input: impl Into<String>) -> Self

Specifies the string for which you want to get suggestions.

pub fn set_query(self, input: Option<String>) -> Self

Specifies the string for which you want to get suggestions.

pub fn suggester(self, input: impl Into<String>) -> Self

Specifies the name of the suggester to use to find suggested matches.

pub fn set_suggester(self, input: Option<String>) -> Self

Specifies the name of the suggester to use to find suggested matches.

pub fn size(self, input: i64) -> Self

Specifies the maximum number of suggestions to return.

pub fn set_size(self, input: Option<i64>) -> Self

Specifies the maximum number of suggestions to return.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for Suggest<C, M, R>

fn clone(&self) -> Suggest<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Suggest<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.