aws_sdk_bedrockagentruntime/operation/retrieve/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::retrieve::_retrieve_output::RetrieveOutputBuilder;
3
4pub use crate::operation::retrieve::_retrieve_input::RetrieveInputBuilder;
5
6impl crate::operation::retrieve::builders::RetrieveInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::retrieve::RetrieveOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::retrieve::RetrieveError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.retrieve();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `Retrieve`.
24///
25/// <p>Queries a knowledge base and retrieves information from it.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct RetrieveFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::retrieve::builders::RetrieveInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl crate::client::customize::internal::CustomizableSend<crate::operation::retrieve::RetrieveOutput, crate::operation::retrieve::RetrieveError>
33    for RetrieveFluentBuilder
34{
35    fn send(
36        self,
37        config_override: crate::config::Builder,
38    ) -> crate::client::customize::internal::BoxFuture<
39        crate::client::customize::internal::SendResult<crate::operation::retrieve::RetrieveOutput, crate::operation::retrieve::RetrieveError>,
40    > {
41        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
42    }
43}
44impl RetrieveFluentBuilder {
45    /// Creates a new `RetrieveFluentBuilder`.
46    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
47        Self {
48            handle,
49            inner: ::std::default::Default::default(),
50            config_override: ::std::option::Option::None,
51        }
52    }
53    /// Access the Retrieve as a reference.
54    pub fn as_input(&self) -> &crate::operation::retrieve::builders::RetrieveInputBuilder {
55        &self.inner
56    }
57    /// Sends the request and returns the response.
58    ///
59    /// If an error occurs, an `SdkError` will be returned with additional details that
60    /// can be matched against.
61    ///
62    /// By default, any retryable failures will be retried twice. Retry behavior
63    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
64    /// set when configuring the client.
65    pub async fn send(
66        self,
67    ) -> ::std::result::Result<
68        crate::operation::retrieve::RetrieveOutput,
69        ::aws_smithy_runtime_api::client::result::SdkError<
70            crate::operation::retrieve::RetrieveError,
71            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
72        >,
73    > {
74        let input = self
75            .inner
76            .build()
77            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
78        let runtime_plugins = crate::operation::retrieve::Retrieve::operation_runtime_plugins(
79            self.handle.runtime_plugins.clone(),
80            &self.handle.conf,
81            self.config_override,
82        );
83        crate::operation::retrieve::Retrieve::orchestrate(&runtime_plugins, input).await
84    }
85
86    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
87    pub fn customize(
88        self,
89    ) -> crate::client::customize::CustomizableOperation<crate::operation::retrieve::RetrieveOutput, crate::operation::retrieve::RetrieveError, Self>
90    {
91        crate::client::customize::CustomizableOperation::new(self)
92    }
93    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
94        self.set_config_override(::std::option::Option::Some(config_override.into()));
95        self
96    }
97
98    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
99        self.config_override = config_override;
100        self
101    }
102    /// Create a paginator for this request
103    ///
104    /// Paginators are used by calling [`send().await`](crate::operation::retrieve::paginator::RetrievePaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
105    pub fn into_paginator(self) -> crate::operation::retrieve::paginator::RetrievePaginator {
106        crate::operation::retrieve::paginator::RetrievePaginator::new(self.handle, self.inner)
107    }
108    /// <p>The unique identifier of the knowledge base to query.</p>
109    pub fn knowledge_base_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
110        self.inner = self.inner.knowledge_base_id(input.into());
111        self
112    }
113    /// <p>The unique identifier of the knowledge base to query.</p>
114    pub fn set_knowledge_base_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
115        self.inner = self.inner.set_knowledge_base_id(input);
116        self
117    }
118    /// <p>The unique identifier of the knowledge base to query.</p>
119    pub fn get_knowledge_base_id(&self) -> &::std::option::Option<::std::string::String> {
120        self.inner.get_knowledge_base_id()
121    }
122    /// <p>Contains the query to send the knowledge base.</p>
123    pub fn retrieval_query(mut self, input: crate::types::KnowledgeBaseQuery) -> Self {
124        self.inner = self.inner.retrieval_query(input);
125        self
126    }
127    /// <p>Contains the query to send the knowledge base.</p>
128    pub fn set_retrieval_query(mut self, input: ::std::option::Option<crate::types::KnowledgeBaseQuery>) -> Self {
129        self.inner = self.inner.set_retrieval_query(input);
130        self
131    }
132    /// <p>Contains the query to send the knowledge base.</p>
133    pub fn get_retrieval_query(&self) -> &::std::option::Option<crate::types::KnowledgeBaseQuery> {
134        self.inner.get_retrieval_query()
135    }
136    /// <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
137    pub fn retrieval_configuration(mut self, input: crate::types::KnowledgeBaseRetrievalConfiguration) -> Self {
138        self.inner = self.inner.retrieval_configuration(input);
139        self
140    }
141    /// <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
142    pub fn set_retrieval_configuration(mut self, input: ::std::option::Option<crate::types::KnowledgeBaseRetrievalConfiguration>) -> Self {
143        self.inner = self.inner.set_retrieval_configuration(input);
144        self
145    }
146    /// <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
147    pub fn get_retrieval_configuration(&self) -> &::std::option::Option<crate::types::KnowledgeBaseRetrievalConfiguration> {
148        self.inner.get_retrieval_configuration()
149    }
150    /// <p>Guardrail settings.</p>
151    pub fn guardrail_configuration(mut self, input: crate::types::GuardrailConfiguration) -> Self {
152        self.inner = self.inner.guardrail_configuration(input);
153        self
154    }
155    /// <p>Guardrail settings.</p>
156    pub fn set_guardrail_configuration(mut self, input: ::std::option::Option<crate::types::GuardrailConfiguration>) -> Self {
157        self.inner = self.inner.set_guardrail_configuration(input);
158        self
159    }
160    /// <p>Guardrail settings.</p>
161    pub fn get_guardrail_configuration(&self) -> &::std::option::Option<crate::types::GuardrailConfiguration> {
162        self.inner.get_guardrail_configuration()
163    }
164    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
165    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166        self.inner = self.inner.next_token(input.into());
167        self
168    }
169    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
170    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
171        self.inner = self.inner.set_next_token(input);
172        self
173    }
174    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
175    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
176        self.inner.get_next_token()
177    }
178}
aws_sdk_bedrockagentruntime/operation/retrieve/builders.rs

aws_sdk_bedrockagentruntime/operation/retrieve/
builders.rs
