aws_sdk_elasticbeanstalk/waiters/
environment_exists.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `environment_exists` 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 EnvironmentExistsFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::describe_environments::builders::DescribeEnvironmentsInputBuilder,
18}
19impl EnvironmentExistsFluentBuilder {
20    /// Creates a new `EnvironmentExistsFluentBuilder`.
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 DescribeEnvironments as a reference.
28    pub fn as_input(&self) -> &crate::operation::describe_environments::builders::DescribeEnvironmentsInputBuilder {
29        &self.inner
30    }
31    /// Wait for `environment_exists`
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::environment_exists::EnvironmentExistsFinalPoll,
37        crate::waiters::environment_exists::WaitUntilEnvironmentExistsError,
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_environments::DescribeEnvironments::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_environments::DescribeEnvironmentsOutput,
59            &crate::operation::describe_environments::DescribeEnvironmentsError,
60        >| {
61            // Matches: {"output":{"path":"Environments[].Status","expected":"Ready","comparator":"allStringEquals"}}
62            if crate::waiters::matchers::match_describe_environments_0c537620ab36f6939(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"Environments[].Status","expected":"Launching","comparator":"allStringEquals"}}
66            if crate::waiters::matchers::match_describe_environments_5274bc882067d5d8d(result) {
67                return ::aws_smithy_runtime::client::waiters::AcceptorState::Retry;
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_environments::DescribeEnvironments::orchestrate(&runtime_plugins, input).await }
75        };
76        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
77            .min_delay(::std::time::Duration::from_secs(20))
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>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.</p>
88    pub fn application_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
89        self.inner = self.inner.application_name(input.into());
90        self
91    }
92    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.</p>
93    pub fn set_application_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
94        self.inner = self.inner.set_application_name(input);
95        self
96    }
97    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.</p>
98    pub fn get_application_name(&self) -> &::std::option::Option<::std::string::String> {
99        self.inner.get_application_name()
100    }
101    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.</p>
102    pub fn version_label(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
103        self.inner = self.inner.version_label(input.into());
104        self
105    }
106    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.</p>
107    pub fn set_version_label(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
108        self.inner = self.inner.set_version_label(input);
109        self
110    }
111    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.</p>
112    pub fn get_version_label(&self) -> &::std::option::Option<::std::string::String> {
113        self.inner.get_version_label()
114    }
115    ///
116    /// Appends an item to `EnvironmentIds`.
117    ///
118    /// To override the contents of this collection use [`set_environment_ids`](Self::set_environment_ids).
119    ///
120    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.</p>
121    pub fn environment_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.environment_ids(input.into());
123        self
124    }
125    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.</p>
126    pub fn set_environment_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
127        self.inner = self.inner.set_environment_ids(input);
128        self
129    }
130    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.</p>
131    pub fn get_environment_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
132        self.inner.get_environment_ids()
133    }
134    ///
135    /// Appends an item to `EnvironmentNames`.
136    ///
137    /// To override the contents of this collection use [`set_environment_names`](Self::set_environment_names).
138    ///
139    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.</p>
140    pub fn environment_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.environment_names(input.into());
142        self
143    }
144    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.</p>
145    pub fn set_environment_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
146        self.inner = self.inner.set_environment_names(input);
147        self
148    }
149    /// <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.</p>
150    pub fn get_environment_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
151        self.inner.get_environment_names()
152    }
153    /// <p>Indicates whether to include deleted environments:</p>
154    /// <p><code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed.</p>
155    /// <p><code>false</code>: Do not include deleted environments.</p>
156    pub fn include_deleted(mut self, input: bool) -> Self {
157        self.inner = self.inner.include_deleted(input);
158        self
159    }
160    /// <p>Indicates whether to include deleted environments:</p>
161    /// <p><code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed.</p>
162    /// <p><code>false</code>: Do not include deleted environments.</p>
163    pub fn set_include_deleted(mut self, input: ::std::option::Option<bool>) -> Self {
164        self.inner = self.inner.set_include_deleted(input);
165        self
166    }
167    /// <p>Indicates whether to include deleted environments:</p>
168    /// <p><code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed.</p>
169    /// <p><code>false</code>: Do not include deleted environments.</p>
170    pub fn get_include_deleted(&self) -> &::std::option::Option<bool> {
171        self.inner.get_include_deleted()
172    }
173    /// <p>If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed.</p>
174    pub fn included_deleted_back_to(mut self, input: ::aws_smithy_types::DateTime) -> Self {
175        self.inner = self.inner.included_deleted_back_to(input);
176        self
177    }
178    /// <p>If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed.</p>
179    pub fn set_included_deleted_back_to(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
180        self.inner = self.inner.set_included_deleted_back_to(input);
181        self
182    }
183    /// <p>If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed.</p>
184    pub fn get_included_deleted_back_to(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
185        self.inner.get_included_deleted_back_to()
186    }
187    /// <p>For a paginated request. Specify a maximum number of environments to include in each response.</p>
188    /// <p>If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.</p>
189    pub fn max_records(mut self, input: i32) -> Self {
190        self.inner = self.inner.max_records(input);
191        self
192    }
193    /// <p>For a paginated request. Specify a maximum number of environments to include in each response.</p>
194    /// <p>If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.</p>
195    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
196        self.inner = self.inner.set_max_records(input);
197        self
198    }
199    /// <p>For a paginated request. Specify a maximum number of environments to include in each response.</p>
200    /// <p>If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.</p>
201    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
202        self.inner.get_max_records()
203    }
204    /// <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>
205    /// <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
206    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
207        self.inner = self.inner.next_token(input.into());
208        self
209    }
210    /// <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>
211    /// <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
212    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
213        self.inner = self.inner.set_next_token(input);
214        self
215    }
216    /// <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>
217    /// <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
218    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
219        self.inner.get_next_token()
220    }
221}
222
223/// Successful return type for the `environment_exists` waiter.
224pub type EnvironmentExistsFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
225    crate::operation::describe_environments::DescribeEnvironmentsOutput,
226    ::aws_smithy_runtime_api::client::result::SdkError<
227        crate::operation::describe_environments::DescribeEnvironmentsError,
228        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
229    >,
230>;
231
232/// Error type for the `environment_exists` waiter.
233pub type WaitUntilEnvironmentExistsError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
234    crate::operation::describe_environments::DescribeEnvironmentsOutput,
235    crate::operation::describe_environments::DescribeEnvironmentsError,
236>;
aws_sdk_elasticbeanstalk/waiters/environment_exists.rs

aws_sdk_elasticbeanstalk/waiters/
environment_exists.rs
