software.amazon.awssdk.services.athena.model

Interface StartQueryExecutionRequest.Builder

All Superinterfaces:

AthenaRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartQueryExecutionRequest.Builder,StartQueryExecutionRequest>, SdkBuilder<StartQueryExecutionRequest.Builder,StartQueryExecutionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartQueryExecutionRequest

public static interface StartQueryExecutionRequest.Builder
extends AthenaRequest.Builder, SdkPojo, CopyableBuilder<StartQueryExecutionRequest.Builder,StartQueryExecutionRequest>

Method Summary

Modifier and Type	Method and Description
StartQueryExecutionRequest.Builder	clientRequestToken(String clientRequestToken) A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
StartQueryExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartQueryExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default StartQueryExecutionRequest.Builder	queryExecutionContext(Consumer<QueryExecutionContext.Builder> queryExecutionContext) The database within which the query executes.
StartQueryExecutionRequest.Builder	queryExecutionContext(QueryExecutionContext queryExecutionContext) The database within which the query executes.
StartQueryExecutionRequest.Builder	queryString(String queryString) The SQL query statements to be executed.
default StartQueryExecutionRequest.Builder	resultConfiguration(Consumer<ResultConfiguration.Builder> resultConfiguration) Specifies information about where and how to save the results of the query execution.
StartQueryExecutionRequest.Builder	resultConfiguration(ResultConfiguration resultConfiguration) Specifies information about where and how to save the results of the query execution.

Methods inherited from interface software.amazon.awssdk.services.athena.model.AthenaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

queryString

StartQueryExecutionRequest.Builder queryString(String queryString)

The SQL query statements to be executed.

Parameters:

queryString - The SQL query statements to be executed.

Returns:

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

clientRequestToken

StartQueryExecutionRequest.Builder clientRequestToken(String clientRequestToken)

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

Parameters:

clientRequestToken - A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

Returns:

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

queryExecutionContext

StartQueryExecutionRequest.Builder queryExecutionContext(QueryExecutionContext queryExecutionContext)

The database within which the query executes.

Parameters:

queryExecutionContext - The database within which the query executes.

Returns:

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

queryExecutionContext

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

The database within which the query executes.

This is a convenience 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:

queryExecutionContext(QueryExecutionContext)

resultConfiguration

StartQueryExecutionRequest.Builder resultConfiguration(ResultConfiguration resultConfiguration)

Specifies information about where and how to save the results of the query execution.

Parameters:

resultConfiguration - Specifies information about where and how to save the results of the query execution.

Returns:

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

resultConfiguration

default StartQueryExecutionRequest.Builder resultConfiguration(Consumer<ResultConfiguration.Builder> resultConfiguration)

Specifies information about where and how to save the results of the query execution.

This is a convenience 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:

resultConfiguration(ResultConfiguration)

overrideConfiguration

StartQueryExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartQueryExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.