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(value="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 and Description
static interface	QueryExecutionStatus.Builder

Method Summary

Modifier and Type	Method and Description
static QueryExecutionStatus.Builder	builder()
Instant	completionDateTime() The date and time that the query completed.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

state

public QueryExecutionState state()

The state of query execution. QUEUED state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without error. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that user input interrupted query execution.

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 state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without error. FAILED indicates that the query experienced an error and did not complete processing.CANCELLED indicates that user input interrupted query execution.

See Also:

QueryExecutionState

stateAsString

public String stateAsString()

The state of query execution. QUEUED state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without error. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that user input interrupted query execution.

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 state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without error. FAILED indicates that the query experienced an error and did not complete processing.CANCELLED indicates that user input interrupted query execution.

See Also:

QueryExecutionState

stateChangeReason

public String stateChangeReason()

Further detail about the status of the query.

Returns:

Further detail about the status of the query.

submissionDateTime

public Instant submissionDateTime()

The date and time that the query was submitted.

Returns:

The date and time that the query was submitted.

completionDateTime

public Instant completionDateTime()

The date and time that the query completed.

Returns:

The date and time that the query completed.

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

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.