aws_sdk_ivsrealtime/operation/create_participant_token/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_participant_token::_create_participant_token_output::CreateParticipantTokenOutputBuilder;
3
4pub use crate::operation::create_participant_token::_create_participant_token_input::CreateParticipantTokenInputBuilder;
5
6impl crate::operation::create_participant_token::builders::CreateParticipantTokenInputBuilder {
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::create_participant_token::CreateParticipantTokenOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_participant_token::CreateParticipantTokenError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_participant_token();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateParticipantToken`.
24///
25/// <p>Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.</p>
26/// <p>Encryption keys are owned by Amazon IVS and never used directly by your application.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateParticipantTokenFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_participant_token::builders::CreateParticipantTokenInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_participant_token::CreateParticipantTokenOutput,
36        crate::operation::create_participant_token::CreateParticipantTokenError,
37    > for CreateParticipantTokenFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::create_participant_token::CreateParticipantTokenOutput,
45            crate::operation::create_participant_token::CreateParticipantTokenError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateParticipantTokenFluentBuilder {
52    /// Creates a new `CreateParticipantTokenFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the CreateParticipantToken as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_participant_token::builders::CreateParticipantTokenInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::create_participant_token::CreateParticipantTokenOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_participant_token::CreateParticipantTokenError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::create_participant_token::CreateParticipantToken::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_participant_token::CreateParticipantToken::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::create_participant_token::CreateParticipantTokenOutput,
98        crate::operation::create_participant_token::CreateParticipantTokenError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>ARN of the stage to which this token is scoped.</p>
113    pub fn stage_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.stage_arn(input.into());
115        self
116    }
117    /// <p>ARN of the stage to which this token is scoped.</p>
118    pub fn set_stage_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_stage_arn(input);
120        self
121    }
122    /// <p>ARN of the stage to which this token is scoped.</p>
123    pub fn get_stage_arn(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_stage_arn()
125    }
126    /// <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
127    pub fn duration(mut self, input: i32) -> Self {
128        self.inner = self.inner.duration(input);
129        self
130    }
131    /// <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
132    pub fn set_duration(mut self, input: ::std::option::Option<i32>) -> Self {
133        self.inner = self.inner.set_duration(input);
134        self
135    }
136    /// <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
137    pub fn get_duration(&self) -> &::std::option::Option<i32> {
138        self.inner.get_duration()
139    }
140    /// <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
141    pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.user_id(input.into());
143        self
144    }
145    /// <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
146    pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_user_id(input);
148        self
149    }
150    /// <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
151    pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_user_id()
153    }
154    ///
155    /// Adds a key-value pair to `attributes`.
156    ///
157    /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
158    ///
159    /// <p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
160    pub fn attributes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.attributes(k.into(), v.into());
162        self
163    }
164    /// <p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
165    pub fn set_attributes(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
166        self.inner = self.inner.set_attributes(input);
167        self
168    }
169    /// <p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
170    pub fn get_attributes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
171        self.inner.get_attributes()
172    }
173    ///
174    /// Appends an item to `capabilities`.
175    ///
176    /// To override the contents of this collection use [`set_capabilities`](Self::set_capabilities).
177    ///
178    /// <p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>
179    pub fn capabilities(mut self, input: crate::types::ParticipantTokenCapability) -> Self {
180        self.inner = self.inner.capabilities(input);
181        self
182    }
183    /// <p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>
184    pub fn set_capabilities(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ParticipantTokenCapability>>) -> Self {
185        self.inner = self.inner.set_capabilities(input);
186        self
187    }
188    /// <p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>
189    pub fn get_capabilities(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ParticipantTokenCapability>> {
190        self.inner.get_capabilities()
191    }
192}
aws_sdk_ivsrealtime/operation/create_participant_token/builders.rs

aws_sdk_ivsrealtime/operation/create_participant_token/
builders.rs
