Class QueryExecutionStatus

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

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

See Also:

  • Method Details

    • state

      public final QueryExecutionState state()

      The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

      Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.

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

      Returns:
      The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

      Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

      Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.

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

      Returns:
      The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

      Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.

      See Also:

    • stateChangeReason

      public final String stateChangeReason()

      Further detail about the status of the query.

      Returns:
      Further detail about the status of the query.

    • submissionDateTime

      public final Instant submissionDateTime()

      The date and time that the query was submitted.

      Returns:
      The date and time that the query was submitted.

    • completionDateTime

      public final Instant completionDateTime()

      The date and time that the query completed.

      Returns:
      The date and time that the query completed.

    • athenaError

      public final AthenaError athenaError()

      Provides information about an Athena query error.

      Returns:
      Provides information about an Athena query error.

    • toBuilder

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

    • builder

      public static QueryExecutionStatus.Builder builder()

    • serializableBuilderClass

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