@Generated(value="software.amazon.awssdk:codegen") public final class ExecuteStatementRequest extends RdsDataRequest implements ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
The request parameters represent the input of a request to run a SQL statement against a database.
Modifier and Type | Class and Description |
---|---|
static interface |
ExecuteStatementRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ExecuteStatementRequest.Builder |
builder() |
Boolean |
continueAfterTimeout()
A value that indicates whether to continue running the statement after the call times out.
|
String |
database()
The name of the database.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasParameters()
Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
Boolean |
includeResultMetadata()
A value that indicates whether to include metadata in the results.
|
List<SqlParameter> |
parameters()
The parameters for the SQL statement.
|
String |
resourceArn()
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
ResultSetOptions |
resultSetOptions()
Options that control how the result set is returned.
|
String |
schema()
The name of the database schema.
|
List<SdkField<?>> |
sdkFields() |
String |
secretArn()
The name or ARN of the secret that enables access to the DB cluster.
|
static Class<? extends ExecuteStatementRequest.Builder> |
serializableBuilderClass() |
String |
sql()
The SQL statement to run.
|
ExecuteStatementRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
transactionId()
The identifier of a transaction that was started by using the
BeginTransaction operation. |
overrideConfiguration
copy
public final 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.
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.
public final String database()
The name of the database.
public final Boolean includeResultMetadata()
A value that indicates whether to include metadata in the results.
public final boolean hasParameters()
public final List<SqlParameter> parameters()
The parameters for the SQL statement.
Array parameters are not supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasParameters()
to see if a value was sent in this field.
Array parameters are not supported.
public final String resourceArn()
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
public final ResultSetOptions resultSetOptions()
Options that control how the result set is returned.
public final String schema()
The name of the database schema.
public final String secretArn()
The name or ARN of the secret that enables access to the DB cluster.
public final String sql()
The SQL statement to run.
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.
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.
public ExecuteStatementRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
toBuilder
in class RdsDataRequest
public static ExecuteStatementRequest.Builder builder()
public static Class<? extends ExecuteStatementRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.