#[non_exhaustive]pub struct FlowBuilder { /* private fields */ }
Expand description
A builder for Flow
.
Implementations§
Source§impl FlowBuilder
impl FlowBuilder
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
This field is required.Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the flow. This value is not used or seen outside of the current MediaConnect account.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the flow. This value is not used or seen outside of the current MediaConnect account.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the flow. This value is not used or seen outside of the current MediaConnect account.
Sourcepub fn egress_ip(self, input: impl Into<String>) -> Self
pub fn egress_ip(self, input: impl Into<String>) -> Self
The IP address from which video will be sent to output destinations.
Sourcepub fn set_egress_ip(self, input: Option<String>) -> Self
pub fn set_egress_ip(self, input: Option<String>) -> Self
The IP address from which video will be sent to output destinations.
Sourcepub fn get_egress_ip(&self) -> &Option<String>
pub fn get_egress_ip(&self) -> &Option<String>
The IP address from which video will be sent to output destinations.
Sourcepub fn entitlements(self, input: Entitlement) -> Self
pub fn entitlements(self, input: Entitlement) -> Self
Appends an item to entitlements
.
To override the contents of this collection use set_entitlements
.
The entitlements in this flow.
Sourcepub fn set_entitlements(self, input: Option<Vec<Entitlement>>) -> Self
pub fn set_entitlements(self, input: Option<Vec<Entitlement>>) -> Self
The entitlements in this flow.
Sourcepub fn get_entitlements(&self) -> &Option<Vec<Entitlement>>
pub fn get_entitlements(&self) -> &Option<Vec<Entitlement>>
The entitlements in this flow.
Sourcepub fn flow_arn(self, input: impl Into<String>) -> Self
pub fn flow_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the flow.
This field is required.Sourcepub fn set_flow_arn(self, input: Option<String>) -> Self
pub fn set_flow_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the flow.
Sourcepub fn get_flow_arn(&self) -> &Option<String>
pub fn get_flow_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the flow.
Sourcepub fn media_streams(self, input: MediaStream) -> Self
pub fn media_streams(self, input: MediaStream) -> Self
Appends an item to media_streams
.
To override the contents of this collection use set_media_streams
.
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
Sourcepub fn set_media_streams(self, input: Option<Vec<MediaStream>>) -> Self
pub fn set_media_streams(self, input: Option<Vec<MediaStream>>) -> Self
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
Sourcepub fn get_media_streams(&self) -> &Option<Vec<MediaStream>>
pub fn get_media_streams(&self) -> &Option<Vec<MediaStream>>
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the flow.
This field is required.Sourcepub fn outputs(self, input: Output) -> Self
pub fn outputs(self, input: Output) -> Self
Appends an item to outputs
.
To override the contents of this collection use set_outputs
.
The outputs in this flow.
Sourcepub fn set_outputs(self, input: Option<Vec<Output>>) -> Self
pub fn set_outputs(self, input: Option<Vec<Output>>) -> Self
The outputs in this flow.
Sourcepub fn get_outputs(&self) -> &Option<Vec<Output>>
pub fn get_outputs(&self) -> &Option<Vec<Output>>
The outputs in this flow.
Sourcepub fn set_source(self, input: Option<Source>) -> Self
pub fn set_source(self, input: Option<Source>) -> Self
The source for the flow.
Sourcepub fn get_source(&self) -> &Option<Source>
pub fn get_source(&self) -> &Option<Source>
The source for the flow.
Sourcepub fn source_failover_config(self, input: FailoverConfig) -> Self
pub fn source_failover_config(self, input: FailoverConfig) -> Self
The settings for the source failover.
Sourcepub fn set_source_failover_config(self, input: Option<FailoverConfig>) -> Self
pub fn set_source_failover_config(self, input: Option<FailoverConfig>) -> Self
The settings for the source failover.
Sourcepub fn get_source_failover_config(&self) -> &Option<FailoverConfig>
pub fn get_source_failover_config(&self) -> &Option<FailoverConfig>
The settings for the source failover.
Sourcepub fn sources(self, input: Source) -> Self
pub fn sources(self, input: Source) -> Self
Appends an item to sources
.
To override the contents of this collection use set_sources
.
The settings for the sources that are assigned to the flow.
Sourcepub fn set_sources(self, input: Option<Vec<Source>>) -> Self
pub fn set_sources(self, input: Option<Vec<Source>>) -> Self
The settings for the sources that are assigned to the flow.
Sourcepub fn get_sources(&self) -> &Option<Vec<Source>>
pub fn get_sources(&self) -> &Option<Vec<Source>>
The settings for the sources that are assigned to the flow.
Sourcepub fn status(self, input: Status) -> Self
pub fn status(self, input: Status) -> Self
The current status of the flow.
This field is required.Sourcepub fn set_status(self, input: Option<Status>) -> Self
pub fn set_status(self, input: Option<Status>) -> Self
The current status of the flow.
Sourcepub fn get_status(&self) -> &Option<Status>
pub fn get_status(&self) -> &Option<Status>
The current status of the flow.
Sourcepub fn vpc_interfaces(self, input: VpcInterface) -> Self
pub fn vpc_interfaces(self, input: VpcInterface) -> Self
Appends an item to vpc_interfaces
.
To override the contents of this collection use set_vpc_interfaces
.
The VPC Interfaces for this flow.
Sourcepub fn set_vpc_interfaces(self, input: Option<Vec<VpcInterface>>) -> Self
pub fn set_vpc_interfaces(self, input: Option<Vec<VpcInterface>>) -> Self
The VPC Interfaces for this flow.
Sourcepub fn get_vpc_interfaces(&self) -> &Option<Vec<VpcInterface>>
pub fn get_vpc_interfaces(&self) -> &Option<Vec<VpcInterface>>
The VPC Interfaces for this flow.
Sourcepub fn maintenance(self, input: Maintenance) -> Self
pub fn maintenance(self, input: Maintenance) -> Self
The maintenance settings for the flow.
Sourcepub fn set_maintenance(self, input: Option<Maintenance>) -> Self
pub fn set_maintenance(self, input: Option<Maintenance>) -> Self
The maintenance settings for the flow.
Sourcepub fn get_maintenance(&self) -> &Option<Maintenance>
pub fn get_maintenance(&self) -> &Option<Maintenance>
The maintenance settings for the flow.
Sourcepub fn source_monitoring_config(self, input: MonitoringConfig) -> Self
pub fn source_monitoring_config(self, input: MonitoringConfig) -> Self
The settings for source monitoring.
Sourcepub fn set_source_monitoring_config(
self,
input: Option<MonitoringConfig>,
) -> Self
pub fn set_source_monitoring_config( self, input: Option<MonitoringConfig>, ) -> Self
The settings for source monitoring.
Sourcepub fn get_source_monitoring_config(&self) -> &Option<MonitoringConfig>
pub fn get_source_monitoring_config(&self) -> &Option<MonitoringConfig>
The settings for source monitoring.
Sourcepub fn flow_size(self, input: FlowSize) -> Self
pub fn flow_size(self, input: FlowSize) -> Self
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
Sourcepub fn set_flow_size(self, input: Option<FlowSize>) -> Self
pub fn set_flow_size(self, input: Option<FlowSize>) -> Self
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
Sourcepub fn get_flow_size(&self) -> &Option<FlowSize>
pub fn get_flow_size(&self) -> &Option<FlowSize>
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
Sourcepub fn ndi_config(self, input: NdiConfig) -> Self
pub fn ndi_config(self, input: NdiConfig) -> Self
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Sourcepub fn set_ndi_config(self, input: Option<NdiConfig>) -> Self
pub fn set_ndi_config(self, input: Option<NdiConfig>) -> Self
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Sourcepub fn get_ndi_config(&self) -> &Option<NdiConfig>
pub fn get_ndi_config(&self) -> &Option<NdiConfig>
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Trait Implementations§
Source§impl Clone for FlowBuilder
impl Clone for FlowBuilder
Source§fn clone(&self) -> FlowBuilder
fn clone(&self) -> FlowBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FlowBuilder
impl Debug for FlowBuilder
Source§impl Default for FlowBuilder
impl Default for FlowBuilder
Source§fn default() -> FlowBuilder
fn default() -> FlowBuilder
Source§impl PartialEq for FlowBuilder
impl PartialEq for FlowBuilder
impl StructuralPartialEq for FlowBuilder
Auto Trait Implementations§
impl Freeze for FlowBuilder
impl RefUnwindSafe for FlowBuilder
impl Send for FlowBuilder
impl Sync for FlowBuilder
impl Unpin for FlowBuilder
impl UnwindSafe for FlowBuilder
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);