aws_sdk_gameliftstreams/waiters/
stream_session_active.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `stream_session_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 StreamSessionActiveFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::get_stream_session::builders::GetStreamSessionInputBuilder,
18}
19impl StreamSessionActiveFluentBuilder {
20    /// Creates a new `StreamSessionActiveFluentBuilder`.
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 GetStreamSession as a reference.
28    pub fn as_input(&self) -> &crate::operation::get_stream_session::builders::GetStreamSessionInputBuilder {
29        &self.inner
30    }
31    /// Waits until a stream session is active
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::stream_session_active::StreamSessionActiveFinalPoll,
37        crate::waiters::stream_session_active::WaitUntilStreamSessionActiveError,
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_stream_session::GetStreamSession::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_stream_session::GetStreamSessionOutput,
59            &crate::operation::get_stream_session::GetStreamSessionError,
60        >| {
61            // Matches: {"output":{"path":"Status","expected":"ACTIVE","comparator":"stringEquals"}}
62            if crate::waiters::matchers::match_get_stream_session_43a57eebc26a79968(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"Status","expected":"ERROR","comparator":"stringEquals"}}
66            if crate::waiters::matchers::match_get_stream_session_bd8922a7d94e1a858(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::get_stream_session::GetStreamSession::orchestrate(&runtime_plugins, input).await }
75        };
76        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
77            .min_delay(::std::time::Duration::from_secs(2))
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 stream group that runs this stream session.</p>
88    /// <p>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p>
89    pub fn identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
90        self.inner = self.inner.identifier(input.into());
91        self
92    }
93    /// <p>The stream group that runs this stream session.</p>
94    /// <p>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p>
95    pub fn set_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
96        self.inner = self.inner.set_identifier(input);
97        self
98    }
99    /// <p>The stream group that runs this stream session.</p>
100    /// <p>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p>
101    pub fn get_identifier(&self) -> &::std::option::Option<::std::string::String> {
102        self.inner.get_identifier()
103    }
104    /// <p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</code>. Example ID: <code>ABC123def4567</code>.</p>
105    pub fn stream_session_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
106        self.inner = self.inner.stream_session_identifier(input.into());
107        self
108    }
109    /// <p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</code>. Example ID: <code>ABC123def4567</code>.</p>
110    pub fn set_stream_session_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
111        self.inner = self.inner.set_stream_session_identifier(input);
112        self
113    }
114    /// <p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</code>. Example ID: <code>ABC123def4567</code>.</p>
115    pub fn get_stream_session_identifier(&self) -> &::std::option::Option<::std::string::String> {
116        self.inner.get_stream_session_identifier()
117    }
118}
119
120/// Successful return type for the `stream_session_active` waiter.
121pub type StreamSessionActiveFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
122    crate::operation::get_stream_session::GetStreamSessionOutput,
123    ::aws_smithy_runtime_api::client::result::SdkError<
124        crate::operation::get_stream_session::GetStreamSessionError,
125        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
126    >,
127>;
128
129/// Error type for the `stream_session_active` waiter.
130pub type WaitUntilStreamSessionActiveError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
131    crate::operation::get_stream_session::GetStreamSessionOutput,
132    crate::operation::get_stream_session::GetStreamSessionError,
133>;
aws_sdk_gameliftstreams/waiters/stream_session_active.rs

aws_sdk_gameliftstreams/waiters/
stream_session_active.rs
