Package software.amazon.awssdk.services.athena.model

Interface QueryExecution.Builder

All Superinterfaces:
Buildable, CopyableBuilder<QueryExecution.Builder,QueryExecution>, SdkBuilder<QueryExecution.Builder,QueryExecution>, SdkPojo
Enclosing class:
QueryExecution
public static interface QueryExecution.Builder extends SdkPojo, CopyableBuilder<QueryExecution.Builder,QueryExecution>

  • Method Details

    • queryExecutionId

      QueryExecution.Builder queryExecutionId(String queryExecutionId)

      The unique identifier for each query execution.

      Parameters:
      queryExecutionId - The unique identifier for each query execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • query

      QueryExecution.Builder query(String query)

      The SQL query statements which the query execution ran.

      Parameters:
      query - The SQL query statements which the query execution ran.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statementType

      QueryExecution.Builder statementType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statementType

      QueryExecution.Builder statementType(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resultConfiguration

      QueryExecution.Builder resultConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resultConfiguration

      default QueryExecution.Builder resultConfiguration(Consumer<ResultConfiguration.Builder> 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.

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

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

      Parameters:
      resultConfiguration - a consumer that will call methods on ResultConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resultReuseConfiguration

      QueryExecution.Builder resultReuseConfiguration(ResultReuseConfiguration resultReuseConfiguration)

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

      Parameters:
      resultReuseConfiguration - Specifies the query result reuse behavior that was used for the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultReuseConfiguration

      default QueryExecution.Builder resultReuseConfiguration(Consumer<ResultReuseConfiguration.Builder> resultReuseConfiguration)

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

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

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

      Parameters:
      resultReuseConfiguration - a consumer that will call methods on ResultReuseConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryExecutionContext

      QueryExecution.Builder queryExecutionContext(QueryExecutionContext queryExecutionContext)

      The database in which the query execution occurred.

      Parameters:
      queryExecutionContext - The database in which the query execution occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryExecutionContext

      default QueryExecution.Builder queryExecutionContext(Consumer<QueryExecutionContext.Builder> queryExecutionContext)

      The database in which the query execution occurred.

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

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

      Parameters:
      queryExecutionContext - a consumer that will call methods on QueryExecutionContext.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      QueryExecution.Builder status(QueryExecutionStatus status)

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

      Parameters:
      status - The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      default QueryExecution.Builder status(Consumer<QueryExecutionStatus.Builder> status)

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

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

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

      Parameters:
      status - a consumer that will call methods on QueryExecutionStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statistics

      QueryExecution.Builder statistics(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      default QueryExecution.Builder statistics(Consumer<QueryExecutionStatistics.Builder> 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.

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

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

      Parameters:
      statistics - a consumer that will call methods on QueryExecutionStatistics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workGroup

      QueryExecution.Builder workGroup(String workGroup)

      The name of the workgroup in which the query ran.

      Parameters:
      workGroup - The name of the workgroup in which the query ran.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      QueryExecution.Builder engineVersion(EngineVersion engineVersion)

      The engine version that executed the query.

      Parameters:
      engineVersion - The engine version that executed the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      default QueryExecution.Builder engineVersion(Consumer<EngineVersion.Builder> engineVersion)

      The engine version that executed the query.

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

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

      Parameters:
      engineVersion - a consumer that will call methods on EngineVersion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionParameters

      QueryExecution.Builder executionParameters(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionParameters

      QueryExecution.Builder executionParameters(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • substatementType

      QueryExecution.Builder substatementType(String substatementType)

      The kind of query statement that was run.

      Parameters:
      substatementType - The kind of query statement that was run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryResultsS3AccessGrantsConfiguration

      QueryExecution.Builder queryResultsS3AccessGrantsConfiguration(QueryResultsS3AccessGrantsConfiguration queryResultsS3AccessGrantsConfiguration)

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

      Parameters:
      queryResultsS3AccessGrantsConfiguration - Specifies whether Amazon S3 access grants are enabled for query results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryResultsS3AccessGrantsConfiguration

      default QueryExecution.Builder queryResultsS3AccessGrantsConfiguration(Consumer<QueryResultsS3AccessGrantsConfiguration.Builder> queryResultsS3AccessGrantsConfiguration)

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

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

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

      Parameters:
      queryResultsS3AccessGrantsConfiguration - a consumer that will call methods on QueryResultsS3AccessGrantsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: