Interface StartCalculationExecutionRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartCalculationExecutionRequest

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

Method Summary

Modifier and Type	Method	Description
default StartCalculationExecutionRequest.Builder	calculationConfiguration(Consumer<CalculationConfiguration.Builder> calculationConfiguration)	Deprecated. Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828
StartCalculationExecutionRequest.Builder	calculationConfiguration(CalculationConfiguration calculationConfiguration)	Deprecated. Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828
StartCalculationExecutionRequest.Builder	clientRequestToken(String clientRequestToken)	A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once).
StartCalculationExecutionRequest.Builder	codeBlock(String codeBlock)	A string that contains the code of the calculation.
StartCalculationExecutionRequest.Builder	description(String description)	A description of the calculation.
StartCalculationExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartCalculationExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartCalculationExecutionRequest.Builder	sessionId(String sessionId)	The session ID.

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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

sessionId

StartCalculationExecutionRequest.Builder sessionId(String sessionId)

The session ID.

Parameters:

sessionId - The session ID.

Returns:

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

description

StartCalculationExecutionRequest.Builder description(String description)

A description of the calculation.

Parameters:

description - A description of the calculation.

Returns:

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

calculationConfiguration

@Deprecated
StartCalculationExecutionRequest.Builder calculationConfiguration(CalculationConfiguration calculationConfiguration)

Deprecated.

Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828

Contains configuration information for the calculation.

Parameters:

calculationConfiguration - Contains configuration information for the calculation.

Returns:

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

calculationConfiguration

@Deprecated
default StartCalculationExecutionRequest.Builder calculationConfiguration(Consumer<CalculationConfiguration.Builder> calculationConfiguration)

Deprecated.

Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828

Contains configuration information for the calculation.

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

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

Parameters:

calculationConfiguration - a consumer that will call methods on CalculationConfiguration.Builder

Returns:

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

See Also:

• calculationConfiguration(CalculationConfiguration)

codeBlock

StartCalculationExecutionRequest.Builder codeBlock(String codeBlock)

A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

Parameters:

codeBlock - A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

Returns:

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

clientRequestToken

StartCalculationExecutionRequest.Builder clientRequestToken(String clientRequestToken)

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

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services 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 calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services 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.

overrideConfiguration

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

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