com.amazonaws.services.rdsdata

Class AWSRDSDataAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.rdsdata.AWSRDSDataClient

com.amazonaws.services.rdsdata.AWSRDSDataAsyncClient

All Implemented Interfaces:

AWSRDSData, AWSRDSDataAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSRDSDataAsyncClient
extends AWSRDSDataClient
implements AWSRDSDataAsync

Client for accessing AWS RDS DataService asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon RDS Data Service

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.

For more information about the Data Service API, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

If you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com.

Field Summary

Fields inherited from class com.amazonaws.services.rdsdata.AWSRDSDataClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.rdsdata.AWSRDSData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSRDSDataAsyncClientBuilder	asyncBuilder()
Future<BatchExecuteStatementResult>	batchExecuteStatementAsync(BatchExecuteStatementRequest request) Runs a batch SQL statement over an array of data.
Future<BatchExecuteStatementResult>	batchExecuteStatementAsync(BatchExecuteStatementRequest request, AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler) Runs a batch SQL statement over an array of data.
Future<BeginTransactionResult>	beginTransactionAsync(BeginTransactionRequest request) Starts a SQL transaction.
Future<BeginTransactionResult>	beginTransactionAsync(BeginTransactionRequest request, AsyncHandler<BeginTransactionRequest,BeginTransactionResult> asyncHandler) Starts a SQL transaction.
Future<CommitTransactionResult>	commitTransactionAsync(CommitTransactionRequest request) Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
Future<CommitTransactionResult>	commitTransactionAsync(CommitTransactionRequest request, AsyncHandler<CommitTransactionRequest,CommitTransactionResult> asyncHandler) Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
Future<ExecuteSqlResult>	executeSqlAsync(ExecuteSqlRequest request) Deprecated.
Future<ExecuteSqlResult>	executeSqlAsync(ExecuteSqlRequest request, AsyncHandler<ExecuteSqlRequest,ExecuteSqlResult> asyncHandler) Deprecated.
Future<ExecuteStatementResult>	executeStatementAsync(ExecuteStatementRequest request) Runs a SQL statement against a database.
Future<ExecuteStatementResult>	executeStatementAsync(ExecuteStatementRequest request, AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler) Runs a SQL statement against a database.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<RollbackTransactionResult>	rollbackTransactionAsync(RollbackTransactionRequest request) Performs a rollback of a transaction.
Future<RollbackTransactionResult>	rollbackTransactionAsync(RollbackTransactionRequest request, AsyncHandler<RollbackTransactionRequest,RollbackTransactionResult> asyncHandler) Performs a rollback of a transaction.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.rdsdata.AWSRDSDataClient

batchExecuteStatement, beginTransaction, builder, commitTransaction, executeSql, executeStatement, getCachedResponseMetadata, rollbackTransaction

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.rdsdata.AWSRDSData

batchExecuteStatement, beginTransaction, commitTransaction, executeSql, executeStatement, getCachedResponseMetadata, rollbackTransaction

Method Detail

asyncBuilder

public static AWSRDSDataAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchExecuteStatementAsync

public Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest request)

Description copied from interface: AWSRDSDataAsync

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

Specified by:

batchExecuteStatementAsync in interface AWSRDSDataAsync

Parameters:

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

Returns:

A Java Future containing the result of the BatchExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

batchExecuteStatementAsync

public Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest request,
                                                                      AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler)

Description copied from interface: AWSRDSDataAsync

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

Specified by:

batchExecuteStatementAsync in interface AWSRDSDataAsync

Parameters:

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

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

beginTransactionAsync

public Future<BeginTransactionResult> beginTransactionAsync(BeginTransactionRequest request)

Description copied from interface: AWSRDSDataAsync

Starts a SQL transaction.

  <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important> 
 

Specified by:

beginTransactionAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to start a SQL transaction.

Returns:

A Java Future containing the result of the BeginTransaction operation returned by the service.

See Also:

AWS API Documentation

beginTransactionAsync

public Future<BeginTransactionResult> beginTransactionAsync(BeginTransactionRequest request,
                                                            AsyncHandler<BeginTransactionRequest,BeginTransactionResult> asyncHandler)

Description copied from interface: AWSRDSDataAsync

Starts a SQL transaction.

  <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important> 
 

Specified by:

beginTransactionAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to start a SQL transaction.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BeginTransaction operation returned by the service.

See Also:

AWS API Documentation

commitTransactionAsync

public Future<CommitTransactionResult> commitTransactionAsync(CommitTransactionRequest request)

Description copied from interface: AWSRDSDataAsync

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

Specified by:

commitTransactionAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a commit transaction request.

Returns:

A Java Future containing the result of the CommitTransaction operation returned by the service.

See Also:

AWS API Documentation

commitTransactionAsync

public Future<CommitTransactionResult> commitTransactionAsync(CommitTransactionRequest request,
                                                              AsyncHandler<CommitTransactionRequest,CommitTransactionResult> asyncHandler)

Description copied from interface: AWSRDSDataAsync

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

Specified by:

commitTransactionAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a commit transaction request.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CommitTransaction operation returned by the service.

See Also:

AWS API Documentation

executeSqlAsync

@Deprecated
public Future<ExecuteSqlResult> executeSqlAsync(ExecuteSqlRequest request)

Deprecated.

Description copied from interface: AWSRDSDataAsync

Runs one or more SQL statements.

This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

Specified by:

executeSqlAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to run one or more SQL statements.

Returns:

A Java Future containing the result of the ExecuteSql operation returned by the service.

See Also:

AWS API Documentation

executeSqlAsync

@Deprecated
public Future<ExecuteSqlResult> executeSqlAsync(ExecuteSqlRequest request,
                                                            AsyncHandler<ExecuteSqlRequest,ExecuteSqlResult> asyncHandler)

Deprecated.

Description copied from interface: AWSRDSDataAsync

Runs one or more SQL statements.

This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

Specified by:

executeSqlAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to run one or more SQL statements.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ExecuteSql operation returned by the service.

See Also:

AWS API Documentation

executeStatementAsync

public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request)

Description copied from interface: AWSRDSDataAsync

Runs a SQL statement against a database.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

Specified by:

executeStatementAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to run a SQL statement against a database.

Returns:

A Java Future containing the result of the ExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

executeStatementAsync

public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request,
                                                            AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler)

Description copied from interface: AWSRDSDataAsync

Runs a SQL statement against a database.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

Specified by:

executeStatementAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to run a SQL statement against a database.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

rollbackTransactionAsync

public Future<RollbackTransactionResult> rollbackTransactionAsync(RollbackTransactionRequest request)

Description copied from interface: AWSRDSDataAsync

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Specified by:

rollbackTransactionAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to perform a rollback of a transaction.

Returns:

A Java Future containing the result of the RollbackTransaction operation returned by the service.

See Also:

AWS API Documentation

rollbackTransactionAsync

public Future<RollbackTransactionResult> rollbackTransactionAsync(RollbackTransactionRequest request,
                                                                  AsyncHandler<RollbackTransactionRequest,RollbackTransactionResult> asyncHandler)

Description copied from interface: AWSRDSDataAsync

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Specified by:

rollbackTransactionAsync in interface AWSRDSDataAsync

Parameters:

request - The request parameters represent the input of a request to perform a rollback of a transaction.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RollbackTransaction operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSRDSData

Overrides:

shutdown in class AmazonWebServiceClient