Class Image

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.Image
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Image.Builder,Image>
@Generated("software.amazon.awssdk:codegen") public final class Image extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Image.Builder,Image>

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

See Also:

  • Method Details

    • creationTime

      public final Instant creationTime()

      When the image was created.

      Returns:
      When the image was created.

    • description

      public final String description()

      The description of the image.

      Returns:
      The description of the image.

    • displayName

      public final String displayName()

      The name of the image as displayed.

      Returns:
      The name of the image as displayed.

    • failureReason

      public final String failureReason()

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

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

    • imageArn

      public final String imageArn()

      The ARN of the image.

      Returns:
      The ARN of the image.

    • imageName

      public final String imageName()

      The name of the image.

      Returns:
      The name of the image.

    • imageStatus

      public final ImageStatus imageStatus()

      The status of the image.

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

      Returns:
      The status of the image.
      See Also:

    • imageStatusAsString

      public final String imageStatusAsString()

      The status of the image.

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

      Returns:
      The status of the image.
      See Also:

    • lastModifiedTime

      public final Instant lastModifiedTime()

      When the image was last modified.

      Returns:
      When the image was last modified.

    • toBuilder

      public Image.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<Image.Builder,Image>
      Returns:
      a builder for type T

    • builder

      public static Image.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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