@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ExecuteStatementRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The request parameters represent the input of a request to run a SQL statement against a database.
NOOP
Constructor and Description |
---|
ExecuteStatementRequest() |
Modifier and Type | Method and Description |
---|---|
ExecuteStatementRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getContinueAfterTimeout()
A value that indicates whether to continue running the statement after the call times out.
|
String |
getDatabase()
The name of the database.
|
String |
getFormatRecordsAs()
A value that indicates whether to format the result set as a single JSON string.
|
Boolean |
getIncludeResultMetadata()
A value that indicates whether to include metadata in the results.
|
List<SqlParameter> |
getParameters()
The parameters for the SQL statement.
|
String |
getResourceArn()
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
ResultSetOptions |
getResultSetOptions()
Options that control how the result set is returned.
|
String |
getSchema()
The name of the database schema.
|
String |
getSecretArn()
The ARN of the secret that enables access to the DB cluster.
|
String |
getSql()
The SQL statement to run.
|
String |
getTransactionId()
The identifier of a transaction that was started by using the
BeginTransaction operation. |
int |
hashCode() |
Boolean |
isContinueAfterTimeout()
A value that indicates whether to continue running the statement after the call times out.
|
Boolean |
isIncludeResultMetadata()
A value that indicates whether to include metadata in the results.
|
void |
setContinueAfterTimeout(Boolean continueAfterTimeout)
A value that indicates whether to continue running the statement after the call times out.
|
void |
setDatabase(String database)
The name of the database.
|
void |
setFormatRecordsAs(String formatRecordsAs)
A value that indicates whether to format the result set as a single JSON string.
|
void |
setIncludeResultMetadata(Boolean includeResultMetadata)
A value that indicates whether to include metadata in the results.
|
void |
setParameters(Collection<SqlParameter> parameters)
The parameters for the SQL statement.
|
void |
setResourceArn(String resourceArn)
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
void |
setResultSetOptions(ResultSetOptions resultSetOptions)
Options that control how the result set is returned.
|
void |
setSchema(String schema)
The name of the database schema.
|
void |
setSecretArn(String secretArn)
The ARN of the secret that enables access to the DB cluster.
|
void |
setSql(String sql)
The SQL statement to run.
|
void |
setTransactionId(String transactionId)
The identifier of a transaction that was started by using the
BeginTransaction operation. |
String |
toString()
Returns a string representation of this object.
|
ExecuteStatementRequest |
withContinueAfterTimeout(Boolean continueAfterTimeout)
A value that indicates whether to continue running the statement after the call times out.
|
ExecuteStatementRequest |
withDatabase(String database)
The name of the database.
|
ExecuteStatementRequest |
withFormatRecordsAs(RecordsFormatType formatRecordsAs)
A value that indicates whether to format the result set as a single JSON string.
|
ExecuteStatementRequest |
withFormatRecordsAs(String formatRecordsAs)
A value that indicates whether to format the result set as a single JSON string.
|
ExecuteStatementRequest |
withIncludeResultMetadata(Boolean includeResultMetadata)
A value that indicates whether to include metadata in the results.
|
ExecuteStatementRequest |
withParameters(Collection<SqlParameter> parameters)
The parameters for the SQL statement.
|
ExecuteStatementRequest |
withParameters(SqlParameter... parameters)
The parameters for the SQL statement.
|
ExecuteStatementRequest |
withResourceArn(String resourceArn)
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
ExecuteStatementRequest |
withResultSetOptions(ResultSetOptions resultSetOptions)
Options that control how the result set is returned.
|
ExecuteStatementRequest |
withSchema(String schema)
The name of the database schema.
|
ExecuteStatementRequest |
withSecretArn(String secretArn)
The ARN of the secret that enables access to the DB cluster.
|
ExecuteStatementRequest |
withSql(String sql)
The SQL statement to run.
|
ExecuteStatementRequest |
withTransactionId(String transactionId)
The identifier of a transaction that was started by using the
BeginTransaction operation. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setResourceArn(String resourceArn)
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
resourceArn
- The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.public String getResourceArn()
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
public ExecuteStatementRequest withResourceArn(String resourceArn)
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
resourceArn
- The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.public void setSecretArn(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.
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.
public String getSecretArn()
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.
For information about creating the secret, see Create a database secret.
public ExecuteStatementRequest withSecretArn(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.
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.
public void setSql(String sql)
The SQL statement to run.
sql
- The SQL statement to run.public String getSql()
The SQL statement to run.
public ExecuteStatementRequest withSql(String sql)
The SQL statement to run.
sql
- The SQL statement to run.public void setDatabase(String database)
The name of the database.
database
- The name of the database.public String getDatabase()
The name of the database.
public ExecuteStatementRequest withDatabase(String database)
The name of the database.
database
- The name of the database.public void setSchema(String schema)
The name of the database schema.
Currently, the schema
parameter isn't supported.
schema
- The name of the database schema.
Currently, the schema
parameter isn't supported.
public String getSchema()
The name of the database schema.
Currently, the schema
parameter isn't supported.
Currently, the schema
parameter isn't supported.
public ExecuteStatementRequest withSchema(String schema)
The name of the database schema.
Currently, the schema
parameter isn't supported.
schema
- The name of the database schema.
Currently, the schema
parameter isn't supported.
public List<SqlParameter> getParameters()
The parameters for the SQL statement.
Array parameters are not supported.
Array parameters are not supported.
public void setParameters(Collection<SqlParameter> parameters)
The parameters for the SQL statement.
Array parameters are not supported.
parameters
- The parameters for the SQL statement. Array parameters are not supported.
public ExecuteStatementRequest withParameters(SqlParameter... parameters)
The parameters for the SQL statement.
Array parameters are not supported.
NOTE: This method appends the values to the existing list (if any). Use
setParameters(java.util.Collection)
or withParameters(java.util.Collection)
if you want to
override the existing values.
parameters
- The parameters for the SQL statement. Array parameters are not supported.
public ExecuteStatementRequest withParameters(Collection<SqlParameter> parameters)
The parameters for the SQL statement.
Array parameters are not supported.
parameters
- The parameters for the SQL statement. Array parameters are not supported.
public void setTransactionId(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.
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.
public String getTransactionId()
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 withTransactionId(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.
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.
public void setIncludeResultMetadata(Boolean includeResultMetadata)
A value that indicates whether to include metadata in the results.
includeResultMetadata
- A value that indicates whether to include metadata in the results.public Boolean getIncludeResultMetadata()
A value that indicates whether to include metadata in the results.
public ExecuteStatementRequest withIncludeResultMetadata(Boolean includeResultMetadata)
A value that indicates whether to include metadata in the results.
includeResultMetadata
- A value that indicates whether to include metadata in the results.public Boolean isIncludeResultMetadata()
A value that indicates whether to include metadata in the results.
public void setContinueAfterTimeout(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.
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.
public Boolean getContinueAfterTimeout()
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 ExecuteStatementRequest withContinueAfterTimeout(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.
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.
public Boolean isContinueAfterTimeout()
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 void setResultSetOptions(ResultSetOptions resultSetOptions)
Options that control how the result set is returned.
resultSetOptions
- Options that control how the result set is returned.public ResultSetOptions getResultSetOptions()
Options that control how the result set is returned.
public ExecuteStatementRequest withResultSetOptions(ResultSetOptions resultSetOptions)
Options that control how the result set is returned.
resultSetOptions
- Options that control how the result set is returned.public void setFormatRecordsAs(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.
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.
RecordsFormatType
public String getFormatRecordsAs()
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.
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.
RecordsFormatType
public ExecuteStatementRequest withFormatRecordsAs(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.
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.
RecordsFormatType
public ExecuteStatementRequest withFormatRecordsAs(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.
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.
RecordsFormatType
public String toString()
toString
in class Object
Object.toString()
public ExecuteStatementRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()