AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::ChannelSpecification Class Reference

#include <ChannelSpecification.h>

Public Member Functions

 ChannelSpecification ()
 
 ChannelSpecification (Aws::Utils::Json::JsonView jsonValue)
 
ChannelSpecificationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ChannelSpecificationWithName (const Aws::String &value)
 
ChannelSpecificationWithName (Aws::String &&value)
 
ChannelSpecificationWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ChannelSpecificationWithDescription (const Aws::String &value)
 
ChannelSpecificationWithDescription (Aws::String &&value)
 
ChannelSpecificationWithDescription (const char *value)
 
bool GetIsRequired () const
 
bool IsRequiredHasBeenSet () const
 
void SetIsRequired (bool value)
 
ChannelSpecificationWithIsRequired (bool value)
 
const Aws::Vector< Aws::String > & GetSupportedContentTypes () const
 
bool SupportedContentTypesHasBeenSet () const
 
void SetSupportedContentTypes (const Aws::Vector< Aws::String > &value)
 
void SetSupportedContentTypes (Aws::Vector< Aws::String > &&value)
 
ChannelSpecificationWithSupportedContentTypes (const Aws::Vector< Aws::String > &value)
 
ChannelSpecificationWithSupportedContentTypes (Aws::Vector< Aws::String > &&value)
 
ChannelSpecificationAddSupportedContentTypes (const Aws::String &value)
 
ChannelSpecificationAddSupportedContentTypes (Aws::String &&value)
 
ChannelSpecificationAddSupportedContentTypes (const char *value)
 
const Aws::Vector< CompressionType > & GetSupportedCompressionTypes () const
 
bool SupportedCompressionTypesHasBeenSet () const
 
void SetSupportedCompressionTypes (const Aws::Vector< CompressionType > &value)
 
void SetSupportedCompressionTypes (Aws::Vector< CompressionType > &&value)
 
ChannelSpecificationWithSupportedCompressionTypes (const Aws::Vector< CompressionType > &value)
 
ChannelSpecificationWithSupportedCompressionTypes (Aws::Vector< CompressionType > &&value)
 
ChannelSpecificationAddSupportedCompressionTypes (const CompressionType &value)
 
ChannelSpecificationAddSupportedCompressionTypes (CompressionType &&value)
 
const Aws::Vector< TrainingInputMode > & GetSupportedInputModes () const
 
bool SupportedInputModesHasBeenSet () const
 
void SetSupportedInputModes (const Aws::Vector< TrainingInputMode > &value)
 
void SetSupportedInputModes (Aws::Vector< TrainingInputMode > &&value)
 
ChannelSpecificationWithSupportedInputModes (const Aws::Vector< TrainingInputMode > &value)
 
ChannelSpecificationWithSupportedInputModes (Aws::Vector< TrainingInputMode > &&value)
 
ChannelSpecificationAddSupportedInputModes (const TrainingInputMode &value)
 
ChannelSpecificationAddSupportedInputModes (TrainingInputMode &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 35 of file ChannelSpecification.h.

Constructor & Destructor Documentation

◆ ChannelSpecification() [1/2]

Aws::SageMaker::Model::ChannelSpecification::ChannelSpecification ( )

◆ ChannelSpecification() [2/2]

Aws::SageMaker::Model::ChannelSpecification::ChannelSpecification ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddSupportedCompressionTypes() [1/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedCompressionTypes ( CompressionType &&  value)
inline

The allowed compression types, if data compression is used.

Definition at line 231 of file ChannelSpecification.h.

◆ AddSupportedCompressionTypes() [2/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedCompressionTypes ( const CompressionType value)
inline

The allowed compression types, if data compression is used.

Definition at line 226 of file ChannelSpecification.h.

◆ AddSupportedContentTypes() [1/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedContentTypes ( Aws::String &&  value)
inline

The supported MIME types for the data.

Definition at line 185 of file ChannelSpecification.h.

◆ AddSupportedContentTypes() [2/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedContentTypes ( const Aws::String value)
inline

The supported MIME types for the data.

Definition at line 180 of file ChannelSpecification.h.

◆ AddSupportedContentTypes() [3/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedContentTypes ( const char *  value)
inline

The supported MIME types for the data.

Definition at line 190 of file ChannelSpecification.h.

◆ AddSupportedInputModes() [1/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedInputModes ( const TrainingInputMode value)
inline

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.

Definition at line 302 of file ChannelSpecification.h.

◆ AddSupportedInputModes() [2/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::AddSupportedInputModes ( TrainingInputMode &&  value)
inline

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.

Definition at line 312 of file ChannelSpecification.h.

◆ DescriptionHasBeenSet()

bool Aws::SageMaker::Model::ChannelSpecification::DescriptionHasBeenSet ( ) const
inline

A brief description of the channel.

Definition at line 93 of file ChannelSpecification.h.

◆ GetDescription()

const Aws::String& Aws::SageMaker::Model::ChannelSpecification::GetDescription ( ) const
inline

A brief description of the channel.

Definition at line 88 of file ChannelSpecification.h.

◆ GetIsRequired()

bool Aws::SageMaker::Model::ChannelSpecification::GetIsRequired ( ) const
inline

Indicates whether the channel is required by the algorithm.

Definition at line 129 of file ChannelSpecification.h.

◆ GetName()

const Aws::String& Aws::SageMaker::Model::ChannelSpecification::GetName ( ) const
inline

The name of the channel.

Definition at line 47 of file ChannelSpecification.h.

◆ GetSupportedCompressionTypes()

const Aws::Vector<CompressionType>& Aws::SageMaker::Model::ChannelSpecification::GetSupportedCompressionTypes ( ) const
inline

The allowed compression types, if data compression is used.

Definition at line 196 of file ChannelSpecification.h.

◆ GetSupportedContentTypes()

const Aws::Vector<Aws::String>& Aws::SageMaker::Model::ChannelSpecification::GetSupportedContentTypes ( ) const
inline

The supported MIME types for the data.

Definition at line 150 of file ChannelSpecification.h.

◆ GetSupportedInputModes()

const Aws::Vector<TrainingInputMode>& Aws::SageMaker::Model::ChannelSpecification::GetSupportedInputModes ( ) const
inline

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.

Definition at line 242 of file ChannelSpecification.h.

◆ IsRequiredHasBeenSet()

bool Aws::SageMaker::Model::ChannelSpecification::IsRequiredHasBeenSet ( ) const
inline

Indicates whether the channel is required by the algorithm.

Definition at line 134 of file ChannelSpecification.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::ChannelSpecification::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::SageMaker::Model::ChannelSpecification::NameHasBeenSet ( ) const
inline

The name of the channel.

Definition at line 52 of file ChannelSpecification.h.

◆ operator=()

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDescription() [1/3]

void Aws::SageMaker::Model::ChannelSpecification::SetDescription ( Aws::String &&  value)
inline

A brief description of the channel.

Definition at line 103 of file ChannelSpecification.h.

◆ SetDescription() [2/3]

void Aws::SageMaker::Model::ChannelSpecification::SetDescription ( const Aws::String value)
inline

A brief description of the channel.

Definition at line 98 of file ChannelSpecification.h.

◆ SetDescription() [3/3]

void Aws::SageMaker::Model::ChannelSpecification::SetDescription ( const char *  value)
inline

A brief description of the channel.

Definition at line 108 of file ChannelSpecification.h.

◆ SetIsRequired()

void Aws::SageMaker::Model::ChannelSpecification::SetIsRequired ( bool  value)
inline

Indicates whether the channel is required by the algorithm.

Definition at line 139 of file ChannelSpecification.h.

◆ SetName() [1/3]

void Aws::SageMaker::Model::ChannelSpecification::SetName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 62 of file ChannelSpecification.h.

◆ SetName() [2/3]

void Aws::SageMaker::Model::ChannelSpecification::SetName ( const Aws::String value)
inline

The name of the channel.

Definition at line 57 of file ChannelSpecification.h.

◆ SetName() [3/3]

void Aws::SageMaker::Model::ChannelSpecification::SetName ( const char *  value)
inline

The name of the channel.

Definition at line 67 of file ChannelSpecification.h.

◆ SetSupportedCompressionTypes() [1/2]

void Aws::SageMaker::Model::ChannelSpecification::SetSupportedCompressionTypes ( Aws::Vector< CompressionType > &&  value)
inline

The allowed compression types, if data compression is used.

Definition at line 211 of file ChannelSpecification.h.

◆ SetSupportedCompressionTypes() [2/2]

void Aws::SageMaker::Model::ChannelSpecification::SetSupportedCompressionTypes ( const Aws::Vector< CompressionType > &  value)
inline

The allowed compression types, if data compression is used.

Definition at line 206 of file ChannelSpecification.h.

◆ SetSupportedContentTypes() [1/2]

void Aws::SageMaker::Model::ChannelSpecification::SetSupportedContentTypes ( Aws::Vector< Aws::String > &&  value)
inline

The supported MIME types for the data.

Definition at line 165 of file ChannelSpecification.h.

◆ SetSupportedContentTypes() [2/2]

void Aws::SageMaker::Model::ChannelSpecification::SetSupportedContentTypes ( const Aws::Vector< Aws::String > &  value)
inline

The supported MIME types for the data.

Definition at line 160 of file ChannelSpecification.h.

◆ SetSupportedInputModes() [1/2]

void Aws::SageMaker::Model::ChannelSpecification::SetSupportedInputModes ( Aws::Vector< TrainingInputMode > &&  value)
inline

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.

Definition at line 272 of file ChannelSpecification.h.

◆ SetSupportedInputModes() [2/2]

void Aws::SageMaker::Model::ChannelSpecification::SetSupportedInputModes ( const Aws::Vector< TrainingInputMode > &  value)
inline

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.

Definition at line 262 of file ChannelSpecification.h.

◆ SupportedCompressionTypesHasBeenSet()

bool Aws::SageMaker::Model::ChannelSpecification::SupportedCompressionTypesHasBeenSet ( ) const
inline

The allowed compression types, if data compression is used.

Definition at line 201 of file ChannelSpecification.h.

◆ SupportedContentTypesHasBeenSet()

bool Aws::SageMaker::Model::ChannelSpecification::SupportedContentTypesHasBeenSet ( ) const
inline

The supported MIME types for the data.

Definition at line 155 of file ChannelSpecification.h.

◆ SupportedInputModesHasBeenSet()

bool Aws::SageMaker::Model::ChannelSpecification::SupportedInputModesHasBeenSet ( ) const
inline

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.

Definition at line 252 of file ChannelSpecification.h.

◆ WithDescription() [1/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithDescription ( Aws::String &&  value)
inline

A brief description of the channel.

Definition at line 118 of file ChannelSpecification.h.

◆ WithDescription() [2/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithDescription ( const Aws::String value)
inline

A brief description of the channel.

Definition at line 113 of file ChannelSpecification.h.

◆ WithDescription() [3/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithDescription ( const char *  value)
inline

A brief description of the channel.

Definition at line 123 of file ChannelSpecification.h.

◆ WithIsRequired()

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithIsRequired ( bool  value)
inline

Indicates whether the channel is required by the algorithm.

Definition at line 144 of file ChannelSpecification.h.

◆ WithName() [1/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 77 of file ChannelSpecification.h.

◆ WithName() [2/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithName ( const Aws::String value)
inline

The name of the channel.

Definition at line 72 of file ChannelSpecification.h.

◆ WithName() [3/3]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithName ( const char *  value)
inline

The name of the channel.

Definition at line 82 of file ChannelSpecification.h.

◆ WithSupportedCompressionTypes() [1/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithSupportedCompressionTypes ( Aws::Vector< CompressionType > &&  value)
inline

The allowed compression types, if data compression is used.

Definition at line 221 of file ChannelSpecification.h.

◆ WithSupportedCompressionTypes() [2/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithSupportedCompressionTypes ( const Aws::Vector< CompressionType > &  value)
inline

The allowed compression types, if data compression is used.

Definition at line 216 of file ChannelSpecification.h.

◆ WithSupportedContentTypes() [1/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithSupportedContentTypes ( Aws::Vector< Aws::String > &&  value)
inline

The supported MIME types for the data.

Definition at line 175 of file ChannelSpecification.h.

◆ WithSupportedContentTypes() [2/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithSupportedContentTypes ( const Aws::Vector< Aws::String > &  value)
inline

The supported MIME types for the data.

Definition at line 170 of file ChannelSpecification.h.

◆ WithSupportedInputModes() [1/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithSupportedInputModes ( Aws::Vector< TrainingInputMode > &&  value)
inline

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.

Definition at line 292 of file ChannelSpecification.h.

◆ WithSupportedInputModes() [2/2]

ChannelSpecification& Aws::SageMaker::Model::ChannelSpecification::WithSupportedInputModes ( const Aws::Vector< TrainingInputMode > &  value)
inline

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.

Definition at line 282 of file ChannelSpecification.h.


The documentation for this class was generated from the following file: