ExecuteStatementRequest (AWS Java SDK :: Services

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.ExecuteStatementRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

@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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ExecuteStatementRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ExecuteStatementRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`RecordsFormatType`	`formatRecordsAs()` A value that indicates whether to format the result set as a single JSON string.
`String`	`formatRecordsAsAsString()` A value that indicates whether to format the result set as a single JSON string.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`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 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()`
`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.
    
    Returns:
    
    The SQL statement to run.
  - 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.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters 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.
  - parameters
```
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.
    
    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 hasParameters() method.
    
    Returns:
    
    The parameters for the SQL statement.
    
    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.
  - includeResultMetadata
```
public final Boolean includeResultMetadata()
```
    A value that indicates whether to include metadata in the results.
    
    Returns:
    
    A value that indicates whether to include metadata in the results.
  - continueAfterTimeout
```
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.
    
    Returns:
    
    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.
  - resultSetOptions
```
public final ResultSetOptions resultSetOptions()
```
    Options that control how the result set is returned.
    
    Returns:
    
    Options that control how the result set is returned.
  - formatRecordsAs
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, formatRecordsAs will return RecordsFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatRecordsAsAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    RecordsFormatType
  - formatRecordsAsAsString
```
public final String formatRecordsAsAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, formatRecordsAs will return RecordsFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatRecordsAsAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    RecordsFormatType
  - toBuilder
```
public ExecuteStatementRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
    
    Specified by:
    
    toBuilder in class RdsDataRequest
  - builder
```
public static ExecuteStatementRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ExecuteStatementRequest.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

Class ExecuteStatementRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

resourceArn

secretArn

sql

database

schema

hasParameters

parameters

transactionId

includeResultMetadata

continueAfterTimeout

resultSetOptions

formatRecordsAs

formatRecordsAsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields