Package software.amazon.awssdk.services.athena.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryExecutionStatus.Builder

Method Summary

Modifier and Type	Method	Description
AthenaError	athenaError()	Provides information about an Athena query error.
static QueryExecutionStatus.Builder	builder()
Instant	completionDateTime()	The date and time that the query completed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryExecutionStatus.Builder>	serializableBuilderClass()
QueryExecutionState	state()	The state of query execution.
String	stateAsString()	The state of query execution.
String	stateChangeReason()	Further detail about the status of the query.
Instant	submissionDateTime()	The date and time that the query was submitted.
QueryExecutionStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

QueryExecutionState

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:

QueryExecutionState

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()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryExecutionStatus.Builder,QueryExecutionStatus>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo