Class FailureDescription

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

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

See Also:

  • Method Details

    • type

      public final DeliveryStreamFailureType type()

      The type of error that caused the failure.

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

      Returns:
      The type of error that caused the failure.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of error that caused the failure.

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

      Returns:
      The type of error that caused the failure.
      See Also:

    • details

      public final String details()

      A message providing details about the error that caused the failure.

      Returns:
      A message providing details about the error that caused the failure.

    • toBuilder

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

    • builder

      public static FailureDescription.Builder builder()

    • serializableBuilderClass

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