aws_sdk_iotsitewise/waiters/
asset_model_active.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `asset_model_active` waiter.
5///
6/// This builder is intended to be used similar to the other fluent builders for
7/// normal operations on the client. However, instead of a `send` method, it has
8/// a `wait` method that takes a maximum amount of time to wait.
9///
10/// Construct this fluent builder using the client by importing the
11/// [`Waiters`](crate::client::Waiters) trait and calling the methods
12/// prefixed with `wait_until`.
13///
14#[derive(::std::clone::Clone, ::std::fmt::Debug)]
15pub struct AssetModelActiveFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::describe_asset_model::builders::DescribeAssetModelInputBuilder,
18}
19impl AssetModelActiveFluentBuilder {
20    /// Creates a new `AssetModelActiveFluentBuilder`.
21    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
22        Self {
23            handle,
24            inner: ::std::default::Default::default(),
25        }
26    }
27    /// Access the DescribeAssetModel as a reference.
28    pub fn as_input(&self) -> &crate::operation::describe_asset_model::builders::DescribeAssetModelInputBuilder {
29        &self.inner
30    }
31    /// Wait for `asset_model_active`
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::asset_model_active::AssetModelActiveFinalPoll,
37        crate::waiters::asset_model_active::WaitUntilAssetModelActiveError,
38    > {
39        let input = self
40            .inner
41            .build()
42            .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
43        let runtime_plugins = crate::operation::describe_asset_model::DescribeAssetModel::operation_runtime_plugins(
44            self.handle.runtime_plugins.clone(),
45            &self.handle.conf,
46            ::std::option::Option::None,
47        )
48        .with_operation_plugin(crate::sdk_feature_tracker::waiter::WaiterFeatureTrackerRuntimePlugin::new());
49        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
50        let runtime_components_builder = runtime_plugins
51            .apply_client_configuration(&mut cfg)
52            .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
53        let time_components = runtime_components_builder.into_time_components();
54        let sleep_impl = time_components.sleep_impl().expect("a sleep impl is required by waiters");
55        let time_source = time_components.time_source().expect("a time source is required by waiters");
56
57        let acceptor = move |result: ::std::result::Result<
58            &crate::operation::describe_asset_model::DescribeAssetModelOutput,
59            &crate::operation::describe_asset_model::DescribeAssetModelError,
60        >| {
61            // Matches: {"output":{"path":"assetModelStatus.state","expected":"ACTIVE","comparator":"stringEquals"}}
62            if crate::waiters::matchers::match_describe_asset_model_356d04b58e720c0ba(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"assetModelStatus.state","expected":"FAILED","comparator":"stringEquals"}}
66            if crate::waiters::matchers::match_describe_asset_model_ff8b4ad9689c7214b(result) {
67                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
68            }
69            ::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
70        };
71        let operation = move || {
72            let input = input.clone();
73            let runtime_plugins = runtime_plugins.clone();
74            async move { crate::operation::describe_asset_model::DescribeAssetModel::orchestrate(&runtime_plugins, input).await }
75        };
76        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
77            .min_delay(::std::time::Duration::from_secs(3))
78            .max_delay(::std::time::Duration::from_secs(120))
79            .max_wait(max_wait)
80            .time_source(time_source)
81            .sleep_impl(sleep_impl)
82            .acceptor(acceptor)
83            .operation(operation)
84            .build();
85        ::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
86    }
87    /// <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>
88    pub fn asset_model_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
89        self.inner = self.inner.asset_model_id(input.into());
90        self
91    }
92    /// <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>
93    pub fn set_asset_model_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
94        self.inner = self.inner.set_asset_model_id(input);
95        self
96    }
97    /// <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>
98    pub fn get_asset_model_id(&self) -> &::std::option::Option<::std::string::String> {
99        self.inner.get_asset_model_id()
100    }
101    /// <p>Whether or not to exclude asset model properties from the response.</p>
102    pub fn exclude_properties(mut self, input: bool) -> Self {
103        self.inner = self.inner.exclude_properties(input);
104        self
105    }
106    /// <p>Whether or not to exclude asset model properties from the response.</p>
107    pub fn set_exclude_properties(mut self, input: ::std::option::Option<bool>) -> Self {
108        self.inner = self.inner.set_exclude_properties(input);
109        self
110    }
111    /// <p>Whether or not to exclude asset model properties from the response.</p>
112    pub fn get_exclude_properties(&self) -> &::std::option::Option<bool> {
113        self.inner.get_exclude_properties()
114    }
115    /// <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>
116    pub fn asset_model_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.asset_model_version(input.into());
118        self
119    }
120    /// <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>
121    pub fn set_asset_model_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_asset_model_version(input);
123        self
124    }
125    /// <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>
126    pub fn get_asset_model_version(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_asset_model_version()
128    }
129}
130
131/// Successful return type for the `asset_model_active` waiter.
132pub type AssetModelActiveFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
133    crate::operation::describe_asset_model::DescribeAssetModelOutput,
134    ::aws_smithy_runtime_api::client::result::SdkError<
135        crate::operation::describe_asset_model::DescribeAssetModelError,
136        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
137    >,
138>;
139
140/// Error type for the `asset_model_active` waiter.
141pub type WaitUntilAssetModelActiveError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
142    crate::operation::describe_asset_model::DescribeAssetModelOutput,
143    crate::operation::describe_asset_model::DescribeAssetModelError,
144>;
aws_sdk_iotsitewise/waiters/asset_model_active.rs

aws_sdk_iotsitewise/waiters/
asset_model_active.rs
