aws_sdk_arcregionswitch/waiters/
plan_execution_completed.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `plan_execution_completed` 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 PlanExecutionCompletedFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::get_plan_execution::builders::GetPlanExecutionInputBuilder,
18}
19impl PlanExecutionCompletedFluentBuilder {
20    /// Creates a new `PlanExecutionCompletedFluentBuilder`.
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 GetPlanExecution as a reference.
28    pub fn as_input(&self) -> &crate::operation::get_plan_execution::builders::GetPlanExecutionInputBuilder {
29        &self.inner
30    }
31    /// Wait for `plan_execution_completed`
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::plan_execution_completed::PlanExecutionCompletedFinalPoll,
37        crate::waiters::plan_execution_completed::WaitUntilPlanExecutionCompletedError,
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::get_plan_execution::GetPlanExecution::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::get_plan_execution::GetPlanExecutionOutput,
59            &crate::operation::get_plan_execution::GetPlanExecutionError,
60        >| {
61            // Matches: {"output":{"path":"executionState","expected":"completed","comparator":"stringEquals"}}
62            if crate::waiters::matchers::match_get_plan_execution_d6d50c338ff5a44a9(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"executionState","expected":"completedWithExceptions","comparator":"stringEquals"}}
66            if crate::waiters::matchers::match_get_plan_execution_73c5112ac2d8d28a1(result) {
67                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
68            }
69            // Matches: {"output":{"path":"executionState","expected":"failed","comparator":"stringEquals"}}
70            if crate::waiters::matchers::match_get_plan_execution_3a1384a8d3c648582(result) {
71                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
72            }
73            // Matches: {"output":{"path":"executionState","expected":"canceled","comparator":"stringEquals"}}
74            if crate::waiters::matchers::match_get_plan_execution_a509573ecc4408e2d(result) {
75                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
76            }
77            // Matches: {"output":{"path":"executionState","expected":"planExecutionTimedOut","comparator":"stringEquals"}}
78            if crate::waiters::matchers::match_get_plan_execution_d2e91ed24bf36ed01(result) {
79                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
80            }
81            ::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
82        };
83        let operation = move || {
84            let input = input.clone();
85            let runtime_plugins = runtime_plugins.clone();
86            async move { crate::operation::get_plan_execution::GetPlanExecution::orchestrate(&runtime_plugins, input).await }
87        };
88        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
89            .min_delay(::std::time::Duration::from_secs(30))
90            .max_delay(::std::time::Duration::from_secs(120))
91            .max_wait(max_wait)
92            .time_source(time_source)
93            .sleep_impl(sleep_impl)
94            .acceptor(acceptor)
95            .operation(operation)
96            .build();
97        ::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
98    }
99    /// <p>The Amazon Resource Name (ARN) of the plan with the execution to retrieve.</p>
100    pub fn plan_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
101        self.inner = self.inner.plan_arn(input.into());
102        self
103    }
104    /// <p>The Amazon Resource Name (ARN) of the plan with the execution to retrieve.</p>
105    pub fn set_plan_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
106        self.inner = self.inner.set_plan_arn(input);
107        self
108    }
109    /// <p>The Amazon Resource Name (ARN) of the plan with the execution to retrieve.</p>
110    pub fn get_plan_arn(&self) -> &::std::option::Option<::std::string::String> {
111        self.inner.get_plan_arn()
112    }
113    /// <p>The execution identifier of a plan execution.</p>
114    pub fn execution_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.execution_id(input.into());
116        self
117    }
118    /// <p>The execution identifier of a plan execution.</p>
119    pub fn set_execution_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_execution_id(input);
121        self
122    }
123    /// <p>The execution identifier of a plan execution.</p>
124    pub fn get_execution_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_execution_id()
126    }
127    /// <p>The number of objects that you want to return with this call.</p>
128    pub fn max_results(mut self, input: i32) -> Self {
129        self.inner = self.inner.max_results(input);
130        self
131    }
132    /// <p>The number of objects that you want to return with this call.</p>
133    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
134        self.inner = self.inner.set_max_results(input);
135        self
136    }
137    /// <p>The number of objects that you want to return with this call.</p>
138    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
139        self.inner.get_max_results()
140    }
141    /// <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
142    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.next_token(input.into());
144        self
145    }
146    /// <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
147    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_next_token(input);
149        self
150    }
151    /// <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
152    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_next_token()
154    }
155}
156
157/// Successful return type for the `plan_execution_completed` waiter.
158pub type PlanExecutionCompletedFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
159    crate::operation::get_plan_execution::GetPlanExecutionOutput,
160    ::aws_smithy_runtime_api::client::result::SdkError<
161        crate::operation::get_plan_execution::GetPlanExecutionError,
162        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
163    >,
164>;
165
166/// Error type for the `plan_execution_completed` waiter.
167pub type WaitUntilPlanExecutionCompletedError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
168    crate::operation::get_plan_execution::GetPlanExecutionOutput,
169    crate::operation::get_plan_execution::GetPlanExecutionError,
170>;