Package 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("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:

  • Method Details

    • 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:

    • 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:

    • resultConfiguration

      public final ResultConfiguration resultConfiguration()

      The location in Amazon S3 where query and calculation results are 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 and calculation results are 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.

    • resultReuseConfiguration

      public final ResultReuseConfiguration resultReuseConfiguration()

      Specifies the query result reuse behavior that was used for the query.

      Returns:
      Specifies the query result reuse behavior that was used for the query.

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

    • hasExecutionParameters

      public final boolean hasExecutionParameters()
      For responses, this returns true if the service returned a value for the ExecutionParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • executionParameters

      public final List<String> executionParameters()

      A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExecutionParameters() method.

      Returns:
      A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

    • substatementType

      public final String substatementType()

      The kind of query statement that was run.

      Returns:
      The kind of query statement that was run.

    • queryResultsS3AccessGrantsConfiguration

      public final QueryResultsS3AccessGrantsConfiguration queryResultsS3AccessGrantsConfiguration()

      Specifies whether Amazon S3 access grants are enabled for query results.

      Returns:
      Specifies whether Amazon S3 access grants are enabled for query results.

    • toBuilder

      public QueryExecution.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<QueryExecution.Builder,QueryExecution>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.