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("software.amazon.awssdk:codegen") public final class DescribeCompilationJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

  • Method Details

    • compilationJobName

      public final String compilationJobName()

      The name of the model compilation job.

      Returns:
      The name of the model compilation job.

    • compilationJobArn

      public final String compilationJobArn()

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

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

    • compilationJobStatus

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

    • compilationJobStatusAsString

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

    • compilationStartTime

      public final 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 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 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 final 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 final StoppingCondition stoppingCondition()

      Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

      Returns:
      Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

    • inferenceImage

      public final String inferenceImage()

      The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

      Returns:
      The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

    • modelPackageVersionArn

      public final String modelPackageVersionArn()

      The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

      Returns:
      The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

    • creationTime

      public final Instant creationTime()

      The time that the model compilation job was created.

      Returns:
      The time that the model compilation job was created.

    • lastModifiedTime

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

    • modelDigests

      public final ModelDigests modelDigests()

      Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

      Returns:
      Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

    • roleArn

      public final String roleArn()

      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.

    • inputConfig

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

    • vpcConfig

      public final NeoVpcConfig vpcConfig()

      A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

      Returns:
      A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

    • derivedInformation

      public final DerivedInformation derivedInformation()

      Information that SageMaker Neo automatically derived about the model.

      Returns:
      Information that SageMaker Neo automatically derived about the model.

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.