com.amazonaws.services.recyclebin

Class AmazonRecycleBinAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.recyclebin.AmazonRecycleBinClient

com.amazonaws.services.recyclebin.AmazonRecycleBinAsyncClient

All Implemented Interfaces:

AmazonRecycleBin, AmazonRecycleBinAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonRecycleBinAsyncClient
extends AmazonRecycleBinClient
implements AmazonRecycleBinAsync

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

This is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.

Recycle Bin is a snapshot recovery feature that enables you to restore accidentally deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained in the Recycle Bin for a time period that you specify.

You can restore a snapshot from the Recycle Bin at any time before its retention period expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the Recycle Bin, and you can then use it in the same way you use any other snapshot in your account. If the retention period expires and the snapshot is not restored, the snapshot is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin in the Amazon EC2 User Guide.

Field Summary

Fields inherited from class com.amazonaws.services.recyclebin.AmazonRecycleBinClient

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.recyclebin.AmazonRecycleBin

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonRecycleBinAsyncClientBuilder	asyncBuilder()
Future<CreateRuleResult>	createRuleAsync(CreateRuleRequest request) Creates a Recycle Bin retention rule.
Future<CreateRuleResult>	createRuleAsync(CreateRuleRequest request, AsyncHandler<CreateRuleRequest,CreateRuleResult> asyncHandler) Creates a Recycle Bin retention rule.
Future<DeleteRuleResult>	deleteRuleAsync(DeleteRuleRequest request) Deletes a Recycle Bin retention rule.
Future<DeleteRuleResult>	deleteRuleAsync(DeleteRuleRequest request, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler) Deletes a Recycle Bin retention rule.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetRuleResult>	getRuleAsync(GetRuleRequest request) Gets information about a Recycle Bin retention rule.
Future<GetRuleResult>	getRuleAsync(GetRuleRequest request, AsyncHandler<GetRuleRequest,GetRuleResult> asyncHandler) Gets information about a Recycle Bin retention rule.
Future<ListRulesResult>	listRulesAsync(ListRulesRequest request) Lists the Recycle Bin retention rules in the Region.
Future<ListRulesResult>	listRulesAsync(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler) Lists the Recycle Bin retention rules in the Region.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Lists the tags assigned a specific resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists the tags assigned a specific resource.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Assigns tags to the specified resource.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Assigns tags to the specified resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Unassigns a tag from a resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Unassigns a tag from a resource.
Future<UpdateRuleResult>	updateRuleAsync(UpdateRuleRequest request) Updates an existing Recycle Bin retention rule.
Future<UpdateRuleResult>	updateRuleAsync(UpdateRuleRequest request, AsyncHandler<UpdateRuleRequest,UpdateRuleResult> asyncHandler) Updates an existing Recycle Bin retention rule.

Methods inherited from class com.amazonaws.services.recyclebin.AmazonRecycleBinClient

builder, createRule, deleteRule, getCachedResponseMetadata, getRule, listRules, listTagsForResource, tagResource, untagResource, updateRule

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.recyclebin.AmazonRecycleBin

createRule, deleteRule, getCachedResponseMetadata, getRule, listRules, listTagsForResource, tagResource, untagResource, updateRule

Method Detail

asyncBuilder

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

createRuleAsync

public Future<CreateRuleResult> createRuleAsync(CreateRuleRequest request)

Description copied from interface: AmazonRecycleBinAsync

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon EC2 User Guide.

Specified by:

createRuleAsync in interface AmazonRecycleBinAsync

Returns:

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

See Also:

AWS API Documentation

createRuleAsync

public Future<CreateRuleResult> createRuleAsync(CreateRuleRequest request,
                                                AsyncHandler<CreateRuleRequest,CreateRuleResult> asyncHandler)

Description copied from interface: AmazonRecycleBinAsync

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon EC2 User Guide.

Specified by:

createRuleAsync in interface AmazonRecycleBinAsync

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

See Also:

AWS API Documentation

deleteRuleAsync

public Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request)

Description copied from interface: AmazonRecycleBinAsync

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon EC2 User Guide.

Specified by:

deleteRuleAsync in interface AmazonRecycleBinAsync

Returns:

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

See Also:

AWS API Documentation

deleteRuleAsync

public Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request,
                                                AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)

Description copied from interface: AmazonRecycleBinAsync

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon EC2 User Guide.

Specified by:

deleteRuleAsync in interface AmazonRecycleBinAsync

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

See Also:

AWS API Documentation

getRuleAsync

public Future<GetRuleResult> getRuleAsync(GetRuleRequest request)

Description copied from interface: AmazonRecycleBinAsync

Gets information about a Recycle Bin retention rule.

Specified by:

getRuleAsync in interface AmazonRecycleBinAsync

Returns:

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

See Also:

AWS API Documentation

getRuleAsync

public Future<GetRuleResult> getRuleAsync(GetRuleRequest request,
                                          AsyncHandler<GetRuleRequest,GetRuleResult> asyncHandler)

Description copied from interface: AmazonRecycleBinAsync

Gets information about a Recycle Bin retention rule.

Specified by:

getRuleAsync in interface AmazonRecycleBinAsync

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

See Also:

AWS API Documentation

listRulesAsync

public Future<ListRulesResult> listRulesAsync(ListRulesRequest request)

Description copied from interface: AmazonRecycleBinAsync

Lists the Recycle Bin retention rules in the Region.

Specified by:

listRulesAsync in interface AmazonRecycleBinAsync

Returns:

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

See Also:

AWS API Documentation

listRulesAsync

public Future<ListRulesResult> listRulesAsync(ListRulesRequest request,
                                              AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)

Description copied from interface: AmazonRecycleBinAsync

Lists the Recycle Bin retention rules in the Region.

Specified by:

listRulesAsync in interface AmazonRecycleBinAsync

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

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AmazonRecycleBinAsync

Lists the tags assigned a specific resource.

Specified by:

listTagsForResourceAsync in interface AmazonRecycleBinAsync

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: AmazonRecycleBinAsync

Lists the tags assigned a specific resource.

Specified by:

listTagsForResourceAsync in interface AmazonRecycleBinAsync

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

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AmazonRecycleBinAsync

Assigns tags to the specified resource.

Specified by:

tagResourceAsync in interface AmazonRecycleBinAsync

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: AmazonRecycleBinAsync

Assigns tags to the specified resource.

Specified by:

tagResourceAsync in interface AmazonRecycleBinAsync

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: AmazonRecycleBinAsync

Unassigns a tag from a resource.

Specified by:

untagResourceAsync in interface AmazonRecycleBinAsync

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: AmazonRecycleBinAsync

Unassigns a tag from a resource.

Specified by:

untagResourceAsync in interface AmazonRecycleBinAsync

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

updateRuleAsync

public Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest request)

Description copied from interface: AmazonRecycleBinAsync

Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules in the Amazon EC2 User Guide.

Specified by:

updateRuleAsync in interface AmazonRecycleBinAsync

Returns:

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

See Also:

AWS API Documentation

updateRuleAsync

public Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest request,
                                                AsyncHandler<UpdateRuleRequest,UpdateRuleResult> asyncHandler)

Description copied from interface: AmazonRecycleBinAsync

Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules in the Amazon EC2 User Guide.

Specified by:

updateRuleAsync in interface AmazonRecycleBinAsync

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 UpdateRule 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 AmazonRecycleBin

Overrides:

shutdown in class AmazonRecycleBinClient