pub struct CreateChannelFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateChannel.
Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
Implementations§
Source§impl CreateChannelFluentBuilder
impl CreateChannelFluentBuilder
Sourcepub fn as_input(&self) -> &CreateChannelInputBuilder
pub fn as_input(&self) -> &CreateChannelInputBuilder
Access the CreateChannel as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateChannelOutput, SdkError<CreateChannelError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateChannelOutput, SdkError<CreateChannelError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateChannelOutput, CreateChannelError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateChannelOutput, CreateChannelError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn channel_group_name(self, input: impl Into<String>) -> Self
pub fn channel_group_name(self, input: impl Into<String>) -> Self
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Sourcepub fn set_channel_group_name(self, input: Option<String>) -> Self
pub fn set_channel_group_name(self, input: Option<String>) -> Self
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Sourcepub fn get_channel_group_name(&self) -> &Option<String>
pub fn get_channel_group_name(&self) -> &Option<String>
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Sourcepub fn channel_name(self, input: impl Into<String>) -> Self
pub fn channel_name(self, input: impl Into<String>) -> Self
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
Sourcepub fn set_channel_name(self, input: Option<String>) -> Self
pub fn set_channel_name(self, input: Option<String>) -> Self
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
Sourcepub fn get_channel_name(&self) -> &Option<String>
pub fn get_channel_name(&self) -> &Option<String>
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn input_type(self, input: InputType) -> Self
pub fn input_type(self, input: InputType) -> Self
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Sourcepub fn set_input_type(self, input: Option<InputType>) -> Self
pub fn set_input_type(self, input: Option<InputType>) -> Self
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Sourcepub fn get_input_type(&self) -> &Option<InputType>
pub fn get_input_type(&self) -> &Option<InputType>
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
-
HLS- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
Enter any descriptive text that helps you to identify the channel.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
Enter any descriptive text that helps you to identify the channel.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
Enter any descriptive text that helps you to identify the channel.
Sourcepub fn input_switch_configuration(self, input: InputSwitchConfiguration) -> Self
pub fn input_switch_configuration(self, input: InputSwitchConfiguration) -> Self
The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.
Sourcepub fn set_input_switch_configuration(
self,
input: Option<InputSwitchConfiguration>,
) -> Self
pub fn set_input_switch_configuration( self, input: Option<InputSwitchConfiguration>, ) -> Self
The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.
Sourcepub fn get_input_switch_configuration(
&self,
) -> &Option<InputSwitchConfiguration>
pub fn get_input_switch_configuration( &self, ) -> &Option<InputSwitchConfiguration>
The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.
Sourcepub fn output_header_configuration(
self,
input: OutputHeaderConfiguration,
) -> Self
pub fn output_header_configuration( self, input: OutputHeaderConfiguration, ) -> Self
The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.
Sourcepub fn set_output_header_configuration(
self,
input: Option<OutputHeaderConfiguration>,
) -> Self
pub fn set_output_header_configuration( self, input: Option<OutputHeaderConfiguration>, ) -> Self
The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.
Sourcepub fn get_output_header_configuration(
&self,
) -> &Option<OutputHeaderConfiguration>
pub fn get_output_header_configuration( &self, ) -> &Option<OutputHeaderConfiguration>
The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.
Adds a key-value pair to Tags.
To override the contents of this collection use set_tags.
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1",
"Key2": "Value2"
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1",
"Key2": "Value2"
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1",
"Key2": "Value2"
Trait Implementations§
Source§impl Clone for CreateChannelFluentBuilder
impl Clone for CreateChannelFluentBuilder
Source§fn clone(&self) -> CreateChannelFluentBuilder
fn clone(&self) -> CreateChannelFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateChannelFluentBuilder
impl !RefUnwindSafe for CreateChannelFluentBuilder
impl Send for CreateChannelFluentBuilder
impl Sync for CreateChannelFluentBuilder
impl Unpin for CreateChannelFluentBuilder
impl !UnwindSafe for CreateChannelFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);