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

#include <QueryExecutionStatistics.h>

Public Member Functions

 QueryExecutionStatistics ()
 
 QueryExecutionStatistics (Aws::Utils::Json::JsonView jsonValue)
 
QueryExecutionStatisticsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
long long GetEngineExecutionTimeInMillis () const
 
bool EngineExecutionTimeInMillisHasBeenSet () const
 
void SetEngineExecutionTimeInMillis (long long value)
 
QueryExecutionStatisticsWithEngineExecutionTimeInMillis (long long value)
 
long long GetDataScannedInBytes () const
 
bool DataScannedInBytesHasBeenSet () const
 
void SetDataScannedInBytes (long long value)
 
QueryExecutionStatisticsWithDataScannedInBytes (long long value)
 
const Aws::StringGetDataManifestLocation () const
 
bool DataManifestLocationHasBeenSet () const
 
void SetDataManifestLocation (const Aws::String &value)
 
void SetDataManifestLocation (Aws::String &&value)
 
void SetDataManifestLocation (const char *value)
 
QueryExecutionStatisticsWithDataManifestLocation (const Aws::String &value)
 
QueryExecutionStatisticsWithDataManifestLocation (Aws::String &&value)
 
QueryExecutionStatisticsWithDataManifestLocation (const char *value)
 
long long GetTotalExecutionTimeInMillis () const
 
bool TotalExecutionTimeInMillisHasBeenSet () const
 
void SetTotalExecutionTimeInMillis (long long value)
 
QueryExecutionStatisticsWithTotalExecutionTimeInMillis (long long value)
 
long long GetQueryQueueTimeInMillis () const
 
bool QueryQueueTimeInMillisHasBeenSet () const
 
void SetQueryQueueTimeInMillis (long long value)
 
QueryExecutionStatisticsWithQueryQueueTimeInMillis (long long value)
 
long long GetQueryPlanningTimeInMillis () const
 
bool QueryPlanningTimeInMillisHasBeenSet () const
 
void SetQueryPlanningTimeInMillis (long long value)
 
QueryExecutionStatisticsWithQueryPlanningTimeInMillis (long long value)
 
long long GetServiceProcessingTimeInMillis () const
 
bool ServiceProcessingTimeInMillisHasBeenSet () const
 
void SetServiceProcessingTimeInMillis (long long value)
 
QueryExecutionStatisticsWithServiceProcessingTimeInMillis (long long value)
 

Detailed Description

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

See Also:

AWS API Reference

Definition at line 33 of file QueryExecutionStatistics.h.

Constructor & Destructor Documentation

◆ QueryExecutionStatistics() [1/2]

Aws::Athena::Model::QueryExecutionStatistics::QueryExecutionStatistics ( )

◆ QueryExecutionStatistics() [2/2]

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

Member Function Documentation

◆ DataManifestLocationHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::DataManifestLocationHasBeenSet ( ) const
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 108 of file QueryExecutionStatistics.h.

◆ DataScannedInBytesHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::DataScannedInBytesHasBeenSet ( ) const
inline

The number of bytes in the data that was queried.

Definition at line 71 of file QueryExecutionStatistics.h.

◆ EngineExecutionTimeInMillisHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::EngineExecutionTimeInMillisHasBeenSet ( ) const
inline

The number of milliseconds that the query took to execute.

Definition at line 50 of file QueryExecutionStatistics.h.

◆ GetDataManifestLocation()

const Aws::String& Aws::Athena::Model::QueryExecutionStatistics::GetDataManifestLocation ( ) const
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 95 of file QueryExecutionStatistics.h.

◆ GetDataScannedInBytes()

long long Aws::Athena::Model::QueryExecutionStatistics::GetDataScannedInBytes ( ) const
inline

The number of bytes in the data that was queried.

Definition at line 66 of file QueryExecutionStatistics.h.

◆ GetEngineExecutionTimeInMillis()

long long Aws::Athena::Model::QueryExecutionStatistics::GetEngineExecutionTimeInMillis ( ) const
inline

The number of milliseconds that the query took to execute.

Definition at line 45 of file QueryExecutionStatistics.h.

◆ GetQueryPlanningTimeInMillis()

long long Aws::Athena::Model::QueryExecutionStatistics::GetQueryPlanningTimeInMillis ( ) const
inline

The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

Definition at line 245 of file QueryExecutionStatistics.h.

◆ GetQueryQueueTimeInMillis()

long long Aws::Athena::Model::QueryExecutionStatistics::GetQueryQueueTimeInMillis ( ) const
inline

The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

Definition at line 215 of file QueryExecutionStatistics.h.

◆ GetServiceProcessingTimeInMillis()

long long Aws::Athena::Model::QueryExecutionStatistics::GetServiceProcessingTimeInMillis ( ) const
inline

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

Definition at line 276 of file QueryExecutionStatistics.h.

◆ GetTotalExecutionTimeInMillis()

long long Aws::Athena::Model::QueryExecutionStatistics::GetTotalExecutionTimeInMillis ( ) const
inline

The number of milliseconds that Athena took to run the query.

Definition at line 192 of file QueryExecutionStatistics.h.

◆ Jsonize()

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

◆ operator=()

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

◆ QueryPlanningTimeInMillisHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::QueryPlanningTimeInMillisHasBeenSet ( ) const
inline

The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

Definition at line 253 of file QueryExecutionStatistics.h.

◆ QueryQueueTimeInMillisHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::QueryQueueTimeInMillisHasBeenSet ( ) const
inline

The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

Definition at line 222 of file QueryExecutionStatistics.h.

◆ ServiceProcessingTimeInMillisHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::ServiceProcessingTimeInMillisHasBeenSet ( ) const
inline

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

Definition at line 282 of file QueryExecutionStatistics.h.

◆ SetDataManifestLocation() [1/3]

void Aws::Athena::Model::QueryExecutionStatistics::SetDataManifestLocation ( Aws::String &&  value)
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 134 of file QueryExecutionStatistics.h.

◆ SetDataManifestLocation() [2/3]

void Aws::Athena::Model::QueryExecutionStatistics::SetDataManifestLocation ( const Aws::String value)
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 121 of file QueryExecutionStatistics.h.

◆ SetDataManifestLocation() [3/3]

void Aws::Athena::Model::QueryExecutionStatistics::SetDataManifestLocation ( const char *  value)
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 147 of file QueryExecutionStatistics.h.

◆ SetDataScannedInBytes()

void Aws::Athena::Model::QueryExecutionStatistics::SetDataScannedInBytes ( long long  value)
inline

The number of bytes in the data that was queried.

Definition at line 76 of file QueryExecutionStatistics.h.

◆ SetEngineExecutionTimeInMillis()

void Aws::Athena::Model::QueryExecutionStatistics::SetEngineExecutionTimeInMillis ( long long  value)
inline

The number of milliseconds that the query took to execute.

Definition at line 55 of file QueryExecutionStatistics.h.

◆ SetQueryPlanningTimeInMillis()

void Aws::Athena::Model::QueryExecutionStatistics::SetQueryPlanningTimeInMillis ( long long  value)
inline

The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

Definition at line 261 of file QueryExecutionStatistics.h.

◆ SetQueryQueueTimeInMillis()

void Aws::Athena::Model::QueryExecutionStatistics::SetQueryQueueTimeInMillis ( long long  value)
inline

The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

Definition at line 229 of file QueryExecutionStatistics.h.

◆ SetServiceProcessingTimeInMillis()

void Aws::Athena::Model::QueryExecutionStatistics::SetServiceProcessingTimeInMillis ( long long  value)
inline

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

Definition at line 288 of file QueryExecutionStatistics.h.

◆ SetTotalExecutionTimeInMillis()

void Aws::Athena::Model::QueryExecutionStatistics::SetTotalExecutionTimeInMillis ( long long  value)
inline

The number of milliseconds that Athena took to run the query.

Definition at line 202 of file QueryExecutionStatistics.h.

◆ TotalExecutionTimeInMillisHasBeenSet()

bool Aws::Athena::Model::QueryExecutionStatistics::TotalExecutionTimeInMillisHasBeenSet ( ) const
inline

The number of milliseconds that Athena took to run the query.

Definition at line 197 of file QueryExecutionStatistics.h.

◆ WithDataManifestLocation() [1/3]

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithDataManifestLocation ( Aws::String &&  value)
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 173 of file QueryExecutionStatistics.h.

◆ WithDataManifestLocation() [2/3]

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithDataManifestLocation ( const Aws::String value)
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 160 of file QueryExecutionStatistics.h.

◆ WithDataManifestLocation() [3/3]

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithDataManifestLocation ( const char *  value)
inline

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

Definition at line 186 of file QueryExecutionStatistics.h.

◆ WithDataScannedInBytes()

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithDataScannedInBytes ( long long  value)
inline

The number of bytes in the data that was queried.

Definition at line 81 of file QueryExecutionStatistics.h.

◆ WithEngineExecutionTimeInMillis()

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithEngineExecutionTimeInMillis ( long long  value)
inline

The number of milliseconds that the query took to execute.

Definition at line 60 of file QueryExecutionStatistics.h.

◆ WithQueryPlanningTimeInMillis()

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithQueryPlanningTimeInMillis ( long long  value)
inline

The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

Definition at line 269 of file QueryExecutionStatistics.h.

◆ WithQueryQueueTimeInMillis()

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithQueryQueueTimeInMillis ( long long  value)
inline

The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

Definition at line 236 of file QueryExecutionStatistics.h.

◆ WithServiceProcessingTimeInMillis()

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithServiceProcessingTimeInMillis ( long long  value)
inline

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

Definition at line 294 of file QueryExecutionStatistics.h.

◆ WithTotalExecutionTimeInMillis()

QueryExecutionStatistics& Aws::Athena::Model::QueryExecutionStatistics::WithTotalExecutionTimeInMillis ( long long  value)
inline

The number of milliseconds that Athena took to run the query.

Definition at line 207 of file QueryExecutionStatistics.h.


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