aws_sdk_ivs/operation/create_channel/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_channel::_create_channel_output::CreateChannelOutputBuilder;
3
4pub use crate::operation::create_channel::_create_channel_input::CreateChannelInputBuilder;
5
6impl crate::operation::create_channel::builders::CreateChannelInputBuilder {
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_channel::CreateChannelOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_channel::CreateChannelError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_channel();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateChannel`.
24///
25/// <p>Creates a new channel and an associated stream key to start streaming.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateChannelFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::create_channel::builders::CreateChannelInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::create_channel::CreateChannelOutput,
35 crate::operation::create_channel::CreateChannelError,
36 > for CreateChannelFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::create_channel::CreateChannelOutput,
44 crate::operation::create_channel::CreateChannelError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl CreateChannelFluentBuilder {
51 /// Creates a new `CreateChannelFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the CreateChannel as a reference.
60 pub fn as_input(&self) -> &crate::operation::create_channel::builders::CreateChannelInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::create_channel::CreateChannelOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::create_channel::CreateChannelError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::create_channel::CreateChannel::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::create_channel::CreateChannel::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::create_channel::CreateChannelOutput,
97 crate::operation::create_channel::CreateChannelError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>Channel name.</p>
112 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.name(input.into());
114 self
115 }
116 /// <p>Channel name.</p>
117 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_name(input);
119 self
120 }
121 /// <p>Channel name.</p>
122 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_name()
124 }
125 /// <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>
126 pub fn latency_mode(mut self, input: crate::types::ChannelLatencyMode) -> Self {
127 self.inner = self.inner.latency_mode(input);
128 self
129 }
130 /// <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>
131 pub fn set_latency_mode(mut self, input: ::std::option::Option<crate::types::ChannelLatencyMode>) -> Self {
132 self.inner = self.inner.set_latency_mode(input);
133 self
134 }
135 /// <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>
136 pub fn get_latency_mode(&self) -> &::std::option::Option<crate::types::ChannelLatencyMode> {
137 self.inner.get_latency_mode()
138 }
139 /// <p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel Types</a>.</p>
140 pub fn r#type(mut self, input: crate::types::ChannelType) -> Self {
141 self.inner = self.inner.r#type(input);
142 self
143 }
144 /// <p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel Types</a>.</p>
145 pub fn set_type(mut self, input: ::std::option::Option<crate::types::ChannelType>) -> Self {
146 self.inner = self.inner.set_type(input);
147 self
148 }
149 /// <p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel Types</a>.</p>
150 pub fn get_type(&self) -> &::std::option::Option<crate::types::ChannelType> {
151 self.inner.get_type()
152 }
153 /// <p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>
154 pub fn authorized(mut self, input: bool) -> Self {
155 self.inner = self.inner.authorized(input);
156 self
157 }
158 /// <p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>
159 pub fn set_authorized(mut self, input: ::std::option::Option<bool>) -> Self {
160 self.inner = self.inner.set_authorized(input);
161 self
162 }
163 /// <p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>
164 pub fn get_authorized(&self) -> &::std::option::Option<bool> {
165 self.inner.get_authorized()
166 }
167 /// <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).</p>
168 pub fn recording_configuration_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169 self.inner = self.inner.recording_configuration_arn(input.into());
170 self
171 }
172 /// <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).</p>
173 pub fn set_recording_configuration_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174 self.inner = self.inner.set_recording_configuration_arn(input);
175 self
176 }
177 /// <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).</p>
178 pub fn get_recording_configuration_arn(&self) -> &::std::option::Option<::std::string::String> {
179 self.inner.get_recording_configuration_arn()
180 }
181 ///
182 /// Adds a key-value pair to `tags`.
183 ///
184 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
185 ///
186 /// <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.</p>
187 pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
188 self.inner = self.inner.tags(k.into(), v.into());
189 self
190 }
191 /// <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.</p>
192 pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
193 self.inner = self.inner.set_tags(input);
194 self
195 }
196 /// <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.</p>
197 pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
198 self.inner.get_tags()
199 }
200 /// <p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>
201 pub fn insecure_ingest(mut self, input: bool) -> Self {
202 self.inner = self.inner.insecure_ingest(input);
203 self
204 }
205 /// <p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>
206 pub fn set_insecure_ingest(mut self, input: ::std::option::Option<bool>) -> Self {
207 self.inner = self.inner.set_insecure_ingest(input);
208 self
209 }
210 /// <p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>
211 pub fn get_insecure_ingest(&self) -> &::std::option::Option<bool> {
212 self.inner.get_insecure_ingest()
213 }
214 /// <p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty string (<code>""</code>).</p>
215 pub fn preset(mut self, input: crate::types::TranscodePreset) -> Self {
216 self.inner = self.inner.preset(input);
217 self
218 }
219 /// <p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty string (<code>""</code>).</p>
220 pub fn set_preset(mut self, input: ::std::option::Option<crate::types::TranscodePreset>) -> Self {
221 self.inner = self.inner.set_preset(input);
222 self
223 }
224 /// <p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty string (<code>""</code>).</p>
225 pub fn get_preset(&self) -> &::std::option::Option<crate::types::TranscodePreset> {
226 self.inner.get_preset()
227 }
228 /// <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).</p>
229 pub fn playback_restriction_policy_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
230 self.inner = self.inner.playback_restriction_policy_arn(input.into());
231 self
232 }
233 /// <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).</p>
234 pub fn set_playback_restriction_policy_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
235 self.inner = self.inner.set_playback_restriction_policy_arn(input);
236 self
237 }
238 /// <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).</p>
239 pub fn get_playback_restriction_policy_arn(&self) -> &::std::option::Option<::std::string::String> {
240 self.inner.get_playback_restriction_policy_arn()
241 }
242 /// <p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>
243 pub fn multitrack_input_configuration(mut self, input: crate::types::MultitrackInputConfiguration) -> Self {
244 self.inner = self.inner.multitrack_input_configuration(input);
245 self
246 }
247 /// <p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>
248 pub fn set_multitrack_input_configuration(mut self, input: ::std::option::Option<crate::types::MultitrackInputConfiguration>) -> Self {
249 self.inner = self.inner.set_multitrack_input_configuration(input);
250 self
251 }
252 /// <p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>
253 pub fn get_multitrack_input_configuration(&self) -> &::std::option::Option<crate::types::MultitrackInputConfiguration> {
254 self.inner.get_multitrack_input_configuration()
255 }
256 /// <p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>
257 pub fn container_format(mut self, input: crate::types::ContainerFormat) -> Self {
258 self.inner = self.inner.container_format(input);
259 self
260 }
261 /// <p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>
262 pub fn set_container_format(mut self, input: ::std::option::Option<crate::types::ContainerFormat>) -> Self {
263 self.inner = self.inner.set_container_format(input);
264 self
265 }
266 /// <p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>
267 pub fn get_container_format(&self) -> &::std::option::Option<crate::types::ContainerFormat> {
268 self.inner.get_container_format()
269 }
270}