@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQLDBAsyncClient extends AmazonQLDBClient implements AmazonQLDBAsync
AsyncHandler can be used to receive notification when an
asynchronous operation completes.
The control plane for Amazon QLDB
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonQLDBAsyncClientBuilder |
asyncBuilder() |
Future<CreateLedgerResult> |
createLedgerAsync(CreateLedgerRequest request)
Creates a new ledger in your AWS account.
|
Future<CreateLedgerResult> |
createLedgerAsync(CreateLedgerRequest request,
AsyncHandler<CreateLedgerRequest,CreateLedgerResult> asyncHandler)
Creates a new ledger in your AWS account.
|
Future<DeleteLedgerResult> |
deleteLedgerAsync(DeleteLedgerRequest request)
Deletes a ledger and all of its contents.
|
Future<DeleteLedgerResult> |
deleteLedgerAsync(DeleteLedgerRequest request,
AsyncHandler<DeleteLedgerRequest,DeleteLedgerResult> asyncHandler)
Deletes a ledger and all of its contents.
|
Future<DescribeJournalS3ExportResult> |
describeJournalS3ExportAsync(DescribeJournalS3ExportRequest request)
Returns information about a journal export job, including the ledger name, export ID, when it was created,
current status, and its start and end time export parameters.
|
Future<DescribeJournalS3ExportResult> |
describeJournalS3ExportAsync(DescribeJournalS3ExportRequest request,
AsyncHandler<DescribeJournalS3ExportRequest,DescribeJournalS3ExportResult> asyncHandler)
Returns information about a journal export job, including the ledger name, export ID, when it was created,
current status, and its start and end time export parameters.
|
Future<DescribeLedgerResult> |
describeLedgerAsync(DescribeLedgerRequest request)
Returns information about a ledger, including its state and when it was created.
|
Future<DescribeLedgerResult> |
describeLedgerAsync(DescribeLedgerRequest request,
AsyncHandler<DescribeLedgerRequest,DescribeLedgerResult> asyncHandler)
Returns information about a ledger, including its state and when it was created.
|
Future<ExportJournalToS3Result> |
exportJournalToS3Async(ExportJournalToS3Request request)
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage
Service (Amazon S3) bucket.
|
Future<ExportJournalToS3Result> |
exportJournalToS3Async(ExportJournalToS3Request request,
AsyncHandler<ExportJournalToS3Request,ExportJournalToS3Result> asyncHandler)
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage
Service (Amazon S3) bucket.
|
Future<GetBlockResult> |
getBlockAsync(GetBlockRequest request)
Returns a journal block object at a specified address in a ledger.
|
Future<GetBlockResult> |
getBlockAsync(GetBlockRequest request,
AsyncHandler<GetBlockRequest,GetBlockResult> asyncHandler)
Returns a journal block object at a specified address in a ledger.
|
Future<GetDigestResult> |
getDigestAsync(GetDigestRequest request)
Returns the digest of a ledger at the latest committed block in the journal.
|
Future<GetDigestResult> |
getDigestAsync(GetDigestRequest request,
AsyncHandler<GetDigestRequest,GetDigestResult> asyncHandler)
Returns the digest of a ledger at the latest committed block in the journal.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetRevisionResult> |
getRevisionAsync(GetRevisionRequest request)
Returns a revision data object for a specified document ID and block address.
|
Future<GetRevisionResult> |
getRevisionAsync(GetRevisionRequest request,
AsyncHandler<GetRevisionRequest,GetRevisionResult> asyncHandler)
Returns a revision data object for a specified document ID and block address.
|
Future<ListJournalS3ExportsResult> |
listJournalS3ExportsAsync(ListJournalS3ExportsRequest request)
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS
account and Region.
|
Future<ListJournalS3ExportsResult> |
listJournalS3ExportsAsync(ListJournalS3ExportsRequest request,
AsyncHandler<ListJournalS3ExportsRequest,ListJournalS3ExportsResult> asyncHandler)
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS
account and Region.
|
Future<ListJournalS3ExportsForLedgerResult> |
listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request)
Returns an array of journal export job descriptions for a specified ledger.
|
Future<ListJournalS3ExportsForLedgerResult> |
listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request,
AsyncHandler<ListJournalS3ExportsForLedgerRequest,ListJournalS3ExportsForLedgerResult> asyncHandler)
Returns an array of journal export job descriptions for a specified ledger.
|
Future<ListLedgersResult> |
listLedgersAsync(ListLedgersRequest request)
Returns an array of ledger summaries that are associated with the current AWS account and Region.
|
Future<ListLedgersResult> |
listLedgersAsync(ListLedgersRequest request,
AsyncHandler<ListLedgersRequest,ListLedgersResult> asyncHandler)
Returns an array of ledger summaries that are associated with the current AWS account and Region.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
Returns all tags for a specified Amazon QLDB resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns all tags for a specified Amazon QLDB resource.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Adds one or more tags to a specified Amazon QLDB resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds one or more tags to a specified Amazon QLDB resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Removes one or more tags from a specified Amazon QLDB resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from a specified Amazon QLDB resource.
|
Future<UpdateLedgerResult> |
updateLedgerAsync(UpdateLedgerRequest request)
Updates properties on a ledger.
|
Future<UpdateLedgerResult> |
updateLedgerAsync(UpdateLedgerRequest request,
AsyncHandler<UpdateLedgerRequest,UpdateLedgerResult> asyncHandler)
Updates properties on a ledger.
|
builder, createLedger, deleteLedger, describeJournalS3Export, describeLedger, exportJournalToS3, getBlock, getCachedResponseMetadata, getDigest, getRevision, listJournalS3Exports, listJournalS3ExportsForLedger, listLedgers, listTagsForResource, tagResource, untagResource, updateLedgeraddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateLedger, deleteLedger, describeJournalS3Export, describeLedger, exportJournalToS3, getBlock, getCachedResponseMetadata, getDigest, getRevision, listJournalS3Exports, listJournalS3ExportsForLedger, listLedgers, listTagsForResource, tagResource, untagResource, updateLedgerpublic static AmazonQLDBAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateLedgerResult> createLedgerAsync(CreateLedgerRequest request)
AmazonQLDBAsyncCreates a new ledger in your AWS account.
createLedgerAsync in interface AmazonQLDBAsyncpublic Future<CreateLedgerResult> createLedgerAsync(CreateLedgerRequest request, AsyncHandler<CreateLedgerRequest,CreateLedgerResult> asyncHandler)
AmazonQLDBAsyncCreates a new ledger in your AWS account.
createLedgerAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<DeleteLedgerResult> deleteLedgerAsync(DeleteLedgerRequest request)
AmazonQLDBAsyncDeletes a ledger and all of its contents. This action is irreversible.
If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API
or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger
operation to set the flag to false. The QLDB console disables deletion protection for you when you
use it to delete a ledger.
deleteLedgerAsync in interface AmazonQLDBAsyncpublic Future<DeleteLedgerResult> deleteLedgerAsync(DeleteLedgerRequest request, AsyncHandler<DeleteLedgerRequest,DeleteLedgerResult> asyncHandler)
AmazonQLDBAsyncDeletes a ledger and all of its contents. This action is irreversible.
If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API
or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger
operation to set the flag to false. The QLDB console disables deletion protection for you when you
use it to delete a ledger.
deleteLedgerAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<DescribeJournalS3ExportResult> describeJournalS3ExportAsync(DescribeJournalS3ExportRequest request)
AmazonQLDBAsyncReturns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.
If the export job with the given ExportId doesn't exist, then throws
ResourceNotFoundException.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
describeJournalS3ExportAsync in interface AmazonQLDBAsyncpublic Future<DescribeJournalS3ExportResult> describeJournalS3ExportAsync(DescribeJournalS3ExportRequest request, AsyncHandler<DescribeJournalS3ExportRequest,DescribeJournalS3ExportResult> asyncHandler)
AmazonQLDBAsyncReturns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.
If the export job with the given ExportId doesn't exist, then throws
ResourceNotFoundException.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
describeJournalS3ExportAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<DescribeLedgerResult> describeLedgerAsync(DescribeLedgerRequest request)
AmazonQLDBAsyncReturns information about a ledger, including its state and when it was created.
describeLedgerAsync in interface AmazonQLDBAsyncpublic Future<DescribeLedgerResult> describeLedgerAsync(DescribeLedgerRequest request, AsyncHandler<DescribeLedgerRequest,DescribeLedgerResult> asyncHandler)
AmazonQLDBAsyncReturns information about a ledger, including its state and when it was created.
describeLedgerAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<ExportJournalToS3Result> exportJournalToS3Async(ExportJournalToS3Request request)
AmazonQLDBAsyncExports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
If the ledger with the given Name is in CREATING status, then throws
ResourcePreconditionNotMetException.
You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export
requests throw LimitExceededException.
exportJournalToS3Async in interface AmazonQLDBAsyncpublic Future<ExportJournalToS3Result> exportJournalToS3Async(ExportJournalToS3Request request, AsyncHandler<ExportJournalToS3Request,ExportJournalToS3Result> asyncHandler)
AmazonQLDBAsyncExports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
If the ledger with the given Name is in CREATING status, then throws
ResourcePreconditionNotMetException.
You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export
requests throw LimitExceededException.
exportJournalToS3Async in interface AmazonQLDBAsyncasyncHandler - 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.public Future<GetBlockResult> getBlockAsync(GetBlockRequest request)
AmazonQLDBAsync
Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block
for verification if DigestTipAddress is provided.
If the specified ledger doesn't exist or is in DELETING status, then throws
ResourceNotFoundException.
If the specified ledger is in CREATING status, then throws
ResourcePreconditionNotMetException.
If no block exists with the specified address, then throws InvalidParameterException.
getBlockAsync in interface AmazonQLDBAsyncpublic Future<GetBlockResult> getBlockAsync(GetBlockRequest request, AsyncHandler<GetBlockRequest,GetBlockResult> asyncHandler)
AmazonQLDBAsync
Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block
for verification if DigestTipAddress is provided.
If the specified ledger doesn't exist or is in DELETING status, then throws
ResourceNotFoundException.
If the specified ledger is in CREATING status, then throws
ResourcePreconditionNotMetException.
If no block exists with the specified address, then throws InvalidParameterException.
getBlockAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<GetDigestResult> getDigestAsync(GetDigestRequest request)
AmazonQLDBAsyncReturns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.
getDigestAsync in interface AmazonQLDBAsyncpublic Future<GetDigestResult> getDigestAsync(GetDigestRequest request, AsyncHandler<GetDigestRequest,GetDigestResult> asyncHandler)
AmazonQLDBAsyncReturns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.
getDigestAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<GetRevisionResult> getRevisionAsync(GetRevisionRequest request)
AmazonQLDBAsync
Returns a revision data object for a specified document ID and block address. Also returns a proof of the
specified revision for verification if DigestTipAddress is provided.
getRevisionAsync in interface AmazonQLDBAsyncpublic Future<GetRevisionResult> getRevisionAsync(GetRevisionRequest request, AsyncHandler<GetRevisionRequest,GetRevisionResult> asyncHandler)
AmazonQLDBAsync
Returns a revision data object for a specified document ID and block address. Also returns a proof of the
specified revision for verification if DigestTipAddress is provided.
getRevisionAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<ListJournalS3ExportsResult> listJournalS3ExportsAsync(ListJournalS3ExportsRequest request)
AmazonQLDBAsyncReturns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the
items by calling ListJournalS3Exports multiple times.
listJournalS3ExportsAsync in interface AmazonQLDBAsyncpublic Future<ListJournalS3ExportsResult> listJournalS3ExportsAsync(ListJournalS3ExportsRequest request, AsyncHandler<ListJournalS3ExportsRequest,ListJournalS3ExportsResult> asyncHandler)
AmazonQLDBAsyncReturns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the
items by calling ListJournalS3Exports multiple times.
listJournalS3ExportsAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<ListJournalS3ExportsForLedgerResult> listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request)
AmazonQLDBAsyncReturns an array of journal export job descriptions for a specified ledger.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the
items by calling ListJournalS3ExportsForLedger multiple times.
listJournalS3ExportsForLedgerAsync in interface AmazonQLDBAsyncpublic Future<ListJournalS3ExportsForLedgerResult> listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request, AsyncHandler<ListJournalS3ExportsForLedgerRequest,ListJournalS3ExportsForLedgerResult> asyncHandler)
AmazonQLDBAsyncReturns an array of journal export job descriptions for a specified ledger.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the
items by calling ListJournalS3ExportsForLedger multiple times.
listJournalS3ExportsForLedgerAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<ListLedgersResult> listLedgersAsync(ListLedgersRequest request)
AmazonQLDBAsyncReturns an array of ledger summaries that are associated with the current AWS account and Region.
This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling
ListLedgers multiple times.
listLedgersAsync in interface AmazonQLDBAsyncpublic Future<ListLedgersResult> listLedgersAsync(ListLedgersRequest request, AsyncHandler<ListLedgersRequest,ListLedgersResult> asyncHandler)
AmazonQLDBAsyncReturns an array of ledger summaries that are associated with the current AWS account and Region.
This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling
ListLedgers multiple times.
listLedgersAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonQLDBAsyncReturns all tags for a specified Amazon QLDB resource.
listTagsForResourceAsync in interface AmazonQLDBAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonQLDBAsyncReturns all tags for a specified Amazon QLDB resource.
listTagsForResourceAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonQLDBAsyncAdds one or more tags to a specified Amazon QLDB resource.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.
tagResourceAsync in interface AmazonQLDBAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonQLDBAsyncAdds one or more tags to a specified Amazon QLDB resource.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.
tagResourceAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonQLDBAsyncRemoves one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResourceAsync in interface AmazonQLDBAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonQLDBAsyncRemoves one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResourceAsync in interface AmazonQLDBAsyncasyncHandler - 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.public Future<UpdateLedgerResult> updateLedgerAsync(UpdateLedgerRequest request)
AmazonQLDBAsyncUpdates properties on a ledger.
updateLedgerAsync in interface AmazonQLDBAsyncpublic Future<UpdateLedgerResult> updateLedgerAsync(UpdateLedgerRequest request, AsyncHandler<UpdateLedgerRequest,UpdateLedgerResult> asyncHandler)
AmazonQLDBAsyncUpdates properties on a ledger.
updateLedgerAsync in interface AmazonQLDBAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonQLDBshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.