#[non_exhaustive]pub struct ChannelSpecificationBuilder { /* private fields */ }
Expand description
A builder for ChannelSpecification
.
Implementations§
Source§impl ChannelSpecificationBuilder
impl ChannelSpecificationBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the channel.
This field is required.Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A brief description of the channel.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A brief description of the channel.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A brief description of the channel.
Sourcepub fn is_required(self, input: bool) -> Self
pub fn is_required(self, input: bool) -> Self
Indicates whether the channel is required by the algorithm.
Sourcepub fn set_is_required(self, input: Option<bool>) -> Self
pub fn set_is_required(self, input: Option<bool>) -> Self
Indicates whether the channel is required by the algorithm.
Sourcepub fn get_is_required(&self) -> &Option<bool>
pub fn get_is_required(&self) -> &Option<bool>
Indicates whether the channel is required by the algorithm.
Sourcepub fn supported_content_types(self, input: impl Into<String>) -> Self
pub fn supported_content_types(self, input: impl Into<String>) -> Self
Appends an item to supported_content_types
.
To override the contents of this collection use set_supported_content_types
.
The supported MIME types for the data.
Sourcepub fn set_supported_content_types(self, input: Option<Vec<String>>) -> Self
pub fn set_supported_content_types(self, input: Option<Vec<String>>) -> Self
The supported MIME types for the data.
Sourcepub fn get_supported_content_types(&self) -> &Option<Vec<String>>
pub fn get_supported_content_types(&self) -> &Option<Vec<String>>
The supported MIME types for the data.
Sourcepub fn supported_compression_types(self, input: CompressionType) -> Self
pub fn supported_compression_types(self, input: CompressionType) -> Self
Appends an item to supported_compression_types
.
To override the contents of this collection use set_supported_compression_types
.
The allowed compression types, if data compression is used.
Sourcepub fn set_supported_compression_types(
self,
input: Option<Vec<CompressionType>>,
) -> Self
pub fn set_supported_compression_types( self, input: Option<Vec<CompressionType>>, ) -> Self
The allowed compression types, if data compression is used.
Sourcepub fn get_supported_compression_types(&self) -> &Option<Vec<CompressionType>>
pub fn get_supported_compression_types(&self) -> &Option<Vec<CompressionType>>
The allowed compression types, if data compression is used.
Sourcepub fn supported_input_modes(self, input: TrainingInputMode) -> Self
pub fn supported_input_modes(self, input: TrainingInputMode) -> Self
Appends an item to supported_input_modes
.
To override the contents of this collection use set_supported_input_modes
.
The allowed input mode, either FILE or PIPE.
In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.
In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Sourcepub fn set_supported_input_modes(
self,
input: Option<Vec<TrainingInputMode>>,
) -> Self
pub fn set_supported_input_modes( self, input: Option<Vec<TrainingInputMode>>, ) -> Self
The allowed input mode, either FILE or PIPE.
In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.
In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Sourcepub fn get_supported_input_modes(&self) -> &Option<Vec<TrainingInputMode>>
pub fn get_supported_input_modes(&self) -> &Option<Vec<TrainingInputMode>>
The allowed input mode, either FILE or PIPE.
In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.
In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Sourcepub fn build(self) -> ChannelSpecification
pub fn build(self) -> ChannelSpecification
Consumes the builder and constructs a ChannelSpecification
.
Trait Implementations§
Source§impl Clone for ChannelSpecificationBuilder
impl Clone for ChannelSpecificationBuilder
Source§fn clone(&self) -> ChannelSpecificationBuilder
fn clone(&self) -> ChannelSpecificationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ChannelSpecificationBuilder
impl Debug for ChannelSpecificationBuilder
Source§impl Default for ChannelSpecificationBuilder
impl Default for ChannelSpecificationBuilder
Source§fn default() -> ChannelSpecificationBuilder
fn default() -> ChannelSpecificationBuilder
impl StructuralPartialEq for ChannelSpecificationBuilder
Auto Trait Implementations§
impl Freeze for ChannelSpecificationBuilder
impl RefUnwindSafe for ChannelSpecificationBuilder
impl Send for ChannelSpecificationBuilder
impl Sync for ChannelSpecificationBuilder
impl Unpin for ChannelSpecificationBuilder
impl UnwindSafe for ChannelSpecificationBuilder
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);