ProcessingS3Input (AWS SDK for Java

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 downloading input data from Amazon S3 into the processing container.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProcessingS3Input()

Constructors
Constructor and Description
`ProcessingS3Input()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessingS3Input`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getLocalPath()` The local path in your container where you want Amazon SageMaker to write input data to.
`String`	`getS3CompressionType()` Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
`String`	`getS3DataDistributionType()` Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
`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 of the Amazon S3 prefix Amazon SageMaker downloads data required 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 in your container where you want Amazon SageMaker to write input data to.
`void`	`setS3CompressionType(String s3CompressionType)` Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
`void`	`setS3DataDistributionType(String s3DataDistributionType)` Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
`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 of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
`String`	`toString()` Returns a string representation of this object.
`ProcessingS3Input`	`withLocalPath(String localPath)` The local path in your container where you want Amazon SageMaker to write input data to.
`ProcessingS3Input`	`withS3CompressionType(ProcessingS3CompressionType s3CompressionType)` Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
`ProcessingS3Input`	`withS3CompressionType(String s3CompressionType)` Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
`ProcessingS3Input`	`withS3DataDistributionType(ProcessingS3DataDistributionType s3DataDistributionType)` Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
`ProcessingS3Input`	`withS3DataDistributionType(String s3DataDistributionType)` Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
`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 of the Amazon S3 prefix Amazon SageMaker downloads data required 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 of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
    
    Parameters:
    
    s3Uri - The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
  - getS3Uri
```
public String getS3Uri()
```
    The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
    
    Returns:
    
    The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
  - withS3Uri
```
public ProcessingS3Input withS3Uri(String s3Uri)
```
    The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
    
    Parameters:
    
    s3Uri - The URI of the Amazon S3 prefix Amazon SageMaker downloads data required 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 in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
    
    Parameters:
    
    localPath - The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
  - getLocalPath
```
public String getLocalPath()
```
    The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
    
    Returns:
    
    The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
  - withLocalPath
```
public ProcessingS3Input withLocalPath(String localPath)
```
    The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
    
    Parameters:
    
    localPath - The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath 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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    Returns:
    
    Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
    
    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 to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    Parameters:
    
    s3DataDistributionType - Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    See Also:
    
    ProcessingS3DataDistributionType
  - getS3DataDistributionType
```
public String getS3DataDistributionType()
```
    Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    Returns:
    
    Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    See Also:
    
    ProcessingS3DataDistributionType
  - withS3DataDistributionType
```
public ProcessingS3Input withS3DataDistributionType(String s3DataDistributionType)
```
    Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    Parameters:
    
    s3DataDistributionType - Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    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 to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    Parameters:
    
    s3DataDistributionType - Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
    
    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 GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    Parameters:
    
    s3CompressionType - Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    See Also:
    
    ProcessingS3CompressionType
  - getS3CompressionType
```
public String getS3CompressionType()
```
    Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    Returns:
    
    Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    See Also:
    
    ProcessingS3CompressionType
  - withS3CompressionType
```
public ProcessingS3Input withS3CompressionType(String s3CompressionType)
```
    Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    Parameters:
    
    s3CompressionType - Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    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 GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    Parameters:
    
    s3CompressionType - Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
    
    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.

Did this page help you?

Class ProcessingS3Input

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcessingS3Input

Method Detail

setS3Uri

getS3Uri

withS3Uri

setLocalPath

getLocalPath

withLocalPath

setS3DataType

getS3DataType

withS3DataType

withS3DataType

setS3InputMode

getS3InputMode

withS3InputMode

withS3InputMode

setS3DataDistributionType

getS3DataDistributionType

withS3DataDistributionType

withS3DataDistributionType

setS3CompressionType

getS3CompressionType

withS3CompressionType

withS3CompressionType

toString

equals

hashCode

clone

marshall