software.amazon.awssdk.services.sagemaker.model

Class DescribeTransformJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeTransformJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeTransformJobResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeTransformJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
BatchStrategy	batchStrategy() SingleRecord means only one record was used per a batch.
String	batchStrategyAsString() SingleRecord means only one record was used per a batch.
static DescribeTransformJobResponse.Builder	builder()
Instant	creationTime() A timestamp that shows when the transform Job was created.
Map<String,String>	environment()
boolean	equals(Object obj)
String	failureReason() If the transform job failed, the reason that it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	labelingJobArn() The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
Integer	maxConcurrentTransforms() The maximum number of parallel requests on each instance node that can be launched in a transform job.
Integer	maxPayloadInMB() The maximum payload size , in MB used in the transform job.
String	modelName() The name of the model used in the transform job.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTransformJobResponse.Builder>	serializableBuilderClass()
DescribeTransformJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Instant	transformEndTime() Indicates when the transform job is Completed, Stopped, or Failed.
TransformInput	transformInput() Describes the dataset to be transformed and the Amazon S3 location where it is stored.
String	transformJobArn() The Amazon Resource Name (ARN) of the transform job.
String	transformJobName() The name of the transform job.
TransformJobStatus	transformJobStatus() The status of the transform job.
String	transformJobStatusAsString() The status of the transform job.
TransformOutput	transformOutput() Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources	transformResources() Describes the resources, including ML instance types and ML instance count, to use for the transform job.
Instant	transformStartTime() Indicates when the transform job starts on ML instances.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

transformJobName

public String transformJobName()

The name of the transform job.

Returns:

The name of the transform job.

transformJobArn

public String transformJobArn()

The Amazon Resource Name (ARN) of the transform job.

Returns:

The Amazon Resource Name (ARN) of the transform job.

transformJobStatus

public TransformJobStatus transformJobStatus()

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

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

Returns:

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

See Also:

TransformJobStatus

transformJobStatusAsString

public String transformJobStatusAsString()

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

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

Returns:

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

See Also:

TransformJobStatus

failureReason

public String failureReason()

If the transform job failed, the reason that it failed.

Returns:

If the transform job failed, the reason that it failed.

modelName

public String modelName()

The name of the model used in the transform job.

Returns:

The name of the model used in the transform job.

maxConcurrentTransforms

public Integer maxConcurrentTransforms()

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

Returns:

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

maxPayloadInMB

public Integer maxPayloadInMB()

The maximum payload size , in MB used in the transform job.

Returns:

The maximum payload size , in MB used in the transform job.

batchStrategy

public BatchStrategy batchStrategy()

SingleRecord means only one record was used per a batch. MultiRecord means batches contained as many records that could possibly fit within the MaxPayloadInMB limit.

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

Returns:

SingleRecord means only one record was used per a batch. MultiRecord means batches contained as many records that could possibly fit within the MaxPayloadInMB limit.

See Also:

BatchStrategy

batchStrategyAsString

public String batchStrategyAsString()

SingleRecord means only one record was used per a batch. MultiRecord means batches contained as many records that could possibly fit within the MaxPayloadInMB limit.

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

Returns:

SingleRecord means only one record was used per a batch. MultiRecord means batches contained as many records that could possibly fit within the MaxPayloadInMB limit.

See Also:

BatchStrategy

environment

public Map<String,String> environment()

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

transformInput

public TransformInput transformInput()

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

Returns:

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

transformOutput

public TransformOutput transformOutput()

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

Returns:

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

transformResources

public TransformResources transformResources()

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Returns:

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

creationTime

public Instant creationTime()

A timestamp that shows when the transform Job was created.

Returns:

A timestamp that shows when the transform Job was created.

transformStartTime

public Instant transformStartTime()

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

Returns:

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

transformEndTime

public Instant transformEndTime()

Indicates when the transform job is Completed, Stopped, or Failed. You are billed for the time interval between this time and the value of TransformStartTime.

Returns:

Indicates when the transform job is Completed, Stopped, or Failed. You are billed for the time interval between this time and the value of TransformStartTime.

labelingJobArn

public String labelingJobArn()

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Returns:

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

toBuilder

public DescribeTransformJobResponse.Builder 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 interface ToCopyableBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeTransformJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeTransformJobResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.