software.amazon.awssdk.services.redshiftdata.model

Interface ExecuteStatementRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>, RedshiftDataRequest.Builder, SdkBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ExecuteStatementRequest

public static interface ExecuteStatementRequest.Builder
extends RedshiftDataRequest.Builder, SdkPojo, CopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

Method Summary

Modifier and Type	Method and Description
ExecuteStatementRequest.Builder	clientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
ExecuteStatementRequest.Builder	clusterIdentifier(String clusterIdentifier) The cluster identifier.
ExecuteStatementRequest.Builder	database(String database) The name of the database.
ExecuteStatementRequest.Builder	dbUser(String dbUser) The database user name.
ExecuteStatementRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ExecuteStatementRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ExecuteStatementRequest.Builder	parameters(Collection<SqlParameter> parameters) The parameters for the SQL statement.
ExecuteStatementRequest.Builder	parameters(Consumer<SqlParameter.Builder>... parameters) The parameters for the SQL statement.
ExecuteStatementRequest.Builder	parameters(SqlParameter... parameters) The parameters for the SQL statement.
ExecuteStatementRequest.Builder	secretArn(String secretArn) The name or ARN of the secret that enables access to the database.
ExecuteStatementRequest.Builder	sql(String sql) The SQL statement text to run.
ExecuteStatementRequest.Builder	statementName(String statementName) The name of the SQL statement.
ExecuteStatementRequest.Builder	withEvent(Boolean withEvent) A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
ExecuteStatementRequest.Builder	workgroupName(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).

Methods inherited from interface software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, 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

clientToken

ExecuteStatementRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

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

clusterIdentifier

ExecuteStatementRequest.Builder clusterIdentifier(String clusterIdentifier)

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Parameters:

clusterIdentifier - The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Returns:

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

database

ExecuteStatementRequest.Builder database(String database)

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Parameters:

database - The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Returns:

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

dbUser

ExecuteStatementRequest.Builder dbUser(String dbUser)

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Parameters:

dbUser - The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Returns:

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

parameters

ExecuteStatementRequest.Builder parameters(Collection<SqlParameter> parameters)

The parameters for the SQL statement.

Parameters:

parameters - The parameters for the SQL statement.

Returns:

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

parameters

ExecuteStatementRequest.Builder parameters(SqlParameter... parameters)

The parameters for the SQL statement.

Parameters:

parameters - The parameters for the SQL statement.

Returns:

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

parameters

ExecuteStatementRequest.Builder parameters(Consumer<SqlParameter.Builder>... parameters)

The parameters for the SQL statement.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #parameters(List).

Parameters:

parameters - a consumer that will call methods on SqlParameter.Builder

Returns:

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

See Also:

#parameters(java.util.Collection)

secretArn

ExecuteStatementRequest.Builder secretArn(String secretArn)

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Parameters:

secretArn - The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Returns:

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

sql

ExecuteStatementRequest.Builder sql(String sql)

The SQL statement text to run.

Parameters:

sql - The SQL statement text to run.

Returns:

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

statementName

ExecuteStatementRequest.Builder statementName(String statementName)

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

Parameters:

statementName - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

Returns:

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

withEvent

ExecuteStatementRequest.Builder withEvent(Boolean withEvent)

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

Parameters:

withEvent - A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

Returns:

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

workgroupName

ExecuteStatementRequest.Builder workgroupName(String workgroupName)

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Parameters:

workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

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

overrideConfiguration

ExecuteStatementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder