Class BatchExecuteStatementRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<BatchExecuteStatementRequest.Builder,
BatchExecuteStatementRequest>
The request parameters represent the input of a SQL statement over an array of data.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
database()
The name of the database.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ParameterSets property.final List
<List<SqlParameter>> The parameter set for the batch operation.final String
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.final String
schema()
The name of the database schema.final String
The ARN of the secret that enables access to the DB cluster.static Class
<? extends BatchExecuteStatementRequest.Builder> final String
sql()
The SQL statement to run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The identifier of a transaction that was started by using theBeginTransaction
operation.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
The name of the database.
- Returns:
- The name of the database.
-
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 theisEmpty()
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
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 theBatchExecuteStatement
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 theBatchExecuteStatement
operation.
Array parameters are not supported.
-
-
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BatchExecuteStatementRequest.Builder,
BatchExecuteStatementRequest> - Specified by:
toBuilder
in classRdsDataRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-