Package software.amazon.awssdk.services.sagemaker.model

Class TransformS3DataSource

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TransformS3DataSource

All Implemented Interfaces:

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

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

Describes the S3 data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TransformS3DataSource.Builder

Method Summary

Modifier and Type	Method	Description
static TransformS3DataSource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
S3DataType	s3DataType()	If you choose S3Prefix, S3Uri identifies a key name prefix.
String	s3DataTypeAsString()	If you choose S3Prefix, S3Uri identifies a key name prefix.
String	s3Uri()	Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest.
List<SdkField<?>>	sdkFields()
static Class<? extends TransformS3DataSource.Builder>	serializableBuilderClass()
TransformS3DataSource.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

s3DataType

public final S3DataType s3DataType()

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

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 batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

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

Returns:

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

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 batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

See Also:

S3DataType

s3DataTypeAsString

public final String s3DataTypeAsString()

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

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 batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

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

Returns:

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

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 batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

See Also:

S3DataType

s3Uri

public final String s3Uri()

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

• A key name prefix might look like this: s3://bucketname/exampleprefix.

• A manifest might look like this: s3://bucketname/example.manifest

  The manifest is an S3 object which is a JSON file with the following format:

  [ {"prefix": "s3://customer_bucket/some/prefix/"},

  "relative/path/to/custdata-1",

  "relative/path/custdata-2",

  ...

  "relative/path/custdata-N"

  ]

  The preceding JSON matches the following S3Uris:

  s3://customer_bucket/some/prefix/relative/path/to/custdata-1

  s3://customer_bucket/some/prefix/relative/path/custdata-2

  ...

  s3://customer_bucket/some/prefix/relative/path/custdata-N

  The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

Returns:

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

• A key name prefix might look like this: s3://bucketname/exampleprefix.

• A manifest might look like this: s3://bucketname/example.manifest

  The manifest is an S3 object which is a JSON file with the following format:

  [ {"prefix": "s3://customer_bucket/some/prefix/"},

  "relative/path/to/custdata-1",

  "relative/path/custdata-2",

  ...

  "relative/path/custdata-N"

  ]

  The preceding JSON matches the following S3Uris:

  s3://customer_bucket/some/prefix/relative/path/to/custdata-1

  s3://customer_bucket/some/prefix/relative/path/custdata-2

  ...

  s3://customer_bucket/some/prefix/relative/path/custdata-N

  The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

toBuilder

public TransformS3DataSource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TransformS3DataSource.Builder,TransformS3DataSource>

builder

public static TransformS3DataSource.Builder builder()

serializableBuilderClass

public static Class<? extends TransformS3DataSource.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