Struct aws_sdk_sagemaker::types::ChannelSpecification

#[non_exhaustive]
pub struct ChannelSpecification {
    pub name: Option<String>,
    pub description: Option<String>,
    pub is_required: Option<bool>,
    pub supported_content_types: Option<Vec<String>>,
    pub supported_compression_types: Option<Vec<CompressionType>>,
    pub supported_input_modes: Option<Vec<TrainingInputMode>>,
}

Defines a named input source, called a channel, to be used by an algorithm.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the channel.

description: Option<String>

A brief description of the channel.

is_required: Option<bool>

Indicates whether the channel is required by the algorithm.

supported_content_types: Option<Vec<String>>

The supported MIME types for the data.

supported_compression_types: Option<Vec<CompressionType>>

The allowed compression types, if data compression is used.

supported_input_modes: 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.

Implementations

impl ChannelSpecification

pub fn name(&self) -> Option<&str>

The name of the channel.

pub fn description(&self) -> Option<&str>

A brief description of the channel.

pub fn is_required(&self) -> Option<bool>

Indicates whether the channel is required by the algorithm.

pub fn supported_content_types(&self) -> &[String]

The supported MIME types for the data.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_content_types.is_none().

pub fn supported_compression_types(&self) -> &[CompressionType]

The allowed compression types, if data compression is used.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_compression_types.is_none().

pub fn supported_input_modes(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_input_modes.is_none().

impl ChannelSpecification

pub fn builder() -> ChannelSpecificationBuilder

Creates a new builder-style object to manufacture ChannelSpecification.

Trait Implementations

impl Clone for ChannelSpecification

fn clone(&self) -> ChannelSpecification

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChannelSpecification

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChannelSpecification

fn eq(&self, other: &ChannelSpecification) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChannelSpecification