com.amazonaws.services.docdbelastic

Class AmazonDocDBElasticAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.docdbelastic.AmazonDocDBElasticClient

com.amazonaws.services.docdbelastic.AmazonDocDBElasticAsyncClient

All Implemented Interfaces:

AmazonDocDBElastic, AmazonDocDBElasticAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDocDBElasticAsyncClient
extends AmazonDocDBElasticClient
implements AmazonDocDBElasticAsync

Client for accessing DocDB Elastic 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.

The new Amazon Elastic DocumentDB service endpoint.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.docdbelastic.AmazonDocDBElastic

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonDocDBElasticAsyncClientBuilder	asyncBuilder()
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest request) Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler) Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
Future<CreateClusterSnapshotResult>	createClusterSnapshotAsync(CreateClusterSnapshotRequest request) Creates a snapshot of a cluster.
Future<CreateClusterSnapshotResult>	createClusterSnapshotAsync(CreateClusterSnapshotRequest request, AsyncHandler<CreateClusterSnapshotRequest,CreateClusterSnapshotResult> asyncHandler) Creates a snapshot of a cluster.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest request) Delete a Elastic DocumentDB cluster.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler) Delete a Elastic DocumentDB cluster.
Future<DeleteClusterSnapshotResult>	deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest request) Delete a Elastic DocumentDB snapshot.
Future<DeleteClusterSnapshotResult>	deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest request, AsyncHandler<DeleteClusterSnapshotRequest,DeleteClusterSnapshotResult> asyncHandler) Delete a Elastic DocumentDB snapshot.
Future<GetClusterResult>	getClusterAsync(GetClusterRequest request) Returns information about a specific Elastic DocumentDB cluster.
Future<GetClusterResult>	getClusterAsync(GetClusterRequest request, AsyncHandler<GetClusterRequest,GetClusterResult> asyncHandler) Returns information about a specific Elastic DocumentDB cluster.
Future<GetClusterSnapshotResult>	getClusterSnapshotAsync(GetClusterSnapshotRequest request) Returns information about a specific Elastic DocumentDB snapshot
Future<GetClusterSnapshotResult>	getClusterSnapshotAsync(GetClusterSnapshotRequest request, AsyncHandler<GetClusterSnapshotRequest,GetClusterSnapshotResult> asyncHandler) Returns information about a specific Elastic DocumentDB snapshot
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest request) Returns information about provisioned Elastic DocumentDB clusters.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler) Returns information about provisioned Elastic DocumentDB clusters.
Future<ListClusterSnapshotsResult>	listClusterSnapshotsAsync(ListClusterSnapshotsRequest request) Returns information about Elastic DocumentDB snapshots for a specified cluster.
Future<ListClusterSnapshotsResult>	listClusterSnapshotsAsync(ListClusterSnapshotsRequest request, AsyncHandler<ListClusterSnapshotsRequest,ListClusterSnapshotsResult> asyncHandler) Returns information about Elastic DocumentDB snapshots for a specified cluster.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Lists all tags on a Elastic DocumentDB resource
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists all tags on a Elastic DocumentDB resource
Future<RestoreClusterFromSnapshotResult>	restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest request) Restores a Elastic DocumentDB cluster from a snapshot.
Future<RestoreClusterFromSnapshotResult>	restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest request, AsyncHandler<RestoreClusterFromSnapshotRequest,RestoreClusterFromSnapshotResult> asyncHandler) Restores a Elastic DocumentDB cluster from a snapshot.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Adds metadata tags to a Elastic DocumentDB resource
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds metadata tags to a Elastic DocumentDB resource
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes metadata tags to a Elastic DocumentDB resource
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes metadata tags to a Elastic DocumentDB resource
Future<UpdateClusterResult>	updateClusterAsync(UpdateClusterRequest request) Modifies a Elastic DocumentDB cluster.
Future<UpdateClusterResult>	updateClusterAsync(UpdateClusterRequest request, AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler) Modifies a Elastic DocumentDB cluster.

Methods inherited from class com.amazonaws.services.docdbelastic.AmazonDocDBElasticClient

builder, createCluster, createClusterSnapshot, deleteCluster, deleteClusterSnapshot, getCachedResponseMetadata, getCluster, getClusterSnapshot, listClusters, listClusterSnapshots, listTagsForResource, restoreClusterFromSnapshot, tagResource, untagResource, updateCluster

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.docdbelastic.AmazonDocDBElastic

createCluster, createClusterSnapshot, deleteCluster, deleteClusterSnapshot, getCachedResponseMetadata, getCluster, getClusterSnapshot, listClusters, listClusterSnapshots, listTagsForResource, restoreClusterFromSnapshot, tagResource, untagResource, updateCluster

Method Detail

asyncBuilder

public static AmazonDocDBElasticAsyncClientBuilder 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.

createClusterAsync

public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

Specified by:

createClusterAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

createClusterAsync

public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request,
                                                      AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

Specified by:

createClusterAsync in interface AmazonDocDBElasticAsync

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 CreateCluster operation returned by the service.

See Also:

AWS API Documentation

createClusterSnapshotAsync

public Future<CreateClusterSnapshotResult> createClusterSnapshotAsync(CreateClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Creates a snapshot of a cluster.

Specified by:

createClusterSnapshotAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

createClusterSnapshotAsync

public Future<CreateClusterSnapshotResult> createClusterSnapshotAsync(CreateClusterSnapshotRequest request,
                                                                      AsyncHandler<CreateClusterSnapshotRequest,CreateClusterSnapshotResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Creates a snapshot of a cluster.

Specified by:

createClusterSnapshotAsync in interface AmazonDocDBElasticAsync

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 CreateClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

deleteClusterAsync

public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Delete a Elastic DocumentDB cluster.

Specified by:

deleteClusterAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

deleteClusterAsync

public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request,
                                                      AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Delete a Elastic DocumentDB cluster.

Specified by:

deleteClusterAsync in interface AmazonDocDBElasticAsync

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 DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterSnapshotAsync

public Future<DeleteClusterSnapshotResult> deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Delete a Elastic DocumentDB snapshot.

Specified by:

deleteClusterSnapshotAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

deleteClusterSnapshotAsync

public Future<DeleteClusterSnapshotResult> deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest request,
                                                                      AsyncHandler<DeleteClusterSnapshotRequest,DeleteClusterSnapshotResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Delete a Elastic DocumentDB snapshot.

Specified by:

deleteClusterSnapshotAsync in interface AmazonDocDBElasticAsync

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 DeleteClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

getClusterAsync

public Future<GetClusterResult> getClusterAsync(GetClusterRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about a specific Elastic DocumentDB cluster.

Specified by:

getClusterAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

getClusterAsync

public Future<GetClusterResult> getClusterAsync(GetClusterRequest request,
                                                AsyncHandler<GetClusterRequest,GetClusterResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about a specific Elastic DocumentDB cluster.

Specified by:

getClusterAsync in interface AmazonDocDBElasticAsync

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 GetCluster operation returned by the service.

See Also:

AWS API Documentation

getClusterSnapshotAsync

public Future<GetClusterSnapshotResult> getClusterSnapshotAsync(GetClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about a specific Elastic DocumentDB snapshot

Specified by:

getClusterSnapshotAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

getClusterSnapshotAsync

public Future<GetClusterSnapshotResult> getClusterSnapshotAsync(GetClusterSnapshotRequest request,
                                                                AsyncHandler<GetClusterSnapshotRequest,GetClusterSnapshotResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about a specific Elastic DocumentDB snapshot

Specified by:

getClusterSnapshotAsync in interface AmazonDocDBElasticAsync

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 GetClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

listClusterSnapshotsAsync

public Future<ListClusterSnapshotsResult> listClusterSnapshotsAsync(ListClusterSnapshotsRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about Elastic DocumentDB snapshots for a specified cluster.

Specified by:

listClusterSnapshotsAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

listClusterSnapshotsAsync

public Future<ListClusterSnapshotsResult> listClusterSnapshotsAsync(ListClusterSnapshotsRequest request,
                                                                    AsyncHandler<ListClusterSnapshotsRequest,ListClusterSnapshotsResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about Elastic DocumentDB snapshots for a specified cluster.

Specified by:

listClusterSnapshotsAsync in interface AmazonDocDBElasticAsync

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 ListClusterSnapshots operation returned by the service.

See Also:

AWS API Documentation

listClustersAsync

public Future<ListClustersResult> listClustersAsync(ListClustersRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about provisioned Elastic DocumentDB clusters.

Specified by:

listClustersAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

listClustersAsync

public Future<ListClustersResult> listClustersAsync(ListClustersRequest request,
                                                    AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Returns information about provisioned Elastic DocumentDB clusters.

Specified by:

listClustersAsync in interface AmazonDocDBElasticAsync

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 ListClusters operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Lists all tags on a Elastic DocumentDB resource

Specified by:

listTagsForResourceAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Lists all tags on a Elastic DocumentDB resource

Specified by:

listTagsForResourceAsync in interface AmazonDocDBElasticAsync

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 ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

restoreClusterFromSnapshotAsync

public Future<RestoreClusterFromSnapshotResult> restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Restores a Elastic DocumentDB cluster from a snapshot.

Specified by:

restoreClusterFromSnapshotAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

restoreClusterFromSnapshotAsync

public Future<RestoreClusterFromSnapshotResult> restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest request,
                                                                                AsyncHandler<RestoreClusterFromSnapshotRequest,RestoreClusterFromSnapshotResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Restores a Elastic DocumentDB cluster from a snapshot.

Specified by:

restoreClusterFromSnapshotAsync in interface AmazonDocDBElasticAsync

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 RestoreClusterFromSnapshot operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Adds metadata tags to a Elastic DocumentDB resource

Specified by:

tagResourceAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Adds metadata tags to a Elastic DocumentDB resource

Specified by:

tagResourceAsync in interface AmazonDocDBElasticAsync

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 TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Removes metadata tags to a Elastic DocumentDB resource

Specified by:

untagResourceAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Removes metadata tags to a Elastic DocumentDB resource

Specified by:

untagResourceAsync in interface AmazonDocDBElasticAsync

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 UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateClusterAsync

public Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest request)

Description copied from interface: AmazonDocDBElasticAsync

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

Specified by:

updateClusterAsync in interface AmazonDocDBElasticAsync

Returns:

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

See Also:

AWS API Documentation

updateClusterAsync

public Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest request,
                                                      AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler)

Description copied from interface: AmazonDocDBElasticAsync

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

Specified by:

updateClusterAsync in interface AmazonDocDBElasticAsync

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 UpdateCluster 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 AmazonDocDBElastic

Overrides:

shutdown in class AmazonDocDBElasticClient