TransformOutput (AWS Java SDK :: Services :: Amazon SageMaker 2.9.26 API)

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TransformOutput.Builder,TransformOutput>

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

Describes the results of a transform job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TransformOutput.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TransformOutput.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accept()` The MIME type used to specify the output data.
`AssemblyType`	`assembleWith()` Defines how to assemble the results of the transform job as a single S3 object.
`String`	`assembleWithAsString()` Defines how to assemble the results of the transform job as a single S3 object.
`static TransformOutput.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKeyId()` The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
`String`	`s3OutputPath()` The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TransformOutput.Builder>`	`serializableBuilderClass()`
`TransformOutput.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
  - s3OutputPath
```
public String s3OutputPath()
```
    The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.
    
    For every S3 object used as input for the transform job, batch transform stores the transformed data with an . out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
    
    Returns:
    
    The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.
    
    For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
  - accept
```
public String accept()
```
    The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
    
    Returns:
    
    The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
  - assembleWith
```
public AssemblyType assembleWith()
```
    Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.
    
    If the service returns an enum value that is not available in the current SDK version, assembleWith will return AssemblyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assembleWithAsString().
    
    Returns:
    
    Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.
    
    See Also:
    
    AssemblyType
  - assembleWithAsString
```
public String assembleWithAsString()
```
    Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.
    
    If the service returns an enum value that is not available in the current SDK version, assembleWith will return AssemblyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assembleWithAsString().
    
    Returns:
    
    Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.
    
    See Also:
    
    AssemblyType
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
    - // KMS Key ID
      
      "1234abcd-12ab-34cd-56ef-1234567890ab"
    - // Amazon Resource Name (ARN) of a KMS Key
      
      "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - // KMS Key Alias
      
      "alias/ExampleAlias"
    - // Amazon Resource Name (ARN) of a KMS Key Alias
      
      "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
    If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
    
    The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
    Returns:
    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
    
    // KMS Key ID
    
    "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    // Amazon Resource Name (ARN) of a KMS Key
    
    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    
    // KMS Key Alias
    
    "alias/ExampleAlias"
    
    // Amazon Resource Name (ARN) of a KMS Key Alias
    
    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
    
    If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
    
    The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
  - toBuilder
```
public TransformOutput.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TransformOutput.Builder,TransformOutput>
  - builder
```
public static TransformOutput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TransformOutput.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TransformOutput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

s3OutputPath

accept

assembleWith

assembleWithAsString

kmsKeyId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields