Package software.amazon.awssdk.services.sagemaker.model

Class DatasetDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.DatasetDefinition

All Implemented Interfaces:

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

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

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatasetDefinition.Builder

Method Summary

Modifier and Type	Method	Description
AthenaDatasetDefinition	athenaDatasetDefinition()	Returns the value of the AthenaDatasetDefinition property for this object.
static DatasetDefinition.Builder	builder()
DataDistributionType	dataDistributionType()	Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
String	dataDistributionTypeAsString()	Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputMode	inputMode()	Whether to use File or Pipe input mode.
String	inputModeAsString()	Whether to use File or Pipe input mode.
String	localPath()	The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job.
RedshiftDatasetDefinition	redshiftDatasetDefinition()	Returns the value of the RedshiftDatasetDefinition property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DatasetDefinition.Builder>	serializableBuilderClass()
DatasetDefinition.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

athenaDatasetDefinition

public final AthenaDatasetDefinition athenaDatasetDefinition()

Returns the value of the AthenaDatasetDefinition property for this object.

Returns:

The value of the AthenaDatasetDefinition property for this object.

redshiftDatasetDefinition

public final RedshiftDatasetDefinition redshiftDatasetDefinition()

Returns the value of the RedshiftDatasetDefinition property for this object.

Returns:

The value of the RedshiftDatasetDefinition property for this object.

localPath

public final String localPath()

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

Returns:

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

dataDistributionType

public final DataDistributionType dataDistributionType()

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

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

Returns:

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

See Also:

DataDistributionType

dataDistributionTypeAsString

public final String dataDistributionTypeAsString()

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

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

Returns:

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

See Also:

DataDistributionType

inputMode

public final InputMode inputMode()

Whether to use File or Pipe input mode. In File (default) 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.

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

Returns:

Whether to use File or Pipe input mode. In File (default) 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.

See Also:

InputMode

inputModeAsString

public final String inputModeAsString()

Whether to use File or Pipe input mode. In File (default) 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.

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

Returns:

Whether to use File or Pipe input mode. In File (default) 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.

See Also:

InputMode

toBuilder

public DatasetDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetDefinition.Builder,DatasetDefinition>

builder

public static DatasetDefinition.Builder builder()

serializableBuilderClass

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