Interface QldbAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
The resource management API for Amazon QLDB
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic QldbAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aQldbAsyncClient
.cancelJournalKinesisStream
(Consumer<CancelJournalKinesisStreamRequest.Builder> cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream.cancelJournalKinesisStream
(CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream.static QldbAsyncClient
create()
Create aQldbAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateLedgerResponse> createLedger
(Consumer<CreateLedgerRequest.Builder> createLedgerRequest) Creates a new ledger in your Amazon Web Services account in the current Region.default CompletableFuture
<CreateLedgerResponse> createLedger
(CreateLedgerRequest createLedgerRequest) Creates a new ledger in your Amazon Web Services account in the current Region.default CompletableFuture
<DeleteLedgerResponse> deleteLedger
(Consumer<DeleteLedgerRequest.Builder> deleteLedgerRequest) Deletes a ledger and all of its contents.default CompletableFuture
<DeleteLedgerResponse> deleteLedger
(DeleteLedgerRequest deleteLedgerRequest) Deletes a ledger and all of its contents.describeJournalKinesisStream
(Consumer<DescribeJournalKinesisStreamRequest.Builder> describeJournalKinesisStreamRequest) Returns detailed information about a given Amazon QLDB journal stream.describeJournalKinesisStream
(DescribeJournalKinesisStreamRequest describeJournalKinesisStreamRequest) Returns detailed information about a given Amazon QLDB journal stream.describeJournalS3Export
(Consumer<DescribeJournalS3ExportRequest.Builder> describeJournalS3ExportRequest) Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.describeJournalS3Export
(DescribeJournalS3ExportRequest describeJournalS3ExportRequest) Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.default CompletableFuture
<DescribeLedgerResponse> describeLedger
(Consumer<DescribeLedgerRequest.Builder> describeLedgerRequest) Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.default CompletableFuture
<DescribeLedgerResponse> describeLedger
(DescribeLedgerRequest describeLedgerRequest) Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.exportJournalToS3
(Consumer<ExportJournalToS3Request.Builder> exportJournalToS3Request) Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.exportJournalToS3
(ExportJournalToS3Request exportJournalToS3Request) Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.default CompletableFuture
<GetBlockResponse> getBlock
(Consumer<GetBlockRequest.Builder> getBlockRequest) Returns a block object at a specified address in a journal.default CompletableFuture
<GetBlockResponse> getBlock
(GetBlockRequest getBlockRequest) Returns a block object at a specified address in a journal.default CompletableFuture
<GetDigestResponse> getDigest
(Consumer<GetDigestRequest.Builder> getDigestRequest) Returns the digest of a ledger at the latest committed block in the journal.default CompletableFuture
<GetDigestResponse> getDigest
(GetDigestRequest getDigestRequest) Returns the digest of a ledger at the latest committed block in the journal.default CompletableFuture
<GetRevisionResponse> getRevision
(Consumer<GetRevisionRequest.Builder> getRevisionRequest) Returns a revision data object for a specified document ID and block address.default CompletableFuture
<GetRevisionResponse> getRevision
(GetRevisionRequest getRevisionRequest) Returns a revision data object for a specified document ID and block address.listJournalKinesisStreamsForLedger
(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) Returns all Amazon QLDB journal streams for a given ledger.listJournalKinesisStreamsForLedger
(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) Returns all Amazon QLDB journal streams for a given ledger.listJournalKinesisStreamsForLedgerPaginator
(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) This is a variant oflistJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation.listJournalKinesisStreamsForLedgerPaginator
(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) This is a variant oflistJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation.listJournalS3Exports
(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.listJournalS3Exports
(ListJournalS3ExportsRequest listJournalS3ExportsRequest) Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.listJournalS3ExportsForLedger
(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) Returns all journal export jobs for a specified ledger.listJournalS3ExportsForLedger
(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) Returns all journal export jobs for a specified ledger.listJournalS3ExportsForLedgerPaginator
(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) This is a variant oflistJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation.listJournalS3ExportsForLedgerPaginator
(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) This is a variant oflistJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation.default ListJournalS3ExportsPublisher
listJournalS3ExportsPaginator
(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) This is a variant oflistJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation.default ListJournalS3ExportsPublisher
listJournalS3ExportsPaginator
(ListJournalS3ExportsRequest listJournalS3ExportsRequest) This is a variant oflistJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation.default CompletableFuture
<ListLedgersResponse> listLedgers
(Consumer<ListLedgersRequest.Builder> listLedgersRequest) Returns all ledgers that are associated with the current Amazon Web Services account and Region.default CompletableFuture
<ListLedgersResponse> listLedgers
(ListLedgersRequest listLedgersRequest) Returns all ledgers that are associated with the current Amazon Web Services account and Region.default ListLedgersPublisher
listLedgersPaginator
(Consumer<ListLedgersRequest.Builder> listLedgersRequest) This is a variant oflistLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation.default ListLedgersPublisher
listLedgersPaginator
(ListLedgersRequest listLedgersRequest) This is a variant oflistLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.default QldbServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstreamJournalToKinesis
(Consumer<StreamJournalToKinesisRequest.Builder> streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger.streamJournalToKinesis
(StreamJournalToKinesisRequest streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to a specified Amazon QLDB resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to a specified Amazon QLDB resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource.default CompletableFuture
<UpdateLedgerResponse> updateLedger
(Consumer<UpdateLedgerRequest.Builder> updateLedgerRequest) Updates properties on a ledger.default CompletableFuture
<UpdateLedgerResponse> updateLedger
(UpdateLedgerRequest updateLedgerRequest) Updates properties on a ledger.updateLedgerPermissionsMode
(Consumer<UpdateLedgerPermissionsModeRequest.Builder> updateLedgerPermissionsModeRequest) Updates the permissions mode of a ledger.updateLedgerPermissionsMode
(UpdateLedgerPermissionsModeRequest updateLedgerPermissionsModeRequest) Updates the permissions mode of a ledger.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelJournalKinesisStream
default CompletableFuture<CancelJournalKinesisStreamResponse> cancelJournalKinesisStream(CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be
ACTIVE
.You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
- Parameters:
cancelJournalKinesisStreamRequest
-- Returns:
- A Java Future containing the result of the CancelJournalKinesisStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelJournalKinesisStream
default CompletableFuture<CancelJournalKinesisStreamResponse> cancelJournalKinesisStream(Consumer<CancelJournalKinesisStreamRequest.Builder> cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be
ACTIVE
.You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
This is a convenience which creates an instance of the
CancelJournalKinesisStreamRequest.Builder
avoiding the need to create one manually viaCancelJournalKinesisStreamRequest.builder()
- Parameters:
cancelJournalKinesisStreamRequest
- AConsumer
that will call methods onCancelJournalKinesisStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelJournalKinesisStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLedger
default CompletableFuture<CreateLedgerResponse> createLedger(CreateLedgerRequest createLedgerRequest) Creates a new ledger in your Amazon Web Services account in the current Region.
- Parameters:
createLedgerRequest
-- Returns:
- A Java Future containing the result of the CreateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceAlreadyExistsException The specified resource already exists.
- LimitExceededException You have reached the limit on the maximum number of resources allowed.
- ResourceInUseException The specified resource can't be modified at this time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLedger
default CompletableFuture<CreateLedgerResponse> createLedger(Consumer<CreateLedgerRequest.Builder> createLedgerRequest) Creates a new ledger in your Amazon Web Services account in the current Region.
This is a convenience which creates an instance of the
CreateLedgerRequest.Builder
avoiding the need to create one manually viaCreateLedgerRequest.builder()
- Parameters:
createLedgerRequest
- AConsumer
that will call methods onCreateLedgerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceAlreadyExistsException The specified resource already exists.
- LimitExceededException You have reached the limit on the maximum number of resources allowed.
- ResourceInUseException The specified resource can't be modified at this time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLedger
default CompletableFuture<DeleteLedgerResponse> deleteLedger(DeleteLedgerRequest deleteLedgerRequest) 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. You can disable it by calling the
UpdateLedger
operation to set this parameter tofalse
.- Parameters:
deleteLedgerRequest
-- Returns:
- A Java Future containing the result of the DeleteLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourceInUseException The specified resource can't be modified at this time.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLedger
default CompletableFuture<DeleteLedgerResponse> deleteLedger(Consumer<DeleteLedgerRequest.Builder> deleteLedgerRequest) 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. You can disable it by calling the
UpdateLedger
operation to set this parameter tofalse
.
This is a convenience which creates an instance of the
DeleteLedgerRequest.Builder
avoiding the need to create one manually viaDeleteLedgerRequest.builder()
- Parameters:
deleteLedgerRequest
- AConsumer
that will call methods onDeleteLedgerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourceInUseException The specified resource can't be modified at this time.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJournalKinesisStream
default CompletableFuture<DescribeJournalKinesisStreamResponse> describeJournalKinesisStream(DescribeJournalKinesisStreamRequest describeJournalKinesisStreamRequest) Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
- Parameters:
describeJournalKinesisStreamRequest
-- Returns:
- A Java Future containing the result of the DescribeJournalKinesisStream operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJournalKinesisStream
default CompletableFuture<DescribeJournalKinesisStreamResponse> describeJournalKinesisStream(Consumer<DescribeJournalKinesisStreamRequest.Builder> describeJournalKinesisStreamRequest) Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This is a convenience which creates an instance of the
DescribeJournalKinesisStreamRequest.Builder
avoiding the need to create one manually viaDescribeJournalKinesisStreamRequest.builder()
- Parameters:
describeJournalKinesisStreamRequest
- AConsumer
that will call methods onDescribeJournalKinesisStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJournalKinesisStream operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJournalS3Export
default CompletableFuture<DescribeJournalS3ExportResponse> describeJournalS3Export(DescribeJournalS3ExportRequest describeJournalS3ExportRequest) Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
If the export job with the given
ExportId
doesn't exist, then throwsResourceNotFoundException
.If the ledger with the given
Name
doesn't exist, then throwsResourceNotFoundException
.- Parameters:
describeJournalS3ExportRequest
-- Returns:
- A Java Future containing the result of the DescribeJournalS3Export operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJournalS3Export
default CompletableFuture<DescribeJournalS3ExportResponse> describeJournalS3Export(Consumer<DescribeJournalS3ExportRequest.Builder> describeJournalS3ExportRequest) Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
If the export job with the given
ExportId
doesn't exist, then throwsResourceNotFoundException
.If the ledger with the given
Name
doesn't exist, then throwsResourceNotFoundException
.
This is a convenience which creates an instance of the
DescribeJournalS3ExportRequest.Builder
avoiding the need to create one manually viaDescribeJournalS3ExportRequest.builder()
- Parameters:
describeJournalS3ExportRequest
- AConsumer
that will call methods onDescribeJournalS3ExportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJournalS3Export operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLedger
default CompletableFuture<DescribeLedgerResponse> describeLedger(DescribeLedgerRequest describeLedgerRequest) Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
- Parameters:
describeLedgerRequest
-- Returns:
- A Java Future containing the result of the DescribeLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLedger
default CompletableFuture<DescribeLedgerResponse> describeLedger(Consumer<DescribeLedgerRequest.Builder> describeLedgerRequest) Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
This is a convenience which creates an instance of the
DescribeLedgerRequest.Builder
avoiding the need to create one manually viaDescribeLedgerRequest.builder()
- Parameters:
describeLedgerRequest
- AConsumer
that will call methods onDescribeLedgerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportJournalToS3
default CompletableFuture<ExportJournalToS3Response> exportJournalToS3(ExportJournalToS3Request exportJournalToS3Request) Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
If the ledger with the given
Name
doesn't exist, then throwsResourceNotFoundException
.If the ledger with the given
Name
is inCREATING
status, then throwsResourcePreconditionNotMetException
.You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw
LimitExceededException
.- Parameters:
exportJournalToS3Request
-- Returns:
- A Java Future containing the result of the ExportJournalToS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportJournalToS3
default CompletableFuture<ExportJournalToS3Response> exportJournalToS3(Consumer<ExportJournalToS3Request.Builder> exportJournalToS3Request) Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
If the ledger with the given
Name
doesn't exist, then throwsResourceNotFoundException
.If the ledger with the given
Name
is inCREATING
status, then throwsResourcePreconditionNotMetException
.You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw
LimitExceededException
.
This is a convenience which creates an instance of the
ExportJournalToS3Request.Builder
avoiding the need to create one manually viaExportJournalToS3Request.builder()
- Parameters:
exportJournalToS3Request
- AConsumer
that will call methods onExportJournalToS3Request.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportJournalToS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBlock
Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if
DigestTipAddress
is provided.For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.
If the specified ledger doesn't exist or is in
DELETING
status, then throwsResourceNotFoundException
.If the specified ledger is in
CREATING
status, then throwsResourcePreconditionNotMetException
.If no block exists with the specified address, then throws
InvalidParameterException
.- Parameters:
getBlockRequest
-- Returns:
- A Java Future containing the result of the GetBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBlock
default CompletableFuture<GetBlockResponse> getBlock(Consumer<GetBlockRequest.Builder> getBlockRequest) Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if
DigestTipAddress
is provided.For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.
If the specified ledger doesn't exist or is in
DELETING
status, then throwsResourceNotFoundException
.If the specified ledger is in
CREATING
status, then throwsResourcePreconditionNotMetException
.If no block exists with the specified address, then throws
InvalidParameterException
.
This is a convenience which creates an instance of the
GetBlockRequest.Builder
avoiding the need to create one manually viaGetBlockRequest.builder()
- Parameters:
getBlockRequest
- AConsumer
that will call methods onGetBlockRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDigest
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.
- Parameters:
getDigestRequest
-- Returns:
- A Java Future containing the result of the GetDigest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDigest
default CompletableFuture<GetDigestResponse> getDigest(Consumer<GetDigestRequest.Builder> getDigestRequest) 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.
This is a convenience which creates an instance of the
GetDigestRequest.Builder
avoiding the need to create one manually viaGetDigestRequest.builder()
- Parameters:
getDigestRequest
- AConsumer
that will call methods onGetDigestRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDigest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRevision
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.- Parameters:
getRevisionRequest
-- Returns:
- A Java Future containing the result of the GetRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRevision
default CompletableFuture<GetRevisionResponse> getRevision(Consumer<GetRevisionRequest.Builder> getRevisionRequest) 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.
This is a convenience which creates an instance of the
GetRevisionRequest.Builder
avoiding the need to create one manually viaGetRevisionRequest.builder()
- Parameters:
getRevisionRequest
- AConsumer
that will call methods onGetRevisionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalKinesisStreamsForLedger
default CompletableFuture<ListJournalKinesisStreamsForLedgerResponse> listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) Returns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of
MaxResults
items. It is paginated so that you can retrieve all the items by callingListJournalKinesisStreamsForLedger
multiple times.- Parameters:
listJournalKinesisStreamsForLedgerRequest
-- Returns:
- A Java Future containing the result of the ListJournalKinesisStreamsForLedger operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalKinesisStreamsForLedger
default CompletableFuture<ListJournalKinesisStreamsForLedgerResponse> listJournalKinesisStreamsForLedger(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) Returns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of
MaxResults
items. It is paginated so that you can retrieve all the items by callingListJournalKinesisStreamsForLedger
multiple times.
This is a convenience which creates an instance of the
ListJournalKinesisStreamsForLedgerRequest.Builder
avoiding the need to create one manually viaListJournalKinesisStreamsForLedgerRequest.builder()
- Parameters:
listJournalKinesisStreamsForLedgerRequest
- AConsumer
that will call methods onListJournalKinesisStreamsForLedgerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJournalKinesisStreamsForLedger operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalKinesisStreamsForLedgerPaginator
default ListJournalKinesisStreamsForLedgerPublisher listJournalKinesisStreamsForLedgerPaginator(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) This is a variant of
listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation.- Parameters:
listJournalKinesisStreamsForLedgerRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalKinesisStreamsForLedgerPaginator
default ListJournalKinesisStreamsForLedgerPublisher listJournalKinesisStreamsForLedgerPaginator(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) This is a variant of
listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation.
This is a convenience which creates an instance of the
ListJournalKinesisStreamsForLedgerRequest.Builder
avoiding the need to create one manually viaListJournalKinesisStreamsForLedgerRequest.builder()
- Parameters:
listJournalKinesisStreamsForLedgerRequest
- AConsumer
that will call methods onListJournalKinesisStreamsForLedgerRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3Exports
default CompletableFuture<ListJournalS3ExportsResponse> listJournalS3Exports(ListJournalS3ExportsRequest listJournalS3ExportsRequest) Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of
MaxResults
items, and is paginated so that you can retrieve all the items by callingListJournalS3Exports
multiple times.This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
- Parameters:
listJournalS3ExportsRequest
-- Returns:
- A Java Future containing the result of the ListJournalS3Exports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3Exports
default CompletableFuture<ListJournalS3ExportsResponse> listJournalS3Exports(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of
MaxResults
items, and is paginated so that you can retrieve all the items by callingListJournalS3Exports
multiple times.This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
This is a convenience which creates an instance of the
ListJournalS3ExportsRequest.Builder
avoiding the need to create one manually viaListJournalS3ExportsRequest.builder()
- Parameters:
listJournalS3ExportsRequest
- AConsumer
that will call methods onListJournalS3ExportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJournalS3Exports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3ExportsForLedger
default CompletableFuture<ListJournalS3ExportsForLedgerResponse> listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) Returns all journal export jobs for a specified ledger.
This action returns a maximum of
MaxResults
items, and is paginated so that you can retrieve all the items by callingListJournalS3ExportsForLedger
multiple times.This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
- Parameters:
listJournalS3ExportsForLedgerRequest
-- Returns:
- A Java Future containing the result of the ListJournalS3ExportsForLedger operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3ExportsForLedger
default CompletableFuture<ListJournalS3ExportsForLedgerResponse> listJournalS3ExportsForLedger(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) Returns all journal export jobs for a specified ledger.
This action returns a maximum of
MaxResults
items, and is paginated so that you can retrieve all the items by callingListJournalS3ExportsForLedger
multiple times.This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
This is a convenience which creates an instance of the
ListJournalS3ExportsForLedgerRequest.Builder
avoiding the need to create one manually viaListJournalS3ExportsForLedgerRequest.builder()
- Parameters:
listJournalS3ExportsForLedgerRequest
- AConsumer
that will call methods onListJournalS3ExportsForLedgerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJournalS3ExportsForLedger operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3ExportsForLedgerPaginator
default ListJournalS3ExportsForLedgerPublisher listJournalS3ExportsForLedgerPaginator(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) This is a variant of
listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation.- Parameters:
listJournalS3ExportsForLedgerRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3ExportsForLedgerPaginator
default ListJournalS3ExportsForLedgerPublisher listJournalS3ExportsForLedgerPaginator(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) This is a variant of
listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation.
This is a convenience which creates an instance of the
ListJournalS3ExportsForLedgerRequest.Builder
avoiding the need to create one manually viaListJournalS3ExportsForLedgerRequest.builder()
- Parameters:
listJournalS3ExportsForLedgerRequest
- AConsumer
that will call methods onListJournalS3ExportsForLedgerRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3ExportsPaginator
default ListJournalS3ExportsPublisher listJournalS3ExportsPaginator(ListJournalS3ExportsRequest listJournalS3ExportsRequest) This is a variant of
listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation.- Parameters:
listJournalS3ExportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJournalS3ExportsPaginator
default ListJournalS3ExportsPublisher listJournalS3ExportsPaginator(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) This is a variant of
listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation.
This is a convenience which creates an instance of the
ListJournalS3ExportsRequest.Builder
avoiding the need to create one manually viaListJournalS3ExportsRequest.builder()
- Parameters:
listJournalS3ExportsRequest
- AConsumer
that will call methods onListJournalS3ExportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLedgers
Returns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of
MaxResults
items and is paginated so that you can retrieve all the items by callingListLedgers
multiple times.- Parameters:
listLedgersRequest
-- Returns:
- A Java Future containing the result of the ListLedgers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLedgers
default CompletableFuture<ListLedgersResponse> listLedgers(Consumer<ListLedgersRequest.Builder> listLedgersRequest) Returns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of
MaxResults
items and is paginated so that you can retrieve all the items by callingListLedgers
multiple times.
This is a convenience which creates an instance of the
ListLedgersRequest.Builder
avoiding the need to create one manually viaListLedgersRequest.builder()
- Parameters:
listLedgersRequest
- AConsumer
that will call methods onListLedgersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLedgers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLedgersPaginator
This is a variant of
listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListLedgersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListLedgersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation.- Parameters:
listLedgersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLedgersPaginator
default ListLedgersPublisher listLedgersPaginator(Consumer<ListLedgersRequest.Builder> listLedgersRequest) This is a variant of
listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListLedgersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.qldb.model.ListLedgersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation.
This is a convenience which creates an instance of the
ListLedgersRequest.Builder
avoiding the need to create one manually viaListLedgersRequest.builder()
- Parameters:
listLedgersRequest
- AConsumer
that will call methods onListLedgersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
streamJournalToKinesis
default CompletableFuture<StreamJournalToKinesisResponse> streamJournalToKinesis(StreamJournalToKinesisRequest streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
- Parameters:
streamJournalToKinesisRequest
-- Returns:
- A Java Future containing the result of the StreamJournalToKinesis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
streamJournalToKinesis
default CompletableFuture<StreamJournalToKinesisResponse> streamJournalToKinesis(Consumer<StreamJournalToKinesisRequest.Builder> streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
This is a convenience which creates an instance of the
StreamJournalToKinesisRequest.Builder
avoiding the need to create one manually viaStreamJournalToKinesisRequest.builder()
- Parameters:
streamJournalToKinesisRequest
- AConsumer
that will call methods onStreamJournalToKinesisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StreamJournalToKinesis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLedger
default CompletableFuture<UpdateLedgerResponse> updateLedger(UpdateLedgerRequest updateLedgerRequest) Updates properties on a ledger.
- Parameters:
updateLedgerRequest
-- Returns:
- A Java Future containing the result of the UpdateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLedger
default CompletableFuture<UpdateLedgerResponse> updateLedger(Consumer<UpdateLedgerRequest.Builder> updateLedgerRequest) Updates properties on a ledger.
This is a convenience which creates an instance of the
UpdateLedgerRequest.Builder
avoiding the need to create one manually viaUpdateLedgerRequest.builder()
- Parameters:
updateLedgerRequest
- AConsumer
that will call methods onUpdateLedgerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLedgerPermissionsMode
default CompletableFuture<UpdateLedgerPermissionsModeResponse> updateLedgerPermissionsMode(UpdateLedgerPermissionsModeRequest updateLedgerPermissionsModeRequest) Updates the permissions mode of a ledger.
Before you switch to the
STANDARD
permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.- Parameters:
updateLedgerPermissionsModeRequest
-- Returns:
- A Java Future containing the result of the UpdateLedgerPermissionsMode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLedgerPermissionsMode
default CompletableFuture<UpdateLedgerPermissionsModeResponse> updateLedgerPermissionsMode(Consumer<UpdateLedgerPermissionsModeRequest.Builder> updateLedgerPermissionsModeRequest) Updates the permissions mode of a ledger.
Before you switch to the
STANDARD
permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.
This is a convenience which creates an instance of the
UpdateLedgerPermissionsModeRequest.Builder
avoiding the need to create one manually viaUpdateLedgerPermissionsModeRequest.builder()
- Parameters:
updateLedgerPermissionsModeRequest
- AConsumer
that will call methods onUpdateLedgerPermissionsModeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateLedgerPermissionsMode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more parameters in the request aren't valid.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aQldbAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQldbAsyncClient
.
-