AWS SDK for C++  1.9.128
AWS SDK for C++
Public Member Functions | List of all members
Aws::Athena::Model::QueryExecutionStatus Class Reference

#include <QueryExecutionStatus.h>

Public Member Functions

 QueryExecutionStatus ()
 
 QueryExecutionStatus (Aws::Utils::Json::JsonView jsonValue)
 
QueryExecutionStatusoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const QueryExecutionStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const QueryExecutionState &value)
 
void SetState (QueryExecutionState &&value)
 
QueryExecutionStatusWithState (const QueryExecutionState &value)
 
QueryExecutionStatusWithState (QueryExecutionState &&value)
 
const Aws::StringGetStateChangeReason () const
 
bool StateChangeReasonHasBeenSet () const
 
void SetStateChangeReason (const Aws::String &value)
 
void SetStateChangeReason (Aws::String &&value)
 
void SetStateChangeReason (const char *value)
 
QueryExecutionStatusWithStateChangeReason (const Aws::String &value)
 
QueryExecutionStatusWithStateChangeReason (Aws::String &&value)
 
QueryExecutionStatusWithStateChangeReason (const char *value)
 
const Aws::Utils::DateTimeGetSubmissionDateTime () const
 
bool SubmissionDateTimeHasBeenSet () const
 
void SetSubmissionDateTime (const Aws::Utils::DateTime &value)
 
void SetSubmissionDateTime (Aws::Utils::DateTime &&value)
 
QueryExecutionStatusWithSubmissionDateTime (const Aws::Utils::DateTime &value)
 
QueryExecutionStatusWithSubmissionDateTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletionDateTime () const
 
bool CompletionDateTimeHasBeenSet () const
 
void SetCompletionDateTime (const Aws::Utils::DateTime &value)
 
void SetCompletionDateTime (Aws::Utils::DateTime &&value)
 
QueryExecutionStatusWithCompletionDateTime (const Aws::Utils::DateTime &value)
 
QueryExecutionStatusWithCompletionDateTime (Aws::Utils::DateTime &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file QueryExecutionStatus.h.

Constructor & Destructor Documentation

◆ QueryExecutionStatus() [1/2]

Aws::Athena::Model::QueryExecutionStatus::QueryExecutionStatus ( )

◆ QueryExecutionStatus() [2/2]

Aws::Athena::Model::QueryExecutionStatus::QueryExecutionStatus ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CompletionDateTimeHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatus::CompletionDateTimeHasBeenSet ( ) const
inline

The date and time that the query completed.

Definition at line 208 of file QueryExecutionStatus.h.

◆ GetCompletionDateTime()

const Aws::Utils::DateTime& Aws::Athena::Model::QueryExecutionStatus::GetCompletionDateTime ( ) const
inline

The date and time that the query completed.

Definition at line 203 of file QueryExecutionStatus.h.

◆ GetState()

const QueryExecutionState& Aws::Athena::Model::QueryExecutionStatus::GetState ( ) const
inline

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.

Definition at line 55 of file QueryExecutionStatus.h.

◆ GetStateChangeReason()

const Aws::String& Aws::Athena::Model::QueryExecutionStatus::GetStateChangeReason ( ) const
inline

Further detail about the status of the query.

Definition at line 131 of file QueryExecutionStatus.h.

◆ GetSubmissionDateTime()

const Aws::Utils::DateTime& Aws::Athena::Model::QueryExecutionStatus::GetSubmissionDateTime ( ) const
inline

The date and time that the query was submitted.

Definition at line 172 of file QueryExecutionStatus.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Athena::Model::QueryExecutionStatus::Jsonize ( ) const

◆ operator=()

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCompletionDateTime() [1/2]

void Aws::Athena::Model::QueryExecutionStatus::SetCompletionDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that the query completed.

Definition at line 218 of file QueryExecutionStatus.h.

◆ SetCompletionDateTime() [2/2]

void Aws::Athena::Model::QueryExecutionStatus::SetCompletionDateTime ( const Aws::Utils::DateTime value)
inline

The date and time that the query completed.

Definition at line 213 of file QueryExecutionStatus.h.

◆ SetState() [1/2]

void Aws::Athena::Model::QueryExecutionStatus::SetState ( const QueryExecutionState value)
inline

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.

Definition at line 83 of file QueryExecutionStatus.h.

◆ SetState() [2/2]

void Aws::Athena::Model::QueryExecutionStatus::SetState ( QueryExecutionState &&  value)
inline

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.

Definition at line 97 of file QueryExecutionStatus.h.

◆ SetStateChangeReason() [1/3]

void Aws::Athena::Model::QueryExecutionStatus::SetStateChangeReason ( Aws::String &&  value)
inline

Further detail about the status of the query.

Definition at line 146 of file QueryExecutionStatus.h.

◆ SetStateChangeReason() [2/3]

void Aws::Athena::Model::QueryExecutionStatus::SetStateChangeReason ( const Aws::String value)
inline

Further detail about the status of the query.

Definition at line 141 of file QueryExecutionStatus.h.

◆ SetStateChangeReason() [3/3]

void Aws::Athena::Model::QueryExecutionStatus::SetStateChangeReason ( const char *  value)
inline

Further detail about the status of the query.

Definition at line 151 of file QueryExecutionStatus.h.

◆ SetSubmissionDateTime() [1/2]

void Aws::Athena::Model::QueryExecutionStatus::SetSubmissionDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that the query was submitted.

Definition at line 187 of file QueryExecutionStatus.h.

◆ SetSubmissionDateTime() [2/2]

void Aws::Athena::Model::QueryExecutionStatus::SetSubmissionDateTime ( const Aws::Utils::DateTime value)
inline

The date and time that the query was submitted.

Definition at line 182 of file QueryExecutionStatus.h.

◆ StateChangeReasonHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatus::StateChangeReasonHasBeenSet ( ) const
inline

Further detail about the status of the query.

Definition at line 136 of file QueryExecutionStatus.h.

◆ StateHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatus::StateHasBeenSet ( ) const
inline

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.

Definition at line 69 of file QueryExecutionStatus.h.

◆ SubmissionDateTimeHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatus::SubmissionDateTimeHasBeenSet ( ) const
inline

The date and time that the query was submitted.

Definition at line 177 of file QueryExecutionStatus.h.

◆ WithCompletionDateTime() [1/2]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithCompletionDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that the query completed.

Definition at line 228 of file QueryExecutionStatus.h.

◆ WithCompletionDateTime() [2/2]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithCompletionDateTime ( const Aws::Utils::DateTime value)
inline

The date and time that the query completed.

Definition at line 223 of file QueryExecutionStatus.h.

◆ WithState() [1/2]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithState ( const QueryExecutionState value)
inline

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.

Definition at line 111 of file QueryExecutionStatus.h.

◆ WithState() [2/2]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithState ( QueryExecutionState &&  value)
inline

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.

Definition at line 125 of file QueryExecutionStatus.h.

◆ WithStateChangeReason() [1/3]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithStateChangeReason ( Aws::String &&  value)
inline

Further detail about the status of the query.

Definition at line 161 of file QueryExecutionStatus.h.

◆ WithStateChangeReason() [2/3]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithStateChangeReason ( const Aws::String value)
inline

Further detail about the status of the query.

Definition at line 156 of file QueryExecutionStatus.h.

◆ WithStateChangeReason() [3/3]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithStateChangeReason ( const char *  value)
inline

Further detail about the status of the query.

Definition at line 166 of file QueryExecutionStatus.h.

◆ WithSubmissionDateTime() [1/2]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithSubmissionDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that the query was submitted.

Definition at line 197 of file QueryExecutionStatus.h.

◆ WithSubmissionDateTime() [2/2]

QueryExecutionStatus& Aws::Athena::Model::QueryExecutionStatus::WithSubmissionDateTime ( const Aws::Utils::DateTime value)
inline

The date and time that the query was submitted.

Definition at line 192 of file QueryExecutionStatus.h.


The documentation for this class was generated from the following file: