software.amazon.awssdk.services.athena.model

Class QueryExecution

java.lang.Object

software.amazon.awssdk.services.athena.model.QueryExecution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QueryExecution.Builder,QueryExecution>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryExecution
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QueryExecution.Builder,QueryExecution>

Information about a single instance of a query execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryExecution.Builder

Method Summary

Modifier and Type	Method and Description
static QueryExecution.Builder	builder()
EngineVersion	engineVersion() The engine version that executed the query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	query() The SQL query statements which the query execution ran.
QueryExecutionContext	queryExecutionContext() The database in which the query execution occurred.
String	queryExecutionId() The unique identifier for each query execution.
ResultConfiguration	resultConfiguration() The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryExecution.Builder>	serializableBuilderClass()
StatementType	statementType() The type of query statement that was run.
String	statementTypeAsString() The type of query statement that was run.
QueryExecutionStatistics	statistics() Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
QueryExecutionStatus	status() The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
QueryExecution.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workGroup() The name of the workgroup in which the query ran.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

queryExecutionId

public final String queryExecutionId()

The unique identifier for each query execution.

Returns:

The unique identifier for each query execution.

query

public final String query()

The SQL query statements which the query execution ran.

Returns:

The SQL query statements which the query execution ran.

statementType

public final StatementType statementType()

The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

If the service returns an enum value that is not available in the current SDK version, statementType will return StatementType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statementTypeAsString().

Returns:

The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

See Also:

StatementType

statementTypeAsString

public final String statementTypeAsString()

The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

If the service returns an enum value that is not available in the current SDK version, statementType will return StatementType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statementTypeAsString().

Returns:

The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

See Also:

StatementType

resultConfiguration

public final ResultConfiguration resultConfiguration()

The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

Returns:

The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

queryExecutionContext

public final QueryExecutionContext queryExecutionContext()

The database in which the query execution occurred.

Returns:

The database in which the query execution occurred.

status

public final QueryExecutionStatus status()

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

Returns:

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

statistics

public final QueryExecutionStatistics statistics()

Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

Returns:

Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

workGroup

public final String workGroup()

The name of the workgroup in which the query ran.

Returns:

The name of the workgroup in which the query ran.

engineVersion

public final EngineVersion engineVersion()

The engine version that executed the query.

Returns:

The engine version that executed the query.

toBuilder

public QueryExecution.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryExecution.Builder,QueryExecution>

builder

public static QueryExecution.Builder builder()

serializableBuilderClass

public static Class<? extends QueryExecution.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo