AthenaError (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.athena.model.AthenaError

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AthenaError
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AthenaError()

Constructors
Constructor and Description
`AthenaError()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AthenaError`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getErrorCategory()` An integer value that specifies the category of a query failure error.
`String`	`getErrorMessage()` Contains a short description of the error that occurred.
`Integer`	`getErrorType()` An integer value that provides specific information about an Athena query error.
`Boolean`	`getRetryable()` True if the query might succeed if resubmitted.
`int`	`hashCode()`
`Boolean`	`isRetryable()` True if the query might succeed if resubmitted.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setErrorCategory(Integer errorCategory)` An integer value that specifies the category of a query failure error.
`void`	`setErrorMessage(String errorMessage)` Contains a short description of the error that occurred.
`void`	`setErrorType(Integer errorType)` An integer value that provides specific information about an Athena query error.
`void`	`setRetryable(Boolean retryable)` True if the query might succeed if resubmitted.
`String`	`toString()` Returns a string representation of this object.
`AthenaError`	`withErrorCategory(Integer errorCategory)` An integer value that specifies the category of a query failure error.
`AthenaError`	`withErrorMessage(String errorMessage)` Contains a short description of the error that occurred.
`AthenaError`	`withErrorType(Integer errorType)` An integer value that provides specific information about an Athena query error.
`AthenaError`	`withRetryable(Boolean retryable)` True if the query might succeed if resubmitted.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AthenaError
```
public AthenaError()
```
- Method Detail
  - setErrorCategory
```
public void setErrorCategory(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
    
    Parameters:
    
    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
  - getErrorCategory
```
public Integer getErrorCategory()
```
    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
  - withErrorCategory
```
public AthenaError withErrorCategory(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorType
```
public void setErrorType(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.
    
    Parameters:
    
    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.
  - getErrorType
```
public Integer getErrorType()
```
    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.
  - withErrorType
```
public AthenaError withErrorType(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryable
```
public void setRetryable(Boolean retryable)
```
    True if the query might succeed if resubmitted.
    
    Parameters:
    
    retryable - True if the query might succeed if resubmitted.
  - getRetryable
```
public Boolean getRetryable()
```
    True if the query might succeed if resubmitted.
    
    Returns:
    
    True if the query might succeed if resubmitted.
  - withRetryable
```
public AthenaError withRetryable(Boolean retryable)
```
    True if the query might succeed if resubmitted.
    
    Parameters:
    
    retryable - True if the query might succeed if resubmitted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRetryable
```
public Boolean isRetryable()
```
    True if the query might succeed if resubmitted.
    
    Returns:
    
    True if the query might succeed if resubmitted.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Contains a short description of the error that occurred.
    
    Parameters:
    
    errorMessage - Contains a short description of the error that occurred.
  - getErrorMessage
```
public String getErrorMessage()
```
    Contains a short description of the error that occurred.
    
    Returns:
    
    Contains a short description of the error that occurred.
  - withErrorMessage
```
public AthenaError withErrorMessage(String errorMessage)
```
    Contains a short description of the error that occurred.
    
    Parameters:
    
    errorMessage - Contains a short description of the error that occurred.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AthenaError clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class AthenaError

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AthenaError

Method Detail

setErrorCategory

getErrorCategory

withErrorCategory

setErrorType

getErrorType

withErrorType

setRetryable

getRetryable

withRetryable

isRetryable

setErrorMessage

getErrorMessage

withErrorMessage

toString

equals

hashCode

clone

marshall