aws_sdk_iotsitewise/operation/list_asset_model_properties/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_asset_model_properties::_list_asset_model_properties_output::ListAssetModelPropertiesOutputBuilder;
3
4pub use crate::operation::list_asset_model_properties::_list_asset_model_properties_input::ListAssetModelPropertiesInputBuilder;
5
6impl crate::operation::list_asset_model_properties::builders::ListAssetModelPropertiesInputBuilder {
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_asset_model_properties::ListAssetModelPropertiesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_asset_model_properties::ListAssetModelPropertiesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_asset_model_properties();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListAssetModelProperties`.
24///
25/// <p>Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListAssetModelPropertiesFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::list_asset_model_properties::builders::ListAssetModelPropertiesInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::list_asset_model_properties::ListAssetModelPropertiesOutput,
35        crate::operation::list_asset_model_properties::ListAssetModelPropertiesError,
36    > for ListAssetModelPropertiesFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::list_asset_model_properties::ListAssetModelPropertiesOutput,
44            crate::operation::list_asset_model_properties::ListAssetModelPropertiesError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl ListAssetModelPropertiesFluentBuilder {
51    /// Creates a new `ListAssetModelPropertiesFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the ListAssetModelProperties as a reference.
60    pub fn as_input(&self) -> &crate::operation::list_asset_model_properties::builders::ListAssetModelPropertiesInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::list_asset_model_properties::ListAssetModelPropertiesOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::list_asset_model_properties::ListAssetModelPropertiesError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::list_asset_model_properties::ListAssetModelProperties::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::list_asset_model_properties::ListAssetModelProperties::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::list_asset_model_properties::ListAssetModelPropertiesOutput,
97        crate::operation::list_asset_model_properties::ListAssetModelPropertiesError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::list_asset_model_properties::paginator::ListAssetModelPropertiesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::list_asset_model_properties::paginator::ListAssetModelPropertiesPaginator {
115        crate::operation::list_asset_model_properties::paginator::ListAssetModelPropertiesPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
118    pub fn asset_model_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.asset_model_id(input.into());
120        self
121    }
122    /// <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
123    pub fn set_asset_model_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_asset_model_id(input);
125        self
126    }
127    /// <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
128    pub fn get_asset_model_id(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_asset_model_id()
130    }
131    /// <p>The token to be used for the next set of paginated results.</p>
132    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.next_token(input.into());
134        self
135    }
136    /// <p>The token to be used for the next set of paginated results.</p>
137    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_next_token(input);
139        self
140    }
141    /// <p>The token to be used for the next set of paginated results.</p>
142    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_next_token()
144    }
145    /// <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
146    pub fn max_results(mut self, input: i32) -> Self {
147        self.inner = self.inner.max_results(input);
148        self
149    }
150    /// <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
151    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
152        self.inner = self.inner.set_max_results(input);
153        self
154    }
155    /// <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
156    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
157        self.inner.get_max_results()
158    }
159    /// <p>Filters the requested list of asset model properties. You can choose one of the following options:</p>
160    /// <ul>
161    /// <li>
162    /// <p><code>ALL</code> – The list includes all asset model properties for a given asset model ID.</p></li>
163    /// <li>
164    /// <p><code>BASE</code> – The list includes only base asset model properties for a given asset model ID.</p></li>
165    /// </ul>
166    /// <p>Default: <code>BASE</code></p>
167    pub fn filter(mut self, input: crate::types::ListAssetModelPropertiesFilter) -> Self {
168        self.inner = self.inner.filter(input);
169        self
170    }
171    /// <p>Filters the requested list of asset model properties. You can choose one of the following options:</p>
172    /// <ul>
173    /// <li>
174    /// <p><code>ALL</code> – The list includes all asset model properties for a given asset model ID.</p></li>
175    /// <li>
176    /// <p><code>BASE</code> – The list includes only base asset model properties for a given asset model ID.</p></li>
177    /// </ul>
178    /// <p>Default: <code>BASE</code></p>
179    pub fn set_filter(mut self, input: ::std::option::Option<crate::types::ListAssetModelPropertiesFilter>) -> Self {
180        self.inner = self.inner.set_filter(input);
181        self
182    }
183    /// <p>Filters the requested list of asset model properties. You can choose one of the following options:</p>
184    /// <ul>
185    /// <li>
186    /// <p><code>ALL</code> – The list includes all asset model properties for a given asset model ID.</p></li>
187    /// <li>
188    /// <p><code>BASE</code> – The list includes only base asset model properties for a given asset model ID.</p></li>
189    /// </ul>
190    /// <p>Default: <code>BASE</code></p>
191    pub fn get_filter(&self) -> &::std::option::Option<crate::types::ListAssetModelPropertiesFilter> {
192        self.inner.get_filter()
193    }
194    /// <p>The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html"> Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
195    pub fn asset_model_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
196        self.inner = self.inner.asset_model_version(input.into());
197        self
198    }
199    /// <p>The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html"> Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
200    pub fn set_asset_model_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
201        self.inner = self.inner.set_asset_model_version(input);
202        self
203    }
204    /// <p>The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html"> Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
205    pub fn get_asset_model_version(&self) -> &::std::option::Option<::std::string::String> {
206        self.inner.get_asset_model_version()
207    }
208}