Class AthenaError

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

Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.

See Also:

  • Method Details

    • errorCategory

      public final Integer errorCategory()

      An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

      1 - System

      2 - User

      3 - Other

      Returns:
      An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

      1 - System

      2 - User

      3 - Other

    • errorType

      public final Integer errorType()

      An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

      Returns:
      An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

    • retryable

      public final Boolean retryable()

      True if the query might succeed if resubmitted.

      Returns:
      True if the query might succeed if resubmitted.

    • errorMessage

      public final String errorMessage()

      Contains a short description of the error that occurred.

      Returns:
      Contains a short description of the error that occurred.

    • toBuilder

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

    • builder

      public static AthenaError.Builder builder()

    • serializableBuilderClass

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