software.amazon.awssdk.services.athena.model

Interface QueryExecutionStatistics.Builder

All Superinterfaces:

Buildable, CopyableBuilder<QueryExecutionStatistics.Builder,QueryExecutionStatistics>, SdkBuilder<QueryExecutionStatistics.Builder,QueryExecutionStatistics>, SdkPojo

Enclosing class:

QueryExecutionStatistics

public static interface QueryExecutionStatistics.Builder
extends SdkPojo, CopyableBuilder<QueryExecutionStatistics.Builder,QueryExecutionStatistics>

Method Summary

Modifier and Type	Method and Description
QueryExecutionStatistics.Builder	dataManifestLocation(String dataManifestLocation) The location and file name of a data manifest file.
QueryExecutionStatistics.Builder	dataScannedInBytes(Long dataScannedInBytes) The number of bytes in the data that was queried.
QueryExecutionStatistics.Builder	engineExecutionTimeInMillis(Long engineExecutionTimeInMillis) The number of milliseconds that the query took to execute.
QueryExecutionStatistics.Builder	queryPlanningTimeInMillis(Long queryPlanningTimeInMillis) The number of milliseconds that Athena took to plan the query processing flow.
QueryExecutionStatistics.Builder	queryQueueTimeInMillis(Long queryQueueTimeInMillis) The number of milliseconds that the query was in your query queue waiting for resources.
default QueryExecutionStatistics.Builder	resultReuseInformation(Consumer<ResultReuseInformation.Builder> resultReuseInformation) Contains information about whether previous query results were reused for the query.
QueryExecutionStatistics.Builder	resultReuseInformation(ResultReuseInformation resultReuseInformation) Contains information about whether previous query results were reused for the query.
QueryExecutionStatistics.Builder	serviceProcessingTimeInMillis(Long serviceProcessingTimeInMillis) The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
QueryExecutionStatistics.Builder	totalExecutionTimeInMillis(Long totalExecutionTimeInMillis) The number of milliseconds that Athena took to run the query.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

engineExecutionTimeInMillis

QueryExecutionStatistics.Builder engineExecutionTimeInMillis(Long engineExecutionTimeInMillis)

The number of milliseconds that the query took to execute.

Parameters:

engineExecutionTimeInMillis - The number of milliseconds that the query took to execute.

Returns:

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

dataScannedInBytes

QueryExecutionStatistics.Builder dataScannedInBytes(Long dataScannedInBytes)

The number of bytes in the data that was queried.

Parameters:

dataScannedInBytes - The number of bytes in the data that was queried.

Returns:

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

dataManifestLocation

QueryExecutionStatistics.Builder dataManifestLocation(String dataManifestLocation)

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.

Parameters:

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

Returns:

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

totalExecutionTimeInMillis

QueryExecutionStatistics.Builder totalExecutionTimeInMillis(Long totalExecutionTimeInMillis)

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

Parameters:

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

Returns:

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

queryQueueTimeInMillis

QueryExecutionStatistics.Builder queryQueueTimeInMillis(Long queryQueueTimeInMillis)

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.

Parameters:

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

Returns:

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

queryPlanningTimeInMillis

QueryExecutionStatistics.Builder queryPlanningTimeInMillis(Long queryPlanningTimeInMillis)

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.

Parameters:

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

Returns:

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

serviceProcessingTimeInMillis

QueryExecutionStatistics.Builder serviceProcessingTimeInMillis(Long serviceProcessingTimeInMillis)

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

Parameters:

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

Returns:

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

resultReuseInformation

QueryExecutionStatistics.Builder resultReuseInformation(ResultReuseInformation resultReuseInformation)

Contains information about whether previous query results were reused for the query.

Parameters:

resultReuseInformation - Contains information about whether previous query results were reused for the query.

Returns:

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

resultReuseInformation

default QueryExecutionStatistics.Builder resultReuseInformation(Consumer<ResultReuseInformation.Builder> resultReuseInformation)

Contains information about whether previous query results were reused for the query.

This is a convenience method that creates an instance of the ResultReuseInformation.Builder avoiding the need to create one manually via ResultReuseInformation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resultReuseInformation(ResultReuseInformation).

Parameters:

resultReuseInformation - a consumer that will call methods on ResultReuseInformation.Builder

Returns:

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

See Also:

resultReuseInformation(ResultReuseInformation)