#[non_exhaustive]pub struct IngestConfigurationBuilder { /* private fields */ }
Expand description
A builder for IngestConfiguration
.
Implementations§
Source§impl IngestConfigurationBuilder
impl IngestConfigurationBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
Ingest configuration ARN.
This field is required.Sourcepub fn ingest_protocol(self, input: IngestProtocol) -> Self
pub fn ingest_protocol(self, input: IngestProtocol) -> Self
Type of ingest protocol that the user employs for broadcasting.
This field is required.Sourcepub fn set_ingest_protocol(self, input: Option<IngestProtocol>) -> Self
pub fn set_ingest_protocol(self, input: Option<IngestProtocol>) -> Self
Type of ingest protocol that the user employs for broadcasting.
Sourcepub fn get_ingest_protocol(&self) -> &Option<IngestProtocol>
pub fn get_ingest_protocol(&self) -> &Option<IngestProtocol>
Type of ingest protocol that the user employs for broadcasting.
Sourcepub fn stream_key(self, input: impl Into<String>) -> Self
pub fn stream_key(self, input: impl Into<String>) -> Self
Ingest-key value for the RTMP(S) protocol.
This field is required.Sourcepub fn set_stream_key(self, input: Option<String>) -> Self
pub fn set_stream_key(self, input: Option<String>) -> Self
Ingest-key value for the RTMP(S) protocol.
Sourcepub fn get_stream_key(&self) -> &Option<String>
pub fn get_stream_key(&self) -> &Option<String>
Ingest-key value for the RTMP(S) protocol.
Sourcepub fn stage_arn(self, input: impl Into<String>) -> Self
pub fn stage_arn(self, input: impl Into<String>) -> Self
ARN of the stage with which the IngestConfiguration is associated.
This field is required.Sourcepub fn set_stage_arn(self, input: Option<String>) -> Self
pub fn set_stage_arn(self, input: Option<String>) -> Self
ARN of the stage with which the IngestConfiguration is associated.
Sourcepub fn get_stage_arn(&self) -> &Option<String>
pub fn get_stage_arn(&self) -> &Option<String>
ARN of the stage with which the IngestConfiguration is associated.
Sourcepub fn participant_id(self, input: impl Into<String>) -> Self
pub fn participant_id(self, input: impl Into<String>) -> Self
ID of the participant within the stage.
This field is required.Sourcepub fn set_participant_id(self, input: Option<String>) -> Self
pub fn set_participant_id(self, input: Option<String>) -> Self
ID of the participant within the stage.
Sourcepub fn get_participant_id(&self) -> &Option<String>
pub fn get_participant_id(&self) -> &Option<String>
ID of the participant within the stage.
Sourcepub fn state(self, input: IngestConfigurationState) -> Self
pub fn state(self, input: IngestConfigurationState) -> Self
State of the ingest configuration. It is ACTIVE
if a publisher currently is publishing to the stage associated with the ingest configuration.
Sourcepub fn set_state(self, input: Option<IngestConfigurationState>) -> Self
pub fn set_state(self, input: Option<IngestConfigurationState>) -> Self
State of the ingest configuration. It is ACTIVE
if a publisher currently is publishing to the stage associated with the ingest configuration.
Sourcepub fn get_state(&self) -> &Option<IngestConfigurationState>
pub fn get_state(&self) -> &Option<IngestConfigurationState>
State of the ingest configuration. It is ACTIVE
if a publisher currently is publishing to the stage associated with the ingest configuration.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &Option<String>
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
Application-provided attributes to to store in the IngestConfiguration 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. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
Application-provided attributes to to store in the IngestConfiguration 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. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_attributes(&self) -> &Option<HashMap<String, String>>
Application-provided attributes to to store in the IngestConfiguration 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. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Sourcepub fn build(self) -> Result<IngestConfiguration, BuildError>
pub fn build(self) -> Result<IngestConfiguration, BuildError>
Consumes the builder and constructs a IngestConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for IngestConfigurationBuilder
impl Clone for IngestConfigurationBuilder
Source§fn clone(&self) -> IngestConfigurationBuilder
fn clone(&self) -> IngestConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for IngestConfigurationBuilder
impl Debug for IngestConfigurationBuilder
Source§impl Default for IngestConfigurationBuilder
impl Default for IngestConfigurationBuilder
Source§fn default() -> IngestConfigurationBuilder
fn default() -> IngestConfigurationBuilder
impl StructuralPartialEq for IngestConfigurationBuilder
Auto Trait Implementations§
impl Freeze for IngestConfigurationBuilder
impl RefUnwindSafe for IngestConfigurationBuilder
impl Send for IngestConfigurationBuilder
impl Sync for IngestConfigurationBuilder
impl Unpin for IngestConfigurationBuilder
impl UnwindSafe for IngestConfigurationBuilder
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);