pub struct RetrieveFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to Retrieve.

Queries a knowledge base and retrieves information from it.

Implementations§

source§

impl RetrieveFluentBuilder

source

pub fn as_input(&self) -> &RetrieveInputBuilder

Access the Retrieve as a reference.

source

pub async fn send( self ) -> Result<RetrieveOutput, SdkError<RetrieveError, HttpResponse>>

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.

source

pub fn customize( self ) -> CustomizableOperation<RetrieveOutput, RetrieveError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

pub fn into_paginator(self) -> RetrievePaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

source

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

The unique identifier of the knowledge base to query.

source

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

The unique identifier of the knowledge base to query.

source

pub fn get_knowledge_base_id(&self) -> &Option<String>

The unique identifier of the knowledge base to query.

source

pub fn retrieval_query(self, input: KnowledgeBaseQuery) -> Self

Contains the query to send the knowledge base.

source

pub fn set_retrieval_query(self, input: Option<KnowledgeBaseQuery>) -> Self

Contains the query to send the knowledge base.

source

pub fn get_retrieval_query(&self) -> &Option<KnowledgeBaseQuery>

Contains the query to send the knowledge base.

source

pub fn retrieval_configuration( self, input: KnowledgeBaseRetrievalConfiguration ) -> Self

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

source

pub fn set_retrieval_configuration( self, input: Option<KnowledgeBaseRetrievalConfiguration> ) -> Self

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

source

pub fn get_retrieval_configuration( &self ) -> &Option<KnowledgeBaseRetrievalConfiguration>

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

source

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

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

source

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

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

source

pub fn get_next_token(&self) -> &Option<String>

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Trait Implementations§

source§

impl Clone for RetrieveFluentBuilder

source§

fn clone(&self) -> RetrieveFluentBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RetrieveFluentBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more