Class ImageFailureContext

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

Contains details about the failure when the image creation process fails. Properties appear in the failure context when the related information is available for the failure.

See Also:

  • Method Details

    • imageStatus

      public final ImageStatus imageStatus()

      The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.

      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 that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.
      See Also:

    • imageStatusAsString

      public final String imageStatusAsString()

      The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.

      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 that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.
      See Also:

    • workflowExecutionId

      public final String workflowExecutionId()

      The unique identifier of the workflow execution that was running when the image failed.

      Returns:
      The unique identifier of the workflow execution that was running when the image failed.

    • workflowArn

      public final String workflowArn()

      The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.

      Returns:
      The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.

    • stepExecutionId

      public final String stepExecutionId()

      The unique identifier of the workflow step execution that failed.

      Returns:
      The unique identifier of the workflow step execution that failed.

    • failedStep

      public final String failedStep()

      The name of the workflow step that failed, as it appears in the workflow document.

      Returns:
      The name of the workflow step that failed, as it appears in the workflow document.

    • componentFailure

      public final ComponentFailureContext componentFailure()

      The details about the component that failed, if the failure occurred while a component was running.

      Returns:
      The details about the component that failed, if the failure occurred while a component was running.

    • distributionFailure

      public final DistributionFailureContext distributionFailure()

      The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.

      Returns:
      The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.

    • toBuilder

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

    • builder

      public static ImageFailureContext.Builder builder()

    • serializableBuilderClass

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