aws_sdk_s3vectors/operation/get_index/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_index::_get_index_output::GetIndexOutputBuilder;
3
4pub use crate::operation::get_index::_get_index_input::GetIndexInputBuilder;
5
6impl crate::operation::get_index::builders::GetIndexInputBuilder {
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::get_index::GetIndexOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_index::GetIndexError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_index();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetIndex`.
24///
25/// <p>Returns vector index attributes. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN).</p>
26/// <dl>
27/// <dt>
28/// Permissions
29/// </dt>
30/// <dd>
31/// <p>You must have the <code>s3vectors:GetIndex</code> permission to use this operation.</p>
32/// </dd>
33/// </dl>
34#[derive(::std::clone::Clone, ::std::fmt::Debug)]
35pub struct GetIndexFluentBuilder {
36    handle: ::std::sync::Arc<crate::client::Handle>,
37    inner: crate::operation::get_index::builders::GetIndexInputBuilder,
38    config_override: ::std::option::Option<crate::config::Builder>,
39}
40impl crate::client::customize::internal::CustomizableSend<crate::operation::get_index::GetIndexOutput, crate::operation::get_index::GetIndexError>
41    for GetIndexFluentBuilder
42{
43    fn send(
44        self,
45        config_override: crate::config::Builder,
46    ) -> crate::client::customize::internal::BoxFuture<
47        crate::client::customize::internal::SendResult<crate::operation::get_index::GetIndexOutput, crate::operation::get_index::GetIndexError>,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetIndexFluentBuilder {
53    /// Creates a new `GetIndexFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the GetIndex as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_index::builders::GetIndexInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::get_index::GetIndexOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_index::GetIndexError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::get_index::GetIndex::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_index::GetIndex::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<crate::operation::get_index::GetIndexOutput, crate::operation::get_index::GetIndexError, Self>
98    {
99        crate::client::customize::CustomizableOperation::new(self)
100    }
101    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
102        self.set_config_override(::std::option::Option::Some(config_override.into()));
103        self
104    }
105
106    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
107        self.config_override = config_override;
108        self
109    }
110    /// <p>The name of the vector bucket that contains the vector index.</p>
111    pub fn vector_bucket_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
112        self.inner = self.inner.vector_bucket_name(input.into());
113        self
114    }
115    /// <p>The name of the vector bucket that contains the vector index.</p>
116    pub fn set_vector_bucket_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
117        self.inner = self.inner.set_vector_bucket_name(input);
118        self
119    }
120    /// <p>The name of the vector bucket that contains the vector index.</p>
121    pub fn get_vector_bucket_name(&self) -> &::std::option::Option<::std::string::String> {
122        self.inner.get_vector_bucket_name()
123    }
124    /// <p>The name of the vector index.</p>
125    pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126        self.inner = self.inner.index_name(input.into());
127        self
128    }
129    /// <p>The name of the vector index.</p>
130    pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
131        self.inner = self.inner.set_index_name(input);
132        self
133    }
134    /// <p>The name of the vector index.</p>
135    pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
136        self.inner.get_index_name()
137    }
138    /// <p>The ARN of the vector index.</p>
139    pub fn index_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
140        self.inner = self.inner.index_arn(input.into());
141        self
142    }
143    /// <p>The ARN of the vector index.</p>
144    pub fn set_index_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
145        self.inner = self.inner.set_index_arn(input);
146        self
147    }
148    /// <p>The ARN of the vector index.</p>
149    pub fn get_index_arn(&self) -> &::std::option::Option<::std::string::String> {
150        self.inner.get_index_arn()
151    }
152}
aws_sdk_s3vectors/operation/get_index/builders.rs

aws_sdk_s3vectors/operation/get_index/
builders.rs
