software.amazon.awssdk.services.sagemaker.model

Class ChannelSpecification

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ChannelSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChannelSpecification.Builder,ChannelSpecification>

@Generated(value="software.amazon.awssdk:codegen")
public final class ChannelSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ChannelSpecification.Builder,ChannelSpecification>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static ChannelSpecification.Builder	builder()
String	description() A brief description of the channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSupportedCompressionTypes() For responses, this returns true if the service returned a value for the SupportedCompressionTypes property.
boolean	hasSupportedContentTypes() For responses, this returns true if the service returned a value for the SupportedContentTypes property.
boolean	hasSupportedInputModes() For responses, this returns true if the service returned a value for the SupportedInputModes property.
Boolean	isRequired() Indicates whether the channel is required by the algorithm.
String	name() The name of the channel.
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelSpecification.Builder>	serializableBuilderClass()
List<CompressionType>	supportedCompressionTypes() The allowed compression types, if data compression is used.
List<String>	supportedCompressionTypesAsStrings() The allowed compression types, if data compression is used.
List<String>	supportedContentTypes() The supported MIME types for the data.
List<TrainingInputMode>	supportedInputModes() The allowed input mode, either FILE or PIPE.
List<String>	supportedInputModesAsStrings() The allowed input mode, either FILE or PIPE.
ChannelSpecification.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

name

public final String name()

The name of the channel.

Returns:

The name of the channel.

description

public final String description()

A brief description of the channel.

Returns:

A brief description of the channel.

isRequired

public final Boolean isRequired()

Indicates whether the channel is required by the algorithm.

Returns:

Indicates whether the channel is required by the algorithm.

hasSupportedContentTypes

public final boolean hasSupportedContentTypes()

For responses, this returns true if the service returned a value for the SupportedContentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

supportedContentTypes

public final List<String> supportedContentTypes()

The supported MIME types for the data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedContentTypes() method.

Returns:

The supported MIME types for the data.

supportedCompressionTypes

public final List<CompressionType> supportedCompressionTypes()

The allowed compression types, if data compression is used.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedCompressionTypes() method.

Returns:

The allowed compression types, if data compression is used.

hasSupportedCompressionTypes

public final boolean hasSupportedCompressionTypes()

For responses, this returns true if the service returned a value for the SupportedCompressionTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

supportedCompressionTypesAsStrings

public final List<String> supportedCompressionTypesAsStrings()

The allowed compression types, if data compression is used.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedCompressionTypes() method.

Returns:

The allowed compression types, if data compression is used.

supportedInputModes

public final List<TrainingInputMode> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedInputModes() method.

Returns:

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.

hasSupportedInputModes

public final boolean hasSupportedInputModes()

For responses, this returns true if the service returned a value for the SupportedInputModes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

supportedInputModesAsStrings

public final List<String> supportedInputModesAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedInputModes() method.

Returns:

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.

toBuilder

public ChannelSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelSpecification.Builder,ChannelSpecification>

builder

public static ChannelSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends ChannelSpecification.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