software.amazon.awssdk.services.sagemaker.model

Class AutoMLJobChannel

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.AutoMLJobChannel

All Implemented Interfaces:

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

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

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutoMLJobChannel.Builder

Method Summary

Modifier and Type	Method and Description
static AutoMLJobChannel.Builder	builder()
AutoMLChannelType	channelType() The type of channel.
String	channelTypeAsString() The type of channel.
CompressionType	compressionType() The allowed compression types depend on the input format and problem type.
String	compressionTypeAsString() The allowed compression types depend on the input format and problem type.
String	contentType() The content type of the data from the input source.
AutoMLDataSource	dataSource() The data source for an AutoML channel (Required).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AutoMLJobChannel.Builder>	serializableBuilderClass()
AutoMLJobChannel.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

channelType

public final AutoMLChannelType channelType()

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

If the service returns an enum value that is not available in the current SDK version, channelType will return AutoMLChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelTypeAsString().

Returns:

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

See Also:

AutoMLChannelType

channelTypeAsString

public final String channelTypeAsString()

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

If the service returns an enum value that is not available in the current SDK version, channelType will return AutoMLChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelTypeAsString().

Returns:

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

See Also:

AutoMLChannelType

contentType

public final String contentType()

The content type of the data from the input source. The following are the allowed content types for different problems:

• For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

• For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

• For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

• For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

Returns:

The content type of the data from the input source. The following are the allowed content types for different problems:

• For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

• For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

• For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

• For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

compressionType

public final CompressionType compressionType()

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default 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:

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

See Also:

CompressionType

compressionTypeAsString

public final String compressionTypeAsString()

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default 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:

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

See Also:

CompressionType

dataSource

public final AutoMLDataSource dataSource()

The data source for an AutoML channel (Required).

Returns:

The data source for an AutoML channel (Required).

toBuilder

public AutoMLJobChannel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoMLJobChannel.Builder,AutoMLJobChannel>

builder

public static AutoMLJobChannel.Builder builder()

serializableBuilderClass

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