com.amazonaws.services.sagemaker.model

Class ProcessingS3Input

java.lang.Object

com.amazonaws.services.sagemaker.model.ProcessingS3Input

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProcessingS3Input
extends Object
implements Serializable, Cloneable, StructuredPojo

Configuration for processing job inputs in Amazon S3.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessingS3Input()

Method Summary

Modifier and Type	Method and Description
ProcessingS3Input	clone()
boolean	equals(Object obj)
String	getLocalPath() The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job.
String	getS3CompressionType() Whether to use Gzip compression for Amazon S3 storage.
String	getS3DataDistributionType() Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
String	getS3DataType() Whether you use an S3Prefix or a ManifestFile for the data type.
String	getS3InputMode() Whether to use File or Pipe input mode.
String	getS3Uri() The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setLocalPath(String localPath) The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job.
void	setS3CompressionType(String s3CompressionType) Whether to use Gzip compression for Amazon S3 storage.
void	setS3DataDistributionType(String s3DataDistributionType) Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
void	setS3DataType(String s3DataType) Whether you use an S3Prefix or a ManifestFile for the data type.
void	setS3InputMode(String s3InputMode) Whether to use File or Pipe input mode.
void	setS3Uri(String s3Uri) The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.
String	toString() Returns a string representation of this object.
ProcessingS3Input	withLocalPath(String localPath) The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job.
ProcessingS3Input	withS3CompressionType(ProcessingS3CompressionType s3CompressionType) Whether to use Gzip compression for Amazon S3 storage.
ProcessingS3Input	withS3CompressionType(String s3CompressionType) Whether to use Gzip compression for Amazon S3 storage.
ProcessingS3Input	withS3DataDistributionType(ProcessingS3DataDistributionType s3DataDistributionType) Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
ProcessingS3Input	withS3DataDistributionType(String s3DataDistributionType) Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
ProcessingS3Input	withS3DataType(ProcessingS3DataType s3DataType) Whether you use an S3Prefix or a ManifestFile for the data type.
ProcessingS3Input	withS3DataType(String s3DataType) Whether you use an S3Prefix or a ManifestFile for the data type.
ProcessingS3Input	withS3InputMode(ProcessingS3InputMode s3InputMode) Whether to use File or Pipe input mode.
ProcessingS3Input	withS3InputMode(String s3InputMode) Whether to use File or Pipe input mode.
ProcessingS3Input	withS3Uri(String s3Uri) The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessingS3Input

public ProcessingS3Input()

Method Detail

setS3Uri

public void setS3Uri(String s3Uri)

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

Parameters:

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

getS3Uri

public String getS3Uri()

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.

withS3Uri

public ProcessingS3Input withS3Uri(String s3Uri)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLocalPath

public void setLocalPath(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).

Parameters:

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).

getLocalPath

public String getLocalPath()

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).

withLocalPath

public ProcessingS3Input withLocalPath(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setS3DataType

public void setS3DataType(String 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.

Parameters:

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.

See Also:

ProcessingS3DataType

getS3DataType

public String getS3DataType()

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.

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

withS3DataType

public ProcessingS3Input withS3DataType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3DataType

withS3DataType

public ProcessingS3Input withS3DataType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3DataType

setS3InputMode

public void setS3InputMode(String 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).

Parameters:

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).

See Also:

ProcessingS3InputMode

getS3InputMode

public String getS3InputMode()

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).

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

withS3InputMode

public ProcessingS3Input withS3InputMode(String 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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3InputMode

withS3InputMode

public ProcessingS3Input withS3InputMode(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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3InputMode

setS3DataDistributionType

public void setS3DataDistributionType(String s3DataDistributionType)

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

Parameters:

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

See Also:

ProcessingS3DataDistributionType

getS3DataDistributionType

public String getS3DataDistributionType()

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

Returns:

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

See Also:

ProcessingS3DataDistributionType

withS3DataDistributionType

public ProcessingS3Input withS3DataDistributionType(String s3DataDistributionType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3DataDistributionType

withS3DataDistributionType

public ProcessingS3Input withS3DataDistributionType(ProcessingS3DataDistributionType s3DataDistributionType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3DataDistributionType

setS3CompressionType

public void setS3CompressionType(String s3CompressionType)

Whether to use Gzip compression for Amazon S3 storage.

Parameters:

s3CompressionType - Whether to use Gzip compression for Amazon S3 storage.

See Also:

ProcessingS3CompressionType

getS3CompressionType

public String getS3CompressionType()

Whether to use Gzip compression for Amazon S3 storage.

Returns:

Whether to use Gzip compression for Amazon S3 storage.

See Also:

ProcessingS3CompressionType

withS3CompressionType

public ProcessingS3Input withS3CompressionType(String s3CompressionType)

Whether to use Gzip compression for Amazon S3 storage.

Parameters:

s3CompressionType - Whether to use Gzip compression for Amazon S3 storage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3CompressionType

withS3CompressionType

public ProcessingS3Input withS3CompressionType(ProcessingS3CompressionType s3CompressionType)

Whether to use Gzip compression for Amazon S3 storage.

Parameters:

s3CompressionType - Whether to use Gzip compression for Amazon S3 storage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProcessingS3CompressionType

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ProcessingS3Input clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.