Class RegionFailure

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

Contains details about a distribution or image configuration failure for a single Region.

See Also:

  • Method Details

    • region

      public final String region()

      The Region where the failure occurred.

      Returns:
      The Region where the failure occurred.

    • status

      public final RegionFailureStatus status()

      The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.

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

      Returns:
      The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.
      See Also:

    • statusAsString

      public final String statusAsString()

      The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.

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

      Returns:
      The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.
      See Also:

    • imageConfigurationStep

      public final ImageConfigurationStep imageConfigurationStep()

      The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.

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

      Returns:
      The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.
      See Also:

    • imageConfigurationStepAsString

      public final String imageConfigurationStepAsString()

      The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.

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

      Returns:
      The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.
      See Also:

    • errorMessage

      public final String errorMessage()

      The error message for the failure in the Region.

      Returns:
      The error message for the failure in the Region.

    • targetAccountId

      public final String targetAccountId()

      The account ID of the account that the image was distributed to in the Region.

      Returns:
      The account ID of the account that the image was distributed to in the Region.

    • toBuilder

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

    • builder

      public static RegionFailure.Builder builder()

    • serializableBuilderClass

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