com.amazonaws.services.rdsdata.model

Class ExecuteStatementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rdsdata.model.ExecuteStatementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ExecuteStatementRequest()

Method Summary

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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecuteStatementRequest

public ExecuteStatementRequest()

Method Detail

setResourceArn

public void setResourceArn(String resourceArn)

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

Parameters:

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

getResourceArn

public String getResourceArn()

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

Returns:

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

withResourceArn

public ExecuteStatementRequest withResourceArn(String resourceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecretArn

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.

Parameters:

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.

getSecretArn

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.

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.

withSecretArn

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSql

public void setSql(String sql)

The SQL statement to run.

Parameters:

sql - The SQL statement to run.

getSql

public String getSql()

The SQL statement to run.

Returns:

The SQL statement to run.

withSql

public ExecuteStatementRequest withSql(String sql)

The SQL statement to run.

Parameters:

sql - The SQL statement to run.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatabase

public void setDatabase(String database)

The name of the database.

Parameters:

database - The name of the database.

getDatabase

public String getDatabase()

The name of the database.

Returns:

The name of the database.

withDatabase

public ExecuteStatementRequest withDatabase(String database)

The name of the database.

Parameters:

database - The name of the database.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSchema

public void setSchema(String schema)

The name of the database schema.

Currently, the schema parameter isn't supported.

Parameters:

schema - The name of the database schema.

Currently, the schema parameter isn't supported.

getSchema

public String getSchema()

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.

withSchema

public ExecuteStatementRequest withSchema(String schema)

The name of the database schema.

Currently, the schema parameter isn't supported.

Parameters:

schema - The name of the database schema.

Currently, the schema parameter isn't supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

getParameters

public List<SqlParameter> getParameters()

The parameters for the SQL statement.

Array parameters are not supported.

Returns:

The parameters for the SQL statement.

Array parameters are not supported.

setParameters

public void setParameters(Collection<SqlParameter> parameters)

The parameters for the SQL statement.

Array parameters are not supported.

Parameters:

parameters - The parameters for the SQL statement.

Array parameters are not supported.

withParameters

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:

parameters - The parameters for the SQL statement.

Array parameters are not supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

withParameters

public ExecuteStatementRequest withParameters(Collection<SqlParameter> parameters)

The parameters for the SQL statement.

Array parameters are not supported.

Parameters:

parameters - The parameters for the SQL statement.

Array parameters are not supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransactionId

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.

Parameters:

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.

getTransactionId

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.

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.

withTransactionId

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setIncludeResultMetadata

public void setIncludeResultMetadata(Boolean includeResultMetadata)

A value that indicates whether to include metadata in the results.

Parameters:

includeResultMetadata - A value that indicates whether to include metadata in the results.

getIncludeResultMetadata

public Boolean getIncludeResultMetadata()

A value that indicates whether to include metadata in the results.

Returns:

A value that indicates whether to include metadata in the results.

withIncludeResultMetadata

public ExecuteStatementRequest withIncludeResultMetadata(Boolean includeResultMetadata)

A value that indicates whether to include metadata in the results.

Parameters:

includeResultMetadata - A value that indicates whether to include metadata in the results.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeResultMetadata

public Boolean isIncludeResultMetadata()

A value that indicates whether to include metadata in the results.

Returns:

A value that indicates whether to include metadata in the results.

setContinueAfterTimeout

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.

Parameters:

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.

getContinueAfterTimeout

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.

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.

withContinueAfterTimeout

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isContinueAfterTimeout

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.

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.

setResultSetOptions

public void setResultSetOptions(ResultSetOptions resultSetOptions)

Options that control how the result set is returned.

Parameters:

resultSetOptions - Options that control how the result set is returned.

getResultSetOptions

public ResultSetOptions getResultSetOptions()

Options that control how the result set is returned.

Returns:

Options that control how the result set is returned.

withResultSetOptions

public ExecuteStatementRequest withResultSetOptions(ResultSetOptions resultSetOptions)

Options that control how the result set is returned.

Parameters:

resultSetOptions - Options that control how the result set is returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFormatRecordsAs

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.

Parameters:

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.

See Also:

RecordsFormatType

getFormatRecordsAs

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.

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

withFormatRecordsAs

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RecordsFormatType

withFormatRecordsAs

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RecordsFormatType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ExecuteStatementRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()