com.amazonaws.services.ebs

Class AmazonEBSAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ebs.AmazonEBSClient

com.amazonaws.services.ebs.AmazonEBSAsyncClient

All Implemented Interfaces:

AmazonEBS, AmazonEBSAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonEBSAsyncClient
extends AmazonEBSClient
implements AmazonEBSAsync

Client for accessing Amazon EBS 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.

You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you're an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the AWS General Reference.

Field Summary

Fields inherited from class com.amazonaws.services.ebs.AmazonEBSClient

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.ebs.AmazonEBS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonEBSAsyncClientBuilder	asyncBuilder()
Future<CompleteSnapshotResult>	completeSnapshotAsync(CompleteSnapshotRequest request) Seals and completes the snapshot after all of the required blocks of data have been written to it.
Future<CompleteSnapshotResult>	completeSnapshotAsync(CompleteSnapshotRequest request, AsyncHandler<CompleteSnapshotRequest,CompleteSnapshotResult> asyncHandler) Seals and completes the snapshot after all of the required blocks of data have been written to it.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetSnapshotBlockResult>	getSnapshotBlockAsync(GetSnapshotBlockRequest request) Returns the data in a block in an Amazon Elastic Block Store snapshot.
Future<GetSnapshotBlockResult>	getSnapshotBlockAsync(GetSnapshotBlockRequest request, AsyncHandler<GetSnapshotBlockRequest,GetSnapshotBlockResult> asyncHandler) Returns the data in a block in an Amazon Elastic Block Store snapshot.
Future<ListChangedBlocksResult>	listChangedBlocksAsync(ListChangedBlocksRequest request) Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
Future<ListChangedBlocksResult>	listChangedBlocksAsync(ListChangedBlocksRequest request, AsyncHandler<ListChangedBlocksRequest,ListChangedBlocksResult> asyncHandler) Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
Future<ListSnapshotBlocksResult>	listSnapshotBlocksAsync(ListSnapshotBlocksRequest request) Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.
Future<ListSnapshotBlocksResult>	listSnapshotBlocksAsync(ListSnapshotBlocksRequest request, AsyncHandler<ListSnapshotBlocksRequest,ListSnapshotBlocksResult> asyncHandler) Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.
Future<PutSnapshotBlockResult>	putSnapshotBlockAsync(PutSnapshotBlockRequest request) Writes a block of data to a block in the snapshot.
Future<PutSnapshotBlockResult>	putSnapshotBlockAsync(PutSnapshotBlockRequest request, AsyncHandler<PutSnapshotBlockRequest,PutSnapshotBlockResult> asyncHandler) Writes a block of data to a block in the snapshot.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<StartSnapshotResult>	startSnapshotAsync(StartSnapshotRequest request) Creates a new Amazon EBS snapshot.
Future<StartSnapshotResult>	startSnapshotAsync(StartSnapshotRequest request, AsyncHandler<StartSnapshotRequest,StartSnapshotResult> asyncHandler) Creates a new Amazon EBS snapshot.

Methods inherited from class com.amazonaws.services.ebs.AmazonEBSClient

builder, completeSnapshot, getCachedResponseMetadata, getSnapshotBlock, listChangedBlocks, listSnapshotBlocks, putSnapshotBlock, startSnapshot

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.ebs.AmazonEBS

completeSnapshot, getCachedResponseMetadata, getSnapshotBlock, listChangedBlocks, listSnapshotBlocks, putSnapshotBlock, startSnapshot

Method Detail

asyncBuilder

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

completeSnapshotAsync

public Future<CompleteSnapshotResult> completeSnapshotAsync(CompleteSnapshotRequest request)

Description copied from interface: AmazonEBSAsync

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

Specified by:

completeSnapshotAsync in interface AmazonEBSAsync

Returns:

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

See Also:

AWS API Documentation

completeSnapshotAsync

public Future<CompleteSnapshotResult> completeSnapshotAsync(CompleteSnapshotRequest request,
                                                            AsyncHandler<CompleteSnapshotRequest,CompleteSnapshotResult> asyncHandler)

Description copied from interface: AmazonEBSAsync

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

Specified by:

completeSnapshotAsync in interface AmazonEBSAsync

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

See Also:

AWS API Documentation

getSnapshotBlockAsync

public Future<GetSnapshotBlockResult> getSnapshotBlockAsync(GetSnapshotBlockRequest request)

Description copied from interface: AmazonEBSAsync

Returns the data in a block in an Amazon Elastic Block Store snapshot.

Specified by:

getSnapshotBlockAsync in interface AmazonEBSAsync

Returns:

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

See Also:

AWS API Documentation

getSnapshotBlockAsync

public Future<GetSnapshotBlockResult> getSnapshotBlockAsync(GetSnapshotBlockRequest request,
                                                            AsyncHandler<GetSnapshotBlockRequest,GetSnapshotBlockResult> asyncHandler)

Description copied from interface: AmazonEBSAsync

Returns the data in a block in an Amazon Elastic Block Store snapshot.

Specified by:

getSnapshotBlockAsync in interface AmazonEBSAsync

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

See Also:

AWS API Documentation

listChangedBlocksAsync

public Future<ListChangedBlocksResult> listChangedBlocksAsync(ListChangedBlocksRequest request)

Description copied from interface: AmazonEBSAsync

Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

Specified by:

listChangedBlocksAsync in interface AmazonEBSAsync

Returns:

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

See Also:

AWS API Documentation

listChangedBlocksAsync

public Future<ListChangedBlocksResult> listChangedBlocksAsync(ListChangedBlocksRequest request,
                                                              AsyncHandler<ListChangedBlocksRequest,ListChangedBlocksResult> asyncHandler)

Description copied from interface: AmazonEBSAsync

Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

Specified by:

listChangedBlocksAsync in interface AmazonEBSAsync

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

See Also:

AWS API Documentation

listSnapshotBlocksAsync

public Future<ListSnapshotBlocksResult> listSnapshotBlocksAsync(ListSnapshotBlocksRequest request)

Description copied from interface: AmazonEBSAsync

Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

Specified by:

listSnapshotBlocksAsync in interface AmazonEBSAsync

Returns:

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

See Also:

AWS API Documentation

listSnapshotBlocksAsync

public Future<ListSnapshotBlocksResult> listSnapshotBlocksAsync(ListSnapshotBlocksRequest request,
                                                                AsyncHandler<ListSnapshotBlocksRequest,ListSnapshotBlocksResult> asyncHandler)

Description copied from interface: AmazonEBSAsync

Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

Specified by:

listSnapshotBlocksAsync in interface AmazonEBSAsync

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

See Also:

AWS API Documentation

putSnapshotBlockAsync

public Future<PutSnapshotBlockResult> putSnapshotBlockAsync(PutSnapshotBlockRequest request)

Description copied from interface: AmazonEBSAsync

Writes a block of data to a block in the snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-byte sectors.

Specified by:

putSnapshotBlockAsync in interface AmazonEBSAsync

Returns:

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

See Also:

AWS API Documentation

putSnapshotBlockAsync

public Future<PutSnapshotBlockResult> putSnapshotBlockAsync(PutSnapshotBlockRequest request,
                                                            AsyncHandler<PutSnapshotBlockRequest,PutSnapshotBlockResult> asyncHandler)

Description copied from interface: AmazonEBSAsync

Writes a block of data to a block in the snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-byte sectors.

Specified by:

putSnapshotBlockAsync in interface AmazonEBSAsync

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

See Also:

AWS API Documentation

startSnapshotAsync

public Future<StartSnapshotResult> startSnapshotAsync(StartSnapshotRequest request)

Description copied from interface: AmazonEBSAsync

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

Specified by:

startSnapshotAsync in interface AmazonEBSAsync

Returns:

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

See Also:

AWS API Documentation

startSnapshotAsync

public Future<StartSnapshotResult> startSnapshotAsync(StartSnapshotRequest request,
                                                      AsyncHandler<StartSnapshotRequest,StartSnapshotResult> asyncHandler)

Description copied from interface: AmazonEBSAsync

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

Specified by:

startSnapshotAsync in interface AmazonEBSAsync

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 StartSnapshot 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 AmazonEBS

Overrides:

shutdown in class AmazonWebServiceClient