Class ComponentFailureContext

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

Contains details about the component that caused the image creation process to fail. The details identify the first step that failed when the component ran.

See Also:

  • Method Details

    • componentArn

      public final String componentArn()

      The Amazon Resource Name (ARN) of the component build version that failed.

      Returns:
      The Amazon Resource Name (ARN) of the component build version that failed.

    • phaseName

      public final String phaseName()

      The name of the phase in the component document where the failure occurred, such as build, validate, or test.

      Returns:
      The name of the phase in the component document where the failure occurred, such as build, validate, or test.

    • stepName

      public final String stepName()

      The name of the step in the component document that failed.

      Returns:
      The name of the step in the component document that failed.

    • action

      public final String action()

      The action that the failed step runs, for example ExecuteBash.

      Returns:
      The action that the failed step runs, for example ExecuteBash.

    • errorMessage

      public final String errorMessage()

      The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.

      Returns:
      The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.

    • toBuilder

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

    • builder

      public static ComponentFailureContext.Builder builder()

    • serializableBuilderClass

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