software.amazon.awssdk.services.rdsdata.model

Class BatchExecuteStatementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rdsdata.model.RdsDataRequest

software.amazon.awssdk.services.rdsdata.model.BatchExecuteStatementRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchExecuteStatementRequest
extends RdsDataRequest
implements ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>

The request parameters represent the input of a SQL statement over an array of data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchExecuteStatementRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchExecuteStatementRequest.Builder	builder()
String	database() The name of the database.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameterSets() For responses, this returns true if the service returned a value for the ParameterSets property.
List<List<SqlParameter>>	parameterSets() The parameter set for the batch operation.
String	resourceArn() The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
String	schema() The name of the database schema.
List<SdkField<?>>	sdkFields()
String	secretArn() The ARN of the secret that enables access to the DB cluster.
static Class<? extends BatchExecuteStatementRequest.Builder>	serializableBuilderClass()
String	sql() The SQL statement to run.
BatchExecuteStatementRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	transactionId() The identifier of a transaction that was started by using the BeginTransaction operation.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

resourceArn

public final String resourceArn()

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

Returns:

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

secretArn

public final 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.

Returns:

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.

sql

public final String sql()

The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

Returns:

The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

database

public final String database()

The name of the database.

Returns:

The name of the database.

schema

public final String schema()

The name of the database schema.

Currently, the schema parameter isn't supported.

Returns:

The name of the database schema.

Currently, the schema parameter isn't supported.

hasParameterSets

public final boolean hasParameterSets()

For responses, this returns true if the service returned a value for the ParameterSets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

parameterSets

public final List<List<SqlParameter>> parameterSets()

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

• Specify one or more empty parameter sets.

• Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

Array parameters are not supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameterSets() method.

Returns:

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

• Specify one or more empty parameter sets.

• Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

Array parameters are not supported.

transactionId

public final 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.

Returns:

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.

toBuilder

public BatchExecuteStatementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchExecuteStatementRequest.Builder,BatchExecuteStatementRequest>

Specified by:

toBuilder in class RdsDataRequest

builder

public static BatchExecuteStatementRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchExecuteStatementRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo