java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.ProcessingS3Input

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProcessingS3Input.Builder,ProcessingS3Input>
```
@Generated("software.amazon.awssdk:codegen")
public final class ProcessingS3Input
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProcessingS3Input.Builder,ProcessingS3Input>
```
Configuration for downloading input data from Amazon S3 into the processing container.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ProcessingS3Input.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 in your container where you want Amazon SageMaker to write input data to.
`ProcessingS3CompressionType`	`s3CompressionType()`	Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
`String`	`s3CompressionTypeAsString()`	Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
`ProcessingS3DataDistributionType`	`s3DataDistributionType()`	Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
`String`	`s3DataDistributionTypeAsString()`	Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
`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 of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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 final String s3Uri()
```
    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.
  - localPath
```
public final 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).
    
    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).
  - s3DataType
```
public final 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 final 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 final 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.
    
    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 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
  - s3InputModeAsString
```
public final 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 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.
    
    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 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
  - s3DataDistributionType
```
public final ProcessingS3DataDistributionType s3DataDistributionType()
```
    Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
    
    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 to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
    
    See Also:
    
    ProcessingS3DataDistributionType
  - s3DataDistributionTypeAsString
```
public final String s3DataDistributionTypeAsString()
```
    Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
    
    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 to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
    
    See Also:
    
    ProcessingS3DataDistributionType
  - s3CompressionType
```
public final 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.
    
    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 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
  - s3CompressionTypeAsString
```
public final String s3CompressionTypeAsString()
```
    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.
    
    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 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
  - 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 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

Class ProcessingS3Input

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

s3Uri

localPath

s3DataType

s3DataTypeAsString

s3InputMode

s3InputModeAsString

s3DataDistributionType

s3DataDistributionTypeAsString

s3CompressionType

s3CompressionTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField