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
impl RetrieveFluentBuilder
sourcepub fn as_input(&self) -> &RetrieveInputBuilder
pub fn as_input(&self) -> &RetrieveInputBuilder
Access the Retrieve as a reference.
sourcepub async fn send(
self
) -> Result<RetrieveOutput, SdkError<RetrieveError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<RetrieveOutput, RetrieveError, Self>
pub fn customize( self ) -> CustomizableOperation<RetrieveOutput, RetrieveError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> RetrievePaginator
pub fn into_paginator(self) -> RetrievePaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn knowledge_base_id(self, input: impl Into<String>) -> Self
pub fn knowledge_base_id(self, input: impl Into<String>) -> Self
The unique identifier of the knowledge base to query.
sourcepub fn set_knowledge_base_id(self, input: Option<String>) -> Self
pub fn set_knowledge_base_id(self, input: Option<String>) -> Self
The unique identifier of the knowledge base to query.
sourcepub fn get_knowledge_base_id(&self) -> &Option<String>
pub fn get_knowledge_base_id(&self) -> &Option<String>
The unique identifier of the knowledge base to query.
sourcepub fn retrieval_query(self, input: KnowledgeBaseQuery) -> Self
pub fn retrieval_query(self, input: KnowledgeBaseQuery) -> Self
Contains the query to send the knowledge base.
sourcepub fn set_retrieval_query(self, input: Option<KnowledgeBaseQuery>) -> Self
pub fn set_retrieval_query(self, input: Option<KnowledgeBaseQuery>) -> Self
Contains the query to send the knowledge base.
sourcepub fn get_retrieval_query(&self) -> &Option<KnowledgeBaseQuery>
pub fn get_retrieval_query(&self) -> &Option<KnowledgeBaseQuery>
Contains the query to send the knowledge base.
sourcepub fn retrieval_configuration(
self,
input: KnowledgeBaseRetrievalConfiguration
) -> Self
pub fn retrieval_configuration( self, input: KnowledgeBaseRetrievalConfiguration ) -> Self
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
sourcepub fn set_retrieval_configuration(
self,
input: Option<KnowledgeBaseRetrievalConfiguration>
) -> Self
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.
sourcepub fn get_retrieval_configuration(
&self
) -> &Option<KnowledgeBaseRetrievalConfiguration>
pub fn get_retrieval_configuration( &self ) -> &Option<KnowledgeBaseRetrievalConfiguration>
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_next_token(&self) -> &Option<String>
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
impl Clone for RetrieveFluentBuilder
source§fn clone(&self) -> RetrieveFluentBuilder
fn clone(&self) -> RetrieveFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RetrieveFluentBuilder
impl !RefUnwindSafe for RetrieveFluentBuilder
impl Send for RetrieveFluentBuilder
impl Sync for RetrieveFluentBuilder
impl Unpin for RetrieveFluentBuilder
impl !UnwindSafe for RetrieveFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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