aws_sdk_iot/operation/search_index/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::search_index::_search_index_output::SearchIndexOutputBuilder;
3
4pub use crate::operation::search_index::_search_index_input::SearchIndexInputBuilder;
5
6impl crate::operation::search_index::builders::SearchIndexInputBuilder {
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::search_index::SearchIndexOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::search_index::SearchIndexError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.search_index();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SearchIndex`.
24///
25/// <p>The query search index.</p>
26/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">SearchIndex</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct SearchIndexFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::search_index::builders::SearchIndexInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::search_index::SearchIndexOutput,
36        crate::operation::search_index::SearchIndexError,
37    > for SearchIndexFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::search_index::SearchIndexOutput,
45            crate::operation::search_index::SearchIndexError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl SearchIndexFluentBuilder {
52    /// Creates a new `SearchIndexFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the SearchIndex as a reference.
61    pub fn as_input(&self) -> &crate::operation::search_index::builders::SearchIndexInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::search_index::SearchIndexOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::search_index::SearchIndexError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::search_index::SearchIndex::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::search_index::SearchIndex::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::search_index::SearchIndexOutput,
98        crate::operation::search_index::SearchIndexError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The search index name.</p>
113    pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.index_name(input.into());
115        self
116    }
117    /// <p>The search index name.</p>
118    pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_index_name(input);
120        self
121    }
122    /// <p>The search index name.</p>
123    pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_index_name()
125    }
126    /// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
127    pub fn query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.query_string(input.into());
129        self
130    }
131    /// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
132    pub fn set_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_query_string(input);
134        self
135    }
136    /// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
137    pub fn get_query_string(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_query_string()
139    }
140    /// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
141    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.next_token(input.into());
143        self
144    }
145    /// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
146    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_next_token(input);
148        self
149    }
150    /// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
151    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_next_token()
153    }
154    /// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
155    pub fn max_results(mut self, input: i32) -> Self {
156        self.inner = self.inner.max_results(input);
157        self
158    }
159    /// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
160    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
161        self.inner = self.inner.set_max_results(input);
162        self
163    }
164    /// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
165    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
166        self.inner.get_max_results()
167    }
168    /// <p>The query version.</p>
169    pub fn query_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
170        self.inner = self.inner.query_version(input.into());
171        self
172    }
173    /// <p>The query version.</p>
174    pub fn set_query_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
175        self.inner = self.inner.set_query_version(input);
176        self
177    }
178    /// <p>The query version.</p>
179    pub fn get_query_version(&self) -> &::std::option::Option<::std::string::String> {
180        self.inner.get_query_version()
181    }
182}