software.amazon.awssdk.services.sagemaker.model

Class ProcessingS3Input

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ProcessingS3Input

All Implemented Interfaces:

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

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

Configuration for processing job inputs in Amazon S3.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProcessingS3Input.Builder

Method Summary

Modifier and Type	Method and Description
static ProcessingS3Input.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	localPath() The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job.
ProcessingS3CompressionType	s3CompressionType() Whether to use Gzip compression for Amazon S3 storage.
String	s3CompressionTypeAsString() Whether to use Gzip compression for Amazon S3 storage.
ProcessingS3DataDistributionType	s3DataDistributionType() Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
String	s3DataDistributionTypeAsString() Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
ProcessingS3DataType	s3DataType() Whether you use an S3Prefix or a ManifestFile for the data type.
String	s3DataTypeAsString() Whether you use an S3Prefix or a ManifestFile for the data type.
ProcessingS3InputMode	s3InputMode() Whether to use File or Pipe input mode.
String	s3InputModeAsString() Whether to use File or Pipe input mode.
String	s3Uri() The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.
List<SdkField<?>>	sdkFields()
static Class<? extends ProcessingS3Input.Builder>	serializableBuilderClass()
ProcessingS3Input.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

s3Uri

public String s3Uri()

The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.

Returns:

The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.

localPath

public String localPath()

The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the 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 to the Amazon S3 bucket where you want Amazon SageMaker to download the 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).

s3DataType

public ProcessingS3DataType s3DataType()

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

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

Returns:

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

See Also:

ProcessingS3DataType

s3DataTypeAsString

public String s3DataTypeAsString()

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

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

Returns:

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

See Also:

ProcessingS3DataType

s3InputMode

public ProcessingS3InputMode s3InputMode()

Whether to use File or Pipe input mode. 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.This is a required parameter when AppManaged is False (default).

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

Returns:

Whether to use File or Pipe input mode. 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.This is a required parameter when AppManaged is False (default).

See Also:

ProcessingS3InputMode

s3InputModeAsString

public String s3InputModeAsString()

Whether to use File or Pipe input mode. 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.This is a required parameter when AppManaged is False (default).

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

Returns:

Whether to use File or Pipe input mode. 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.This is a required parameter when AppManaged is False (default).

See Also:

ProcessingS3InputMode

s3DataDistributionType

public ProcessingS3DataDistributionType s3DataDistributionType()

Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.

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

Returns:

Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.

See Also:

ProcessingS3DataDistributionType

s3DataDistributionTypeAsString

public String s3DataDistributionTypeAsString()

Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.

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

Returns:

Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.

See Also:

ProcessingS3DataDistributionType

s3CompressionType

public ProcessingS3CompressionType s3CompressionType()

Whether to use Gzip compression for Amazon S3 storage.

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

Returns:

Whether to use Gzip compression for Amazon S3 storage.

See Also:

ProcessingS3CompressionType

s3CompressionTypeAsString

public String s3CompressionTypeAsString()

Whether to use Gzip compression for Amazon S3 storage.

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

Returns:

Whether to use Gzip compression for Amazon S3 storage.

See Also:

ProcessingS3CompressionType

toBuilder

public ProcessingS3Input.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProcessingS3Input.Builder,ProcessingS3Input>

builder

public static ProcessingS3Input.Builder builder()

serializableBuilderClass

public static Class<? extends ProcessingS3Input.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo