Class ImageState

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

Image status and the reason for that status.

See Also:

  • Method Details

    • status

      public final ImageStatus status()

      The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.

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

      Returns:
      The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.

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

      Returns:
      The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.
      See Also:

    • reason

      public final String reason()

      The reason for the status of the image.

      Returns:
      The reason for the status of the image.

    • failureContext

      public final ImageFailureContext failureContext()

      The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.

      Returns:
      The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.

    • toBuilder

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

    • builder

      public static ImageState.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.