com.amazonaws.services.athena.model

Class QueryExecutionStatus

java.lang.Object

com.amazonaws.services.athena.model.QueryExecutionStatus

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class QueryExecutionStatus
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryExecutionStatus()

Method Summary

Modifier and Type	Method and Description
QueryExecutionStatus	clone()
boolean	equals(Object obj)
AthenaError	getAthenaError() Provides information about an Athena query error.
Date	getCompletionDateTime() The date and time that the query completed.
String	getState() The state of query execution.
String	getStateChangeReason() Further detail about the status of the query.
Date	getSubmissionDateTime() The date and time that the query was submitted.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAthenaError(AthenaError athenaError) Provides information about an Athena query error.
void	setCompletionDateTime(Date completionDateTime) The date and time that the query completed.
void	setState(QueryExecutionState state) The state of query execution.
void	setState(String state) The state of query execution.
void	setStateChangeReason(String stateChangeReason) Further detail about the status of the query.
void	setSubmissionDateTime(Date submissionDateTime) The date and time that the query was submitted.
String	toString() Returns a string representation of this object.
QueryExecutionStatus	withAthenaError(AthenaError athenaError) Provides information about an Athena query error.
QueryExecutionStatus	withCompletionDateTime(Date completionDateTime) The date and time that the query completed.
QueryExecutionStatus	withState(QueryExecutionState state) The state of query execution.
QueryExecutionStatus	withState(String state) The state of query execution.
QueryExecutionStatus	withStateChangeReason(String stateChangeReason) Further detail about the status of the query.
QueryExecutionStatus	withSubmissionDateTime(Date submissionDateTime) The date and time that the query was submitted.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryExecutionStatus

public QueryExecutionStatus()

Method Detail

setState

public void setState(String 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.

Parameters:

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.

See Also:

QueryExecutionState

getState

public String getState()

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.

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

withState

public QueryExecutionStatus withState(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryExecutionState

setState

public void setState(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.

Parameters:

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.

See Also:

QueryExecutionState

withState

public QueryExecutionStatus withState(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryExecutionState

setStateChangeReason

public void setStateChangeReason(String stateChangeReason)

Further detail about the status of the query.

Parameters:

stateChangeReason - Further detail about the status of the query.

getStateChangeReason

public String getStateChangeReason()

Further detail about the status of the query.

Returns:

Further detail about the status of the query.

withStateChangeReason

public QueryExecutionStatus withStateChangeReason(String stateChangeReason)

Further detail about the status of the query.

Parameters:

stateChangeReason - Further detail about the status of the query.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSubmissionDateTime

public void setSubmissionDateTime(Date submissionDateTime)

The date and time that the query was submitted.

Parameters:

submissionDateTime - The date and time that the query was submitted.

getSubmissionDateTime

public Date getSubmissionDateTime()

The date and time that the query was submitted.

Returns:

The date and time that the query was submitted.

withSubmissionDateTime

public QueryExecutionStatus withSubmissionDateTime(Date submissionDateTime)

The date and time that the query was submitted.

Parameters:

submissionDateTime - The date and time that the query was submitted.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCompletionDateTime

public void setCompletionDateTime(Date completionDateTime)

The date and time that the query completed.

Parameters:

completionDateTime - The date and time that the query completed.

getCompletionDateTime

public Date getCompletionDateTime()

The date and time that the query completed.

Returns:

The date and time that the query completed.

withCompletionDateTime

public QueryExecutionStatus withCompletionDateTime(Date completionDateTime)

The date and time that the query completed.

Parameters:

completionDateTime - The date and time that the query completed.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAthenaError

public void setAthenaError(AthenaError athenaError)

Provides information about an Athena query error.

Parameters:

athenaError - Provides information about an Athena query error.

getAthenaError

public AthenaError getAthenaError()

Provides information about an Athena query error.

Returns:

Provides information about an Athena query error.

withAthenaError

public QueryExecutionStatus withAthenaError(AthenaError athenaError)

Provides information about an Athena query error.

Parameters:

athenaError - Provides information about an Athena query error.

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