/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class ChannelSpecification { public: AWS_SAGEMAKER_API ChannelSpecification(); AWS_SAGEMAKER_API ChannelSpecification(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API ChannelSpecification& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the channel.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the channel.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the channel.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the channel.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the channel.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the channel.

*/ inline ChannelSpecification& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the channel.

*/ inline ChannelSpecification& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the channel.

*/ inline ChannelSpecification& WithName(const char* value) { SetName(value); return *this;} /** *

A brief description of the channel.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A brief description of the channel.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A brief description of the channel.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A brief description of the channel.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A brief description of the channel.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A brief description of the channel.

*/ inline ChannelSpecification& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A brief description of the channel.

*/ inline ChannelSpecification& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A brief description of the channel.

*/ inline ChannelSpecification& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

Indicates whether the channel is required by the algorithm.

*/ inline bool GetIsRequired() const{ return m_isRequired; } /** *

Indicates whether the channel is required by the algorithm.

*/ inline bool IsRequiredHasBeenSet() const { return m_isRequiredHasBeenSet; } /** *

Indicates whether the channel is required by the algorithm.

*/ inline void SetIsRequired(bool value) { m_isRequiredHasBeenSet = true; m_isRequired = value; } /** *

Indicates whether the channel is required by the algorithm.

*/ inline ChannelSpecification& WithIsRequired(bool value) { SetIsRequired(value); return *this;} /** *

The supported MIME types for the data.

*/ inline const Aws::Vector& GetSupportedContentTypes() const{ return m_supportedContentTypes; } /** *

The supported MIME types for the data.

*/ inline bool SupportedContentTypesHasBeenSet() const { return m_supportedContentTypesHasBeenSet; } /** *

The supported MIME types for the data.

*/ inline void SetSupportedContentTypes(const Aws::Vector& value) { m_supportedContentTypesHasBeenSet = true; m_supportedContentTypes = value; } /** *

The supported MIME types for the data.

*/ inline void SetSupportedContentTypes(Aws::Vector&& value) { m_supportedContentTypesHasBeenSet = true; m_supportedContentTypes = std::move(value); } /** *

The supported MIME types for the data.

*/ inline ChannelSpecification& WithSupportedContentTypes(const Aws::Vector& value) { SetSupportedContentTypes(value); return *this;} /** *

The supported MIME types for the data.

*/ inline ChannelSpecification& WithSupportedContentTypes(Aws::Vector&& value) { SetSupportedContentTypes(std::move(value)); return *this;} /** *

The supported MIME types for the data.

*/ inline ChannelSpecification& AddSupportedContentTypes(const Aws::String& value) { m_supportedContentTypesHasBeenSet = true; m_supportedContentTypes.push_back(value); return *this; } /** *

The supported MIME types for the data.

*/ inline ChannelSpecification& AddSupportedContentTypes(Aws::String&& value) { m_supportedContentTypesHasBeenSet = true; m_supportedContentTypes.push_back(std::move(value)); return *this; } /** *

The supported MIME types for the data.

*/ inline ChannelSpecification& AddSupportedContentTypes(const char* value) { m_supportedContentTypesHasBeenSet = true; m_supportedContentTypes.push_back(value); return *this; } /** *

The allowed compression types, if data compression is used.

*/ inline const Aws::Vector& GetSupportedCompressionTypes() const{ return m_supportedCompressionTypes; } /** *

The allowed compression types, if data compression is used.

*/ inline bool SupportedCompressionTypesHasBeenSet() const { return m_supportedCompressionTypesHasBeenSet; } /** *

The allowed compression types, if data compression is used.

*/ inline void SetSupportedCompressionTypes(const Aws::Vector& value) { m_supportedCompressionTypesHasBeenSet = true; m_supportedCompressionTypes = value; } /** *

The allowed compression types, if data compression is used.

*/ inline void SetSupportedCompressionTypes(Aws::Vector&& value) { m_supportedCompressionTypesHasBeenSet = true; m_supportedCompressionTypes = std::move(value); } /** *

The allowed compression types, if data compression is used.

*/ inline ChannelSpecification& WithSupportedCompressionTypes(const Aws::Vector& value) { SetSupportedCompressionTypes(value); return *this;} /** *

The allowed compression types, if data compression is used.

*/ inline ChannelSpecification& WithSupportedCompressionTypes(Aws::Vector&& value) { SetSupportedCompressionTypes(std::move(value)); return *this;} /** *

The allowed compression types, if data compression is used.

*/ inline ChannelSpecification& AddSupportedCompressionTypes(const CompressionType& value) { m_supportedCompressionTypesHasBeenSet = true; m_supportedCompressionTypes.push_back(value); return *this; } /** *

The allowed compression types, if data compression is used.

*/ inline ChannelSpecification& AddSupportedCompressionTypes(CompressionType&& value) { m_supportedCompressionTypesHasBeenSet = true; m_supportedCompressionTypes.push_back(std::move(value)); return *this; } /** *

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.

*/ inline const Aws::Vector& GetSupportedInputModes() const{ return m_supportedInputModes; } /** *

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.

*/ inline bool SupportedInputModesHasBeenSet() const { return m_supportedInputModesHasBeenSet; } /** *

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.

*/ inline void SetSupportedInputModes(const Aws::Vector& value) { m_supportedInputModesHasBeenSet = true; m_supportedInputModes = value; } /** *

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.

*/ inline void SetSupportedInputModes(Aws::Vector&& value) { m_supportedInputModesHasBeenSet = true; m_supportedInputModes = std::move(value); } /** *

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.

*/ inline ChannelSpecification& WithSupportedInputModes(const Aws::Vector& value) { SetSupportedInputModes(value); return *this;} /** *

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.

*/ inline ChannelSpecification& WithSupportedInputModes(Aws::Vector&& value) { SetSupportedInputModes(std::move(value)); return *this;} /** *

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.

*/ inline ChannelSpecification& AddSupportedInputModes(const TrainingInputMode& value) { m_supportedInputModesHasBeenSet = true; m_supportedInputModes.push_back(value); return *this; } /** *

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.

*/ inline ChannelSpecification& AddSupportedInputModes(TrainingInputMode&& value) { m_supportedInputModesHasBeenSet = true; m_supportedInputModes.push_back(std::move(value)); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; bool m_isRequired; bool m_isRequiredHasBeenSet = false; Aws::Vector m_supportedContentTypes; bool m_supportedContentTypesHasBeenSet = false; Aws::Vector m_supportedCompressionTypes; bool m_supportedCompressionTypesHasBeenSet = false; Aws::Vector m_supportedInputModes; bool m_supportedInputModesHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws