java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.Channel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Channel.Builder,Channel>
```
@Generated("software.amazon.awssdk:codegen")
public final class Channel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Channel.Builder,Channel>
```
A channel is a named input source that training algorithms can consume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Channel.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Channel.Builder`	`builder()`
`String`	`channelName()`	The name of the channel.
`CompressionType`	`compressionType()`	If training data is compressed, the compression type.
`String`	`compressionTypeAsString()`	If training data is compressed, the compression type.
`String`	`contentType()`	The MIME type of the data.
`DataSource`	`dataSource()`	The location of the channel data.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`TrainingInputMode`	`inputMode()`	(Optional) The input mode to use for the data channel in a training job.
`String`	`inputModeAsString()`	(Optional) The input mode to use for the data channel in a training job.
`RecordWrapper`	`recordWrapperType()`
`String`	`recordWrapperTypeAsString()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Channel.Builder>`	`serializableBuilderClass()`
`ShuffleConfig`	`shuffleConfig()`	A configuration for a shuffle option for input data in a channel.
`Channel.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - channelName
```
public final String channelName()
```
    The name of the channel.
    
    Returns:
    
    The name of the channel.
  - dataSource
```
public final DataSource dataSource()
```
    The location of the channel data.
    
    Returns:
    
    The location of the channel data.
  - contentType
```
public final String contentType()
```
    The MIME type of the data.
    
    Returns:
    
    The MIME type of the data.
  - compressionType
```
public final CompressionType compressionType()
```
    If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
    
    If the service returns an enum value that is not available in the current SDK version, compressionType will return CompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().
    
    Returns:
    
    If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
    
    See Also:
    
    CompressionType
  - compressionTypeAsString
```
public final String compressionTypeAsString()
```
    If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
    
    If the service returns an enum value that is not available in the current SDK version, compressionType will return CompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().
    
    Returns:
    
    If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
    
    See Also:
    
    CompressionType
  - recordWrapperType
```
public final RecordWrapper recordWrapperType()
```
    Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
    
    In File mode, leave this field unset or set it to None.
    
    If the service returns an enum value that is not available in the current SDK version, recordWrapperType will return RecordWrapper.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recordWrapperTypeAsString().
    
    Returns:
    
    Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
    
    In File mode, leave this field unset or set it to None.
    
    See Also:
    
    RecordWrapper
  - recordWrapperTypeAsString
```
public final String recordWrapperTypeAsString()
```
    Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
    
    In File mode, leave this field unset or set it to None.
    
    If the service returns an enum value that is not available in the current SDK version, recordWrapperType will return RecordWrapper.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recordWrapperTypeAsString().
    
    Returns:
    
    Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
    
    In File mode, leave this field unset or set it to None.
    
    See Also:
    
    RecordWrapper
  - inputMode
```
public final TrainingInputMode inputMode()
```
    (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
    
    To use a model for incremental training, choose File input model.
    
    If the service returns an enum value that is not available in the current SDK version, inputMode will return TrainingInputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputModeAsString().
    
    Returns:
    
    (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
    
    To use a model for incremental training, choose File input model.
    
    See Also:
    
    TrainingInputMode
  - inputModeAsString
```
public final String inputModeAsString()
```
    (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
    
    To use a model for incremental training, choose File input model.
    
    If the service returns an enum value that is not available in the current SDK version, inputMode will return TrainingInputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputModeAsString().
    
    Returns:
    
    (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
    
    To use a model for incremental training, choose File input model.
    
    See Also:
    
    TrainingInputMode
  - shuffleConfig
```
public final ShuffleConfig shuffleConfig()
```
    A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
    
    For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
    
    Returns:
    
    A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
    
    For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
  - toBuilder
```
public Channel.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>
  - builder
```
public static Channel.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Channel.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Channel

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

channelName

dataSource

contentType

compressionType

compressionTypeAsString

recordWrapperType

recordWrapperTypeAsString

inputMode

inputModeAsString

shuffleConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField