#[non_exhaustive]pub struct OutputBuilder { /* private fields */ }
Expand description
A builder for Output
.
Implementations§
Source§impl OutputBuilder
impl OutputBuilder
Sourcepub fn data_transfer_subscriber_fee_percent(self, input: i32) -> Self
pub fn data_transfer_subscriber_fee_percent(self, input: i32) -> Self
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Sourcepub fn set_data_transfer_subscriber_fee_percent(
self,
input: Option<i32>,
) -> Self
pub fn set_data_transfer_subscriber_fee_percent( self, input: Option<i32>, ) -> Self
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Sourcepub fn get_data_transfer_subscriber_fee_percent(&self) -> &Option<i32>
pub fn get_data_transfer_subscriber_fee_percent(&self) -> &Option<i32>
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the output.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the output.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the output.
Sourcepub fn destination(self, input: impl Into<String>) -> Self
pub fn destination(self, input: impl Into<String>) -> Self
The address where you want to send the output.
Sourcepub fn set_destination(self, input: Option<String>) -> Self
pub fn set_destination(self, input: Option<String>) -> Self
The address where you want to send the output.
Sourcepub fn get_destination(&self) -> &Option<String>
pub fn get_destination(&self) -> &Option<String>
The address where you want to send the output.
Sourcepub fn encryption(self, input: Encryption) -> Self
pub fn encryption(self, input: Encryption) -> Self
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Sourcepub fn set_encryption(self, input: Option<Encryption>) -> Self
pub fn set_encryption(self, input: Option<Encryption>) -> Self
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Sourcepub fn get_encryption(&self) -> &Option<Encryption>
pub fn get_encryption(&self) -> &Option<Encryption>
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Sourcepub fn entitlement_arn(self, input: impl Into<String>) -> Self
pub fn entitlement_arn(self, input: impl Into<String>) -> Self
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
Sourcepub fn set_entitlement_arn(self, input: Option<String>) -> Self
pub fn set_entitlement_arn(self, input: Option<String>) -> Self
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
Sourcepub fn get_entitlement_arn(&self) -> &Option<String>
pub fn get_entitlement_arn(&self) -> &Option<String>
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
Sourcepub fn listener_address(self, input: impl Into<String>) -> Self
pub fn listener_address(self, input: impl Into<String>) -> Self
The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
Sourcepub fn set_listener_address(self, input: Option<String>) -> Self
pub fn set_listener_address(self, input: Option<String>) -> Self
The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
Sourcepub fn get_listener_address(&self) -> &Option<String>
pub fn get_listener_address(&self) -> &Option<String>
The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
Sourcepub fn media_live_input_arn(self, input: impl Into<String>) -> Self
pub fn media_live_input_arn(self, input: impl Into<String>) -> Self
The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Sourcepub fn set_media_live_input_arn(self, input: Option<String>) -> Self
pub fn set_media_live_input_arn(self, input: Option<String>) -> Self
The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Sourcepub fn get_media_live_input_arn(&self) -> &Option<String>
pub fn get_media_live_input_arn(&self) -> &Option<String>
The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Sourcepub fn media_stream_output_configurations(
self,
input: MediaStreamOutputConfiguration,
) -> Self
pub fn media_stream_output_configurations( self, input: MediaStreamOutputConfiguration, ) -> Self
Appends an item to media_stream_output_configurations
.
To override the contents of this collection use set_media_stream_output_configurations
.
The configuration for each media stream that is associated with the output.
Sourcepub fn set_media_stream_output_configurations(
self,
input: Option<Vec<MediaStreamOutputConfiguration>>,
) -> Self
pub fn set_media_stream_output_configurations( self, input: Option<Vec<MediaStreamOutputConfiguration>>, ) -> Self
The configuration for each media stream that is associated with the output.
Sourcepub fn get_media_stream_output_configurations(
&self,
) -> &Option<Vec<MediaStreamOutputConfiguration>>
pub fn get_media_stream_output_configurations( &self, ) -> &Option<Vec<MediaStreamOutputConfiguration>>
The configuration for each media stream that is associated with the output.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the output. This value must be unique within the current flow.
This field is required.Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the output. This value must be unique within the current flow.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the output. This value must be unique within the current flow.
Sourcepub fn output_arn(self, input: impl Into<String>) -> Self
pub fn output_arn(self, input: impl Into<String>) -> Self
The ARN of the output.
This field is required.Sourcepub fn set_output_arn(self, input: Option<String>) -> Self
pub fn set_output_arn(self, input: Option<String>) -> Self
The ARN of the output.
Sourcepub fn get_output_arn(&self) -> &Option<String>
pub fn get_output_arn(&self) -> &Option<String>
The ARN of the output.
Sourcepub fn port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
The port to use when content is distributed to this output.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port to use when content is distributed to this output.
Sourcepub fn get_port(&self) -> &Option<i32>
pub fn get_port(&self) -> &Option<i32>
The port to use when content is distributed to this output.
Sourcepub fn transport(self, input: Transport) -> Self
pub fn transport(self, input: Transport) -> Self
Attributes related to the transport stream that are used in the output.
Sourcepub fn set_transport(self, input: Option<Transport>) -> Self
pub fn set_transport(self, input: Option<Transport>) -> Self
Attributes related to the transport stream that are used in the output.
Sourcepub fn get_transport(&self) -> &Option<Transport>
pub fn get_transport(&self) -> &Option<Transport>
Attributes related to the transport stream that are used in the output.
Sourcepub fn vpc_interface_attachment(self, input: VpcInterfaceAttachment) -> Self
pub fn vpc_interface_attachment(self, input: VpcInterfaceAttachment) -> Self
The name of the VPC interface attachment to use for this output.
Sourcepub fn set_vpc_interface_attachment(
self,
input: Option<VpcInterfaceAttachment>,
) -> Self
pub fn set_vpc_interface_attachment( self, input: Option<VpcInterfaceAttachment>, ) -> Self
The name of the VPC interface attachment to use for this output.
Sourcepub fn get_vpc_interface_attachment(&self) -> &Option<VpcInterfaceAttachment>
pub fn get_vpc_interface_attachment(&self) -> &Option<VpcInterfaceAttachment>
The name of the VPC interface attachment to use for this output.
Sourcepub fn bridge_arn(self, input: impl Into<String>) -> Self
pub fn bridge_arn(self, input: impl Into<String>) -> Self
The ARN of the bridge added to this output.
Sourcepub fn set_bridge_arn(self, input: Option<String>) -> Self
pub fn set_bridge_arn(self, input: Option<String>) -> Self
The ARN of the bridge added to this output.
Sourcepub fn get_bridge_arn(&self) -> &Option<String>
pub fn get_bridge_arn(&self) -> &Option<String>
The ARN of the bridge added to this output.
Sourcepub fn bridge_ports(self, input: i32) -> Self
pub fn bridge_ports(self, input: i32) -> Self
Appends an item to bridge_ports
.
To override the contents of this collection use set_bridge_ports
.
The bridge output ports currently in use.
Sourcepub fn set_bridge_ports(self, input: Option<Vec<i32>>) -> Self
pub fn set_bridge_ports(self, input: Option<Vec<i32>>) -> Self
The bridge output ports currently in use.
Sourcepub fn get_bridge_ports(&self) -> &Option<Vec<i32>>
pub fn get_bridge_ports(&self) -> &Option<Vec<i32>>
The bridge output ports currently in use.
Sourcepub fn output_status(self, input: OutputStatus) -> Self
pub fn output_status(self, input: OutputStatus) -> Self
An indication of whether the output is transmitting data or not.
Sourcepub fn set_output_status(self, input: Option<OutputStatus>) -> Self
pub fn set_output_status(self, input: Option<OutputStatus>) -> Self
An indication of whether the output is transmitting data or not.
Sourcepub fn get_output_status(&self) -> &Option<OutputStatus>
pub fn get_output_status(&self) -> &Option<OutputStatus>
An indication of whether the output is transmitting data or not.
Sourcepub fn peer_ip_address(self, input: impl Into<String>) -> Self
pub fn peer_ip_address(self, input: impl Into<String>) -> Self
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Sourcepub fn set_peer_ip_address(self, input: Option<String>) -> Self
pub fn set_peer_ip_address(self, input: Option<String>) -> Self
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Sourcepub fn get_peer_ip_address(&self) -> &Option<String>
pub fn get_peer_ip_address(&self) -> &Option<String>
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Trait Implementations§
Source§impl Clone for OutputBuilder
impl Clone for OutputBuilder
Source§fn clone(&self) -> OutputBuilder
fn clone(&self) -> OutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OutputBuilder
impl Debug for OutputBuilder
Source§impl Default for OutputBuilder
impl Default for OutputBuilder
Source§fn default() -> OutputBuilder
fn default() -> OutputBuilder
Source§impl PartialEq for OutputBuilder
impl PartialEq for OutputBuilder
impl StructuralPartialEq for OutputBuilder
Auto Trait Implementations§
impl Freeze for OutputBuilder
impl RefUnwindSafe for OutputBuilder
impl Send for OutputBuilder
impl Sync for OutputBuilder
impl Unpin for OutputBuilder
impl UnwindSafe for OutputBuilder
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);