com.amazonaws.services.rdsdata.model

Class BatchExecuteStatementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rdsdata.model.BatchExecuteStatementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchExecuteStatementRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The request parameters represent the input of a SQL statement over an array of data.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchExecuteStatementRequest()

Method Summary

Modifier and Type	Method and Description
BatchExecuteStatementRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDatabase() The name of the database.
List<List<SqlParameter>>	getParameterSets() The parameter set for the batch operation.
String	getResourceArn() The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
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()
void	setDatabase(String database) The name of the database.
void	setParameterSets(Collection<List<SqlParameter>> parameterSets) The parameter set for the batch operation.
void	setResourceArn(String resourceArn) The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
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.
BatchExecuteStatementRequest	withDatabase(String database) The name of the database.
BatchExecuteStatementRequest	withParameterSets(Collection<List<SqlParameter>> parameterSets) The parameter set for the batch operation.
BatchExecuteStatementRequest	withParameterSets(List<SqlParameter>... parameterSets) The parameter set for the batch operation.
BatchExecuteStatementRequest	withResourceArn(String resourceArn) The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
BatchExecuteStatementRequest	withSchema(String schema) The name of the database schema.
BatchExecuteStatementRequest	withSecretArn(String secretArn) The ARN of the secret that enables access to the DB cluster.
BatchExecuteStatementRequest	withSql(String sql) The SQL statement to run.
BatchExecuteStatementRequest	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

BatchExecuteStatementRequest

public BatchExecuteStatementRequest()

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 BatchExecuteStatementRequest 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 BatchExecuteStatementRequest 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. Don't include a semicolon (;) at the end of the SQL statement.

Parameters:

sql - The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

getSql

public String getSql()

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.

withSql

public BatchExecuteStatementRequest withSql(String sql)

The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

Parameters:

sql - The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

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

getParameterSets

public List<List<SqlParameter>> getParameterSets()

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 the BatchExecuteStatement operation.

Array parameters are not supported.

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 the BatchExecuteStatement operation.

Array parameters are not supported.

setParameterSets

public void setParameterSets(Collection<List<SqlParameter>> 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 the BatchExecuteStatement operation.

Array parameters are not supported.

Parameters:

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 the BatchExecuteStatement operation.

Array parameters are not supported.

withParameterSets

public BatchExecuteStatementRequest withParameterSets(List<SqlParameter>... 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 the BatchExecuteStatement operation.

Array parameters are not supported.

NOTE: This method appends the values to the existing list (if any). Use setParameterSets(java.util.Collection) or withParameterSets(java.util.Collection) if you want to override the existing values.

Parameters:

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 the BatchExecuteStatement operation.

Array parameters are not supported.

Returns:

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

withParameterSets

public BatchExecuteStatementRequest withParameterSets(Collection<List<SqlParameter>> 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 the BatchExecuteStatement operation.

Array parameters are not supported.

Parameters:

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 the BatchExecuteStatement operation.

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

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 BatchExecuteStatementRequest 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()