software.amazon.awssdk.services.sagemaker.model

Class DescribeCompilationJobResponse

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.DescribeCompilationJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCompilationJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCompilationJobResponse.Builder	builder()
Instant	compilationEndTime() The time when the model compilation job on a compilation job instance ended.
String	compilationJobArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
String	compilationJobName() The name of the model compilation job.
CompilationJobStatus	compilationJobStatus() The status of the model compilation job.
String	compilationJobStatusAsString() The status of the model compilation job.
Instant	compilationStartTime() The time when the model compilation job started the CompilationJob instances.
Instant	creationTime() The time that the model compilation job was created.
boolean	equals(Object obj)
String	failureReason() If a model compilation job failed, the reason 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()
InputConfig	inputConfig() Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
Instant	lastModifiedTime() The time that the status of the model compilation job was last modified.
ModelArtifacts	modelArtifacts() Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
OutputConfig	outputConfig() Information about the output location for the compiled model and the target device that the model runs on.
String	roleArn() The Amazon Resource Name (ARN) of the model compilation job.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCompilationJobResponse.Builder>	serializableBuilderClass()
StoppingCondition	stoppingCondition() The duration allowed for model compilation.
DescribeCompilationJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

compilationJobName

public String compilationJobName()

The name of the model compilation job.

Returns:

The name of the model compilation job.

compilationJobArn

public String compilationJobArn()

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

Returns:

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

compilationJobStatus

public CompilationJobStatus compilationJobStatus()

The status of the model compilation job.

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

Returns:

The status of the model compilation job.

See Also:

CompilationJobStatus

compilationJobStatusAsString

public String compilationJobStatusAsString()

The status of the model compilation job.

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

Returns:

The status of the model compilation job.

See Also:

CompilationJobStatus

compilationStartTime

public Instant compilationStartTime()

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

Returns:

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

compilationEndTime

public Instant compilationEndTime()

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

Returns:

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

stoppingCondition

public StoppingCondition stoppingCondition()

The duration allowed for model compilation.

Returns:

The duration allowed for model compilation.

creationTime

public Instant creationTime()

The time that the model compilation job was created.

Returns:

The time that the model compilation job was created.

lastModifiedTime

public Instant lastModifiedTime()

The time that the status of the model compilation job was last modified.

Returns:

The time that the status of the model compilation job was last modified.

failureReason

public String failureReason()

If a model compilation job failed, the reason it failed.

Returns:

If a model compilation job failed, the reason it failed.

modelArtifacts

public ModelArtifacts modelArtifacts()

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

Returns:

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

roleArn

public String roleArn()

The Amazon Resource Name (ARN) of the model compilation job.

Returns:

The Amazon Resource Name (ARN) of the model compilation job.

inputConfig

public InputConfig inputConfig()

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Returns:

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

outputConfig

public OutputConfig outputConfig()

Information about the output location for the compiled model and the target device that the model runs on.

Returns:

Information about the output location for the compiled model and the target device that the model runs on.

toBuilder

public DescribeCompilationJobResponse.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<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeCompilationJobResponse.Builder builder()

serializableBuilderClass

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