software.amazon.awssdk.services.rdsdata.model

Interface ExecuteStatementRequest.Builder

All Superinterfaces:

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

Enclosing class:

ExecuteStatementRequest

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

Method Summary

Modifier and Type	Method and Description
ExecuteStatementRequest.Builder	continueAfterTimeout(Boolean continueAfterTimeout) A value that indicates whether to continue running the statement after the call times out.
ExecuteStatementRequest.Builder	database(String database) The name of the database.
ExecuteStatementRequest.Builder	formatRecordsAs(RecordsFormatType formatRecordsAs) A value that indicates whether to format the result set as a single JSON string.
ExecuteStatementRequest.Builder	formatRecordsAs(String formatRecordsAs) A value that indicates whether to format the result set as a single JSON string.
ExecuteStatementRequest.Builder	includeResultMetadata(Boolean includeResultMetadata) A value that indicates whether to include metadata in the results.
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	resourceArn(String resourceArn) The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
default ExecuteStatementRequest.Builder	resultSetOptions(Consumer<ResultSetOptions.Builder> resultSetOptions) Options that control how the result set is returned.
ExecuteStatementRequest.Builder	resultSetOptions(ResultSetOptions resultSetOptions) Options that control how the result set is returned.
ExecuteStatementRequest.Builder	schema(String schema) The name of the database schema.
ExecuteStatementRequest.Builder	secretArn(String secretArn) The ARN of the secret that enables access to the DB cluster.
ExecuteStatementRequest.Builder	sql(String sql) The SQL statement to run.
ExecuteStatementRequest.Builder	transactionId(String transactionId) The identifier of a transaction that was started by using the BeginTransaction operation.

Methods inherited from interface software.amazon.awssdk.services.rdsdata.model.RdsDataRequest.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

resourceArn

ExecuteStatementRequest.Builder resourceArn(String resourceArn)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Parameters:

resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Returns:

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

secretArn

ExecuteStatementRequest.Builder secretArn(String secretArn)

The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

For information about creating the secret, see Create a database secret.

Parameters:

secretArn - The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

For information about creating the secret, see Create a database secret.

Returns:

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

sql

ExecuteStatementRequest.Builder sql(String sql)

The SQL statement to run.

Parameters:

sql - The SQL statement to run.

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.

Parameters:

database - The name of the database.

Returns:

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

schema

ExecuteStatementRequest.Builder schema(String schema)

The name of the database schema.

Currently, the schema parameter isn't supported.

Parameters:

schema - The name of the database schema.

Currently, the schema parameter isn't supported.

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.

Array parameters are not supported.

Parameters:

parameters - The parameters for the SQL statement.

Array parameters are not supported.

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.

Array parameters are not supported.

Parameters:

parameters - The parameters for the SQL statement.

Array parameters are not supported.

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.

Array parameters are not supported.

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)

transactionId

ExecuteStatementRequest.Builder transactionId(String transactionId)

The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

Parameters:

transactionId - The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

Returns:

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

includeResultMetadata

ExecuteStatementRequest.Builder includeResultMetadata(Boolean includeResultMetadata)

A value that indicates whether to include metadata in the results.

Parameters:

includeResultMetadata - A value that indicates whether to include metadata in the results.

Returns:

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

continueAfterTimeout

ExecuteStatementRequest.Builder continueAfterTimeout(Boolean continueAfterTimeout)

A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

Parameters:

continueAfterTimeout - A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

Returns:

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

resultSetOptions

ExecuteStatementRequest.Builder resultSetOptions(ResultSetOptions resultSetOptions)

Options that control how the result set is returned.

Parameters:

resultSetOptions - Options that control how the result set is returned.

Returns:

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

resultSetOptions

default ExecuteStatementRequest.Builder resultSetOptions(Consumer<ResultSetOptions.Builder> resultSetOptions)

Options that control how the result set is returned.

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

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

Parameters:

resultSetOptions - a consumer that will call methods on ResultSetOptions.Builder

Returns:

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

See Also:

resultSetOptions(ResultSetOptions)

formatRecordsAs

ExecuteStatementRequest.Builder formatRecordsAs(String formatRecordsAs)

A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

Parameters:

formatRecordsAs - A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

Returns:

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

See Also:

RecordsFormatType, RecordsFormatType

formatRecordsAs

ExecuteStatementRequest.Builder formatRecordsAs(RecordsFormatType formatRecordsAs)

A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

Parameters:

formatRecordsAs - A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

Returns:

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

See Also:

RecordsFormatType, RecordsFormatType

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