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
String	autoMLJobArn() The Amazon Resource Name (ARN) of the AutoML transform job.
BatchStrategy	batchStrategy() Specifies the number of records to include in a mini-batch for an HTTP inference request.
String	batchStrategyAsString() Specifies the number of records to include in a mini-batch for an HTTP inference request.
static DescribeTransformJobResponse.Builder	builder()
Instant	creationTime() A timestamp that shows when the transform Job was created.
BatchDataCaptureConfig	dataCaptureConfig() Configuration to control how SageMaker captures inference data.
DataProcessing	dataProcessing() Returns the value of the DataProcessing property for this object.
Map<String,String>	environment() The environment variables to set in the Docker container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExperimentConfig	experimentConfig() Returns the value of the ExperimentConfig property for this object.
String	failureReason() If the transform job failed, FailureReason describes why it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnvironment() For responses, this returns true if the service returned a value for the Environment property.
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.
ModelClientConfig	modelClientConfig() The timeout and maximum number of retries for processing a transform job invocation.
String	modelName() The name of the model used in the transform job.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTransformJobResponse.Builder>	serializableBuilderClass()
DescribeTransformJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	transformEndTime() Indicates when the transform job has been completed, or has 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

transformJobName

public final String transformJobName()

The name of the transform job.

Returns:

The name of the transform job.

transformJobArn

public final String transformJobArn()

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

Returns:

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

transformJobStatus

public final 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 final 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 final String failureReason()

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

Returns:

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

modelName

public final 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 final 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.

modelClientConfig

public final ModelClientConfig modelClientConfig()

The timeout and maximum number of retries for processing a transform job invocation.

Returns:

The timeout and maximum number of retries for processing a transform job invocation.

maxPayloadInMB

public final 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 final BatchStrategy batchStrategy()

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

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:

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

See Also:

BatchStrategy

batchStrategyAsString

public final String batchStrategyAsString()

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

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:

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

See Also:

BatchStrategy

hasEnvironment

public final boolean hasEnvironment()

For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

environment

public final Map<String,String> environment()

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironment() method.

Returns:

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

transformInput

public final 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 final 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.

dataCaptureConfig

public final BatchDataCaptureConfig dataCaptureConfig()

Configuration to control how SageMaker captures inference data.

Returns:

Configuration to control how SageMaker captures inference data.

transformResources

public final 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 final 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 final 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 final Instant transformEndTime()

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

Returns:

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

labelingJobArn

public final 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.

autoMLJobArn

public final String autoMLJobArn()

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

Returns:

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

dataProcessing

public final DataProcessing dataProcessing()

Returns the value of the DataProcessing property for this object.

Returns:

The value of the DataProcessing property for this object.

experimentConfig

public final ExperimentConfig experimentConfig()

Returns the value of the ExperimentConfig property for this object.

Returns:

The value of the ExperimentConfig property for this object.

toBuilder

public DescribeTransformJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeTransformJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo