aws_sdk_iot/operation/list_things/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_things::_list_things_output::ListThingsOutputBuilder;
3
4pub use crate::operation::list_things::_list_things_input::ListThingsInputBuilder;
5
6impl crate::operation::list_things::builders::ListThingsInputBuilder {
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::list_things::ListThingsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_things::ListThingsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_things();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListThings`.
24///
25/// <p>Lists your things. Use the <b>attributeName</b> and <b>attributeValue</b> parameters to filter your things. For example, calling <code>ListThings</code> with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute <b>Color</b> with the value <b>Red</b>. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html#list-things">List Things</a> from the <i>Amazon Web Services IoT Core Developer Guide</i>.</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">ListThings</a> action.</p><note>
27/// <p>You will not be charged for calling this API if an <code>Access denied</code> error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.</p>
28/// </note>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct ListThingsFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::list_things::builders::ListThingsInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::list_things::ListThingsOutput,
38        crate::operation::list_things::ListThingsError,
39    > for ListThingsFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::list_things::ListThingsOutput,
47            crate::operation::list_things::ListThingsError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl ListThingsFluentBuilder {
54    /// Creates a new `ListThingsFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the ListThings as a reference.
63    pub fn as_input(&self) -> &crate::operation::list_things::builders::ListThingsInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::list_things::ListThingsOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::list_things::ListThingsError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::list_things::ListThings::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::list_things::ListThings::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::list_things::ListThingsOutput,
100        crate::operation::list_things::ListThingsError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// Create a paginator for this request
115    ///
116    /// Paginators are used by calling [`send().await`](crate::operation::list_things::paginator::ListThingsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
117    pub fn into_paginator(self) -> crate::operation::list_things::paginator::ListThingsPaginator {
118        crate::operation::list_things::paginator::ListThingsPaginator::new(self.handle, self.inner)
119    }
120    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
121    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.next_token(input.into());
123        self
124    }
125    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
126    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127        self.inner = self.inner.set_next_token(input);
128        self
129    }
130    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
131    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
132        self.inner.get_next_token()
133    }
134    /// <p>The maximum number of results to return in this operation.</p>
135    pub fn max_results(mut self, input: i32) -> Self {
136        self.inner = self.inner.max_results(input);
137        self
138    }
139    /// <p>The maximum number of results to return in this operation.</p>
140    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
141        self.inner = self.inner.set_max_results(input);
142        self
143    }
144    /// <p>The maximum number of results to return in this operation.</p>
145    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
146        self.inner.get_max_results()
147    }
148    /// <p>The attribute name used to search for things.</p>
149    pub fn attribute_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150        self.inner = self.inner.attribute_name(input.into());
151        self
152    }
153    /// <p>The attribute name used to search for things.</p>
154    pub fn set_attribute_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
155        self.inner = self.inner.set_attribute_name(input);
156        self
157    }
158    /// <p>The attribute name used to search for things.</p>
159    pub fn get_attribute_name(&self) -> &::std::option::Option<::std::string::String> {
160        self.inner.get_attribute_name()
161    }
162    /// <p>The attribute value used to search for things.</p>
163    pub fn attribute_value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
164        self.inner = self.inner.attribute_value(input.into());
165        self
166    }
167    /// <p>The attribute value used to search for things.</p>
168    pub fn set_attribute_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
169        self.inner = self.inner.set_attribute_value(input);
170        self
171    }
172    /// <p>The attribute value used to search for things.</p>
173    pub fn get_attribute_value(&self) -> &::std::option::Option<::std::string::String> {
174        self.inner.get_attribute_value()
175    }
176    /// <p>The name of the thing type used to search for things.</p>
177    pub fn thing_type_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
178        self.inner = self.inner.thing_type_name(input.into());
179        self
180    }
181    /// <p>The name of the thing type used to search for things.</p>
182    pub fn set_thing_type_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
183        self.inner = self.inner.set_thing_type_name(input);
184        self
185    }
186    /// <p>The name of the thing type used to search for things.</p>
187    pub fn get_thing_type_name(&self) -> &::std::option::Option<::std::string::String> {
188        self.inner.get_thing_type_name()
189    }
190    /// <p>When <code>true</code>, the action returns the thing resources with attribute values that start with the <code>attributeValue</code> provided.</p>
191    /// <p>When <code>false</code>, or not present, the action returns only the thing resources with attribute values that match the entire <code>attributeValue</code> provided.</p>
192    pub fn use_prefix_attribute_value(mut self, input: bool) -> Self {
193        self.inner = self.inner.use_prefix_attribute_value(input);
194        self
195    }
196    /// <p>When <code>true</code>, the action returns the thing resources with attribute values that start with the <code>attributeValue</code> provided.</p>
197    /// <p>When <code>false</code>, or not present, the action returns only the thing resources with attribute values that match the entire <code>attributeValue</code> provided.</p>
198    pub fn set_use_prefix_attribute_value(mut self, input: ::std::option::Option<bool>) -> Self {
199        self.inner = self.inner.set_use_prefix_attribute_value(input);
200        self
201    }
202    /// <p>When <code>true</code>, the action returns the thing resources with attribute values that start with the <code>attributeValue</code> provided.</p>
203    /// <p>When <code>false</code>, or not present, the action returns only the thing resources with attribute values that match the entire <code>attributeValue</code> provided.</p>
204    pub fn get_use_prefix_attribute_value(&self) -> &::std::option::Option<bool> {
205        self.inner.get_use_prefix_attribute_value()
206    }
207}
aws_sdk_iot/operation/list_things/builders.rs

aws_sdk_iot/operation/list_things/
builders.rs
