Package software.amazon.awssdk.services.sagemaker.model

Class DescribeImageVersionResponse

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.DescribeImageVersionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeImageVersionResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>

  • Method Details

    • baseImage

      public final String baseImage()

      The registry path of the container image on which this image version is based.

      Returns:
      The registry path of the container image on which this image version is based.

    • containerImage

      public final String containerImage()

      The registry path of the container image that contains this image version.

      Returns:
      The registry path of the container image that contains this image version.

    • creationTime

      public final Instant creationTime()

      When the version was created.

      Returns:
      When the version was created.

    • failureReason

      public final String failureReason()

      When a create or delete operation fails, the reason for the failure.

      Returns:
      When a create or delete operation fails, the reason for the failure.

    • imageArn

      public final String imageArn()

      The ARN of the image the version is based on.

      Returns:
      The ARN of the image the version is based on.

    • imageVersionArn

      public final String imageVersionArn()

      The ARN of the version.

      Returns:
      The ARN of the version.

    • imageVersionStatus

      public final ImageVersionStatus imageVersionStatus()

      The status of the version.

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

      Returns:
      The status of the version.
      See Also:

    • imageVersionStatusAsString

      public final String imageVersionStatusAsString()

      The status of the version.

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

      Returns:
      The status of the version.
      See Also:

    • lastModifiedTime

      public final Instant lastModifiedTime()

      When the version was last modified.

      Returns:
      When the version was last modified.

    • version

      public final Integer version()

      The version number.

      Returns:
      The version number.

    • vendorGuidance

      public final VendorGuidance vendorGuidance()

      The stability of the image version specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

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

      Returns:
      The stability of the image version specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

      See Also:

    • vendorGuidanceAsString

      public final String vendorGuidanceAsString()

      The stability of the image version specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

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

      Returns:
      The stability of the image version specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

      See Also:

    • jobType

      public final JobType jobType()

      Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

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

      Returns:
      Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

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

      Returns:
      Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

      See Also:

    • mlFramework

      public final String mlFramework()

      The machine learning framework vended in the image version.

      Returns:
      The machine learning framework vended in the image version.

    • programmingLang

      public final String programmingLang()

      The supported programming language and its version.

      Returns:
      The supported programming language and its version.

    • processor

      public final Processor processor()

      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

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

      Returns:
      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

      See Also:

    • processorAsString

      public final String processorAsString()

      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

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

      Returns:
      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

      See Also:

    • horovod

      public final Boolean horovod()

      Indicates Horovod compatibility.

      Returns:
      Indicates Horovod compatibility.

    • releaseNotes

      public final String releaseNotes()

      The maintainer description of the image version.

      Returns:
      The maintainer description of the image version.

    • toBuilder

      public DescribeImageVersionResponse.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<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeImageVersionResponse.Builder builder()

    • serializableBuilderClass

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