Class ProcessingS3Input
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ProcessingS3Input.Builder,
ProcessingS3Input>
Configuration for downloading input data from Amazon S3 into the processing container.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ProcessingS3Input.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The local path in your container where you want Amazon SageMaker to write input data to.Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.final String
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.Whether to distribute the data from Amazon S3 to all processing instances withFullyReplicated
, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.final String
Whether to distribute the data from Amazon S3 to all processing instances withFullyReplicated
, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.final ProcessingS3DataType
Whether you use anS3Prefix
or aManifestFile
for the data type.final String
Whether you use anS3Prefix
or aManifestFile
for the data type.final ProcessingS3InputMode
Whether to useFile
orPipe
input mode.final String
Whether to useFile
orPipe
input mode.final String
s3Uri()
The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.static Class
<? extends ProcessingS3Input.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 whenAppManaged
isFalse
(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 whenAppManaged
isFalse
(default).
-
s3DataType
Whether you use an
S3Prefix
or aManifestFile
for the data type. If you chooseS3Prefix
,S3Uri
identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you chooseManifestFile
,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 returnProcessingS3DataType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3DataTypeAsString()
.- Returns:
- Whether you use an
S3Prefix
or aManifestFile
for the data type. If you chooseS3Prefix
,S3Uri
identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you chooseManifestFile
,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:
-
s3DataTypeAsString
Whether you use an
S3Prefix
or aManifestFile
for the data type. If you chooseS3Prefix
,S3Uri
identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you chooseManifestFile
,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 returnProcessingS3DataType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3DataTypeAsString()
.- Returns:
- Whether you use an
S3Prefix
or aManifestFile
for the data type. If you chooseS3Prefix
,S3Uri
identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you chooseManifestFile
,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:
-
s3InputMode
Whether to use
File
orPipe
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. InPipe
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 returnProcessingS3InputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3InputModeAsString()
.- Returns:
- Whether to use
File
orPipe
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. InPipe
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:
-
s3InputModeAsString
Whether to use
File
orPipe
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. InPipe
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 returnProcessingS3InputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3InputModeAsString()
.- Returns:
- Whether to use
File
orPipe
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. InPipe
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:
-
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.If the service returns an enum value that is not available in the current SDK version,
s3DataDistributionType
will returnProcessingS3DataDistributionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3DataDistributionTypeAsString()
.- 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:
-
s3DataDistributionTypeAsString
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.If the service returns an enum value that is not available in the current SDK version,
s3DataDistributionType
will returnProcessingS3DataDistributionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3DataDistributionTypeAsString()
.- 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:
-
s3CompressionType
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
Gzip
can only be used whenPipe
mode is specified as theS3InputMode
. InPipe
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 returnProcessingS3CompressionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3CompressionTypeAsString()
.- Returns:
- Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
Gzip
can only be used whenPipe
mode is specified as theS3InputMode
. InPipe
mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume. - See Also:
-
s3CompressionTypeAsString
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
Gzip
can only be used whenPipe
mode is specified as theS3InputMode
. InPipe
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 returnProcessingS3CompressionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3CompressionTypeAsString()
.- Returns:
- Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
Gzip
can only be used whenPipe
mode is specified as theS3InputMode
. InPipe
mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProcessingS3Input.Builder,
ProcessingS3Input> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-