AbstractAmazonQLDB (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qldb.AbstractAmazonQLDB

All Implemented Interfaces:

AmazonQLDB

Direct Known Subclasses:

AbstractAmazonQLDBAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonQLDB
extends Object
implements AmazonQLDB
```
Abstract implementation of AmazonQLDB. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.qldb.AmazonQLDB
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateLedgerResult`	`createLedger(CreateLedgerRequest request)` Creates a new ledger in your AWS account.
`DeleteLedgerResult`	`deleteLedger(DeleteLedgerRequest request)` Deletes a ledger and all of its contents.
`DescribeJournalS3ExportResult`	`describeJournalS3Export(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.
`DescribeLedgerResult`	`describeLedger(DescribeLedgerRequest request)` Returns information about a ledger, including its state and when it was created.
`ExportJournalToS3Result`	`exportJournalToS3(ExportJournalToS3Request request)` Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
`GetBlockResult`	`getBlock(GetBlockRequest request)` Returns a journal block object at a specified address in a ledger.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDigestResult`	`getDigest(GetDigestRequest request)` Returns the digest of a ledger at the latest committed block in the journal.
`GetRevisionResult`	`getRevision(GetRevisionRequest request)` Returns a revision data object for a specified document ID and block address.
`ListJournalS3ExportsResult`	`listJournalS3Exports(ListJournalS3ExportsRequest request)` Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
`ListJournalS3ExportsForLedgerResult`	`listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest request)` Returns an array of journal export job descriptions for a specified ledger.
`ListLedgersResult`	`listLedgers(ListLedgersRequest request)` Returns an array of ledger summaries that are associated with the current AWS account and Region.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns all tags for a specified Amazon QLDB resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more tags to a specified Amazon QLDB resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from a specified Amazon QLDB resource.
`UpdateLedgerResult`	`updateLedger(UpdateLedgerRequest request)` Updates properties on a ledger.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createLedger
```
public CreateLedgerResult createLedger(CreateLedgerRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Creates a new ledger in your AWS account.
    
    Specified by:
    
    createLedger in interface AmazonQLDB
    
    Returns:
    
    Result of the CreateLedger operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLedger
```
public DeleteLedgerResult deleteLedger(DeleteLedgerRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Deletes 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.
    
    Specified by:
    
    deleteLedger in interface AmazonQLDB
    
    Returns:
    
    Result of the DeleteLedger operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeJournalS3Export
```
public DescribeJournalS3ExportResult describeJournalS3Export(DescribeJournalS3ExportRequest request)
```
    Description copied from interface: AmazonQLDB
    
    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.
    
    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.
    
    Specified by:
    
    describeJournalS3Export in interface AmazonQLDB
    
    Returns:
    
    Result of the DescribeJournalS3Export operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLedger
```
public DescribeLedgerResult describeLedger(DescribeLedgerRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns information about a ledger, including its state and when it was created.
    
    Specified by:
    
    describeLedger in interface AmazonQLDB
    
    Returns:
    
    Result of the DescribeLedger operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportJournalToS3
```
public ExportJournalToS3Result exportJournalToS3(ExportJournalToS3Request request)
```
    Description copied from interface: AmazonQLDB
    
    Exports 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.
    
    Specified by:
    
    exportJournalToS3 in interface AmazonQLDB
    
    Returns:
    
    Result of the ExportJournalToS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBlock
```
public GetBlockResult getBlock(GetBlockRequest request)
```
    Description copied from interface: AmazonQLDB
    
    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.
    
    Specified by:
    
    getBlock in interface AmazonQLDB
    
    Returns:
    
    Result of the GetBlock operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDigest
```
public GetDigestResult getDigest(GetDigestRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns 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.
    
    Specified by:
    
    getDigest in interface AmazonQLDB
    
    Returns:
    
    Result of the GetDigest operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRevision
```
public GetRevisionResult getRevision(GetRevisionRequest request)
```
    Description copied from interface: AmazonQLDB
    
    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.
    
    Specified by:
    
    getRevision in interface AmazonQLDB
    
    Returns:
    
    Result of the GetRevision operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listJournalS3Exports
```
public ListJournalS3ExportsResult listJournalS3Exports(ListJournalS3ExportsRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns 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.
    
    Specified by:
    
    listJournalS3Exports in interface AmazonQLDB
    
    Returns:
    
    Result of the ListJournalS3Exports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listJournalS3ExportsForLedger
```
public ListJournalS3ExportsForLedgerResult listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns 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.
    
    Specified by:
    
    listJournalS3ExportsForLedger in interface AmazonQLDB
    
    Returns:
    
    Result of the ListJournalS3ExportsForLedger operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLedgers
```
public ListLedgersResult listLedgers(ListLedgersRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns 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.
    
    Specified by:
    
    listLedgers in interface AmazonQLDB
    
    Returns:
    
    Result of the ListLedgers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns all tags for a specified Amazon QLDB resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonQLDB
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Adds 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.
    
    Specified by:
    
    tagResource in interface AmazonQLDB
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
    
    Specified by:
    
    untagResource in interface AmazonQLDB
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLedger
```
public UpdateLedgerResult updateLedger(UpdateLedgerRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Updates properties on a ledger.
    
    Specified by:
    
    updateLedger in interface AmazonQLDB
    
    Returns:
    
    Result of the UpdateLedger operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonQLDB
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonQLDB
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonQLDB
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonQLDB
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonQLDB

Field Summary

Fields inherited from interface com.amazonaws.services.qldb.AmazonQLDB

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createLedger

deleteLedger

describeJournalS3Export

describeLedger

exportJournalToS3

getBlock

getDigest

getRevision

listJournalS3Exports

listJournalS3ExportsForLedger

listLedgers

listTagsForResource

tagResource

untagResource

updateLedger

shutdown

getCachedResponseMetadata