Interface QldbClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 QldbClientBuilder
builder()
Create a builder that can be used to configure and create aQldbClient
.cancelJournalKinesisStream
(Consumer<CancelJournalKinesisStreamRequest.Builder> cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream.cancelJournalKinesisStream
(CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream.static QldbClient
create()
Create aQldbClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateLedgerResponse
createLedger
(Consumer<CreateLedgerRequest.Builder> createLedgerRequest) Creates a new ledger in your Amazon Web Services account in the current Region.default CreateLedgerResponse
createLedger
(CreateLedgerRequest createLedgerRequest) Creates a new ledger in your Amazon Web Services account in the current Region.default DeleteLedgerResponse
deleteLedger
(Consumer<DeleteLedgerRequest.Builder> deleteLedgerRequest) Deletes a ledger and all of its contents.default 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.default 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.default 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.default 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 DescribeLedgerResponse
describeLedger
(DescribeLedgerRequest describeLedgerRequest) Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.default 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.default 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.default GetBlockResponse
getBlock
(Consumer<GetBlockRequest.Builder> getBlockRequest) Returns a block object at a specified address in a journal.default GetBlockResponse
getBlock
(GetBlockRequest getBlockRequest) Returns a block object at a specified address in a journal.default GetDigestResponse
getDigest
(Consumer<GetDigestRequest.Builder> getDigestRequest) Returns the digest of a ledger at the latest committed block in the journal.default GetDigestResponse
getDigest
(GetDigestRequest getDigestRequest) Returns the digest of a ledger at the latest committed block in the journal.default GetRevisionResponse
getRevision
(Consumer<GetRevisionRequest.Builder> getRevisionRequest) Returns a revision data object for a specified document ID and block address.default 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.default 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.default ListJournalS3ExportsResponse
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 ListJournalS3ExportsIterable
listJournalS3ExportsPaginator
(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) This is a variant oflistJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation.default ListJournalS3ExportsIterable
listJournalS3ExportsPaginator
(ListJournalS3ExportsRequest listJournalS3ExportsRequest) This is a variant oflistJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation.default ListLedgersResponse
listLedgers
(Consumer<ListLedgersRequest.Builder> listLedgersRequest) Returns all ledgers that are associated with the current Amazon Web Services account and Region.default ListLedgersResponse
listLedgers
(ListLedgersRequest listLedgersRequest) Returns all ledgers that are associated with the current Amazon Web Services account and Region.default ListLedgersIterable
listLedgersPaginator
(Consumer<ListLedgersRequest.Builder> listLedgersRequest) This is a variant oflistLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation.default ListLedgersIterable
listLedgersPaginator
(ListLedgersRequest listLedgersRequest) This is a variant oflistLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default StreamJournalToKinesisResponse
streamJournalToKinesis
(Consumer<StreamJournalToKinesisRequest.Builder> streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger.default StreamJournalToKinesisResponse
streamJournalToKinesis
(StreamJournalToKinesisRequest streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to a specified Amazon QLDB resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to a specified Amazon QLDB resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource.default UpdateLedgerResponse
updateLedger
(Consumer<UpdateLedgerRequest.Builder> updateLedgerRequest) Updates properties on a ledger.default 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 CancelJournalKinesisStreamResponse cancelJournalKinesisStream(CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the CancelJournalKinesisStream operation returned by the service.
- See Also:
-
cancelJournalKinesisStream
default CancelJournalKinesisStreamResponse cancelJournalKinesisStream(Consumer<CancelJournalKinesisStreamRequest.Builder> cancelJournalKinesisStreamRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the CancelJournalKinesisStream operation returned by the service.
- See Also:
-
createLedger
default CreateLedgerResponse createLedger(CreateLedgerRequest createLedgerRequest) throws InvalidParameterException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, QldbException Creates a new ledger in your Amazon Web Services account in the current Region.
- Parameters:
createLedgerRequest
-- Returns:
- Result of the CreateLedger operation returned by the service.
- See Also:
-
createLedger
default CreateLedgerResponse createLedger(Consumer<CreateLedgerRequest.Builder> createLedgerRequest) throws InvalidParameterException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the CreateLedger operation returned by the service.
- See Also:
-
deleteLedger
default DeleteLedgerResponse deleteLedger(DeleteLedgerRequest deleteLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DeleteLedger operation returned by the service.
- See Also:
-
deleteLedger
default DeleteLedgerResponse deleteLedger(Consumer<DeleteLedgerRequest.Builder> deleteLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, ResourceInUseException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DeleteLedger operation returned by the service.
- See Also:
-
describeJournalKinesisStream
default DescribeJournalKinesisStreamResponse describeJournalKinesisStream(DescribeJournalKinesisStreamRequest describeJournalKinesisStreamRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DescribeJournalKinesisStream operation returned by the service.
- See Also:
-
describeJournalKinesisStream
default DescribeJournalKinesisStreamResponse describeJournalKinesisStream(Consumer<DescribeJournalKinesisStreamRequest.Builder> describeJournalKinesisStreamRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DescribeJournalKinesisStream operation returned by the service.
- See Also:
-
describeJournalS3Export
default DescribeJournalS3ExportResponse describeJournalS3Export(DescribeJournalS3ExportRequest describeJournalS3ExportRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DescribeJournalS3Export operation returned by the service.
- See Also:
-
describeJournalS3Export
default DescribeJournalS3ExportResponse describeJournalS3Export(Consumer<DescribeJournalS3ExportRequest.Builder> describeJournalS3ExportRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DescribeJournalS3Export operation returned by the service.
- See Also:
-
describeLedger
default DescribeLedgerResponse describeLedger(DescribeLedgerRequest describeLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
- Parameters:
describeLedgerRequest
-- Returns:
- Result of the DescribeLedger operation returned by the service.
- See Also:
-
describeLedger
default DescribeLedgerResponse describeLedger(Consumer<DescribeLedgerRequest.Builder> describeLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the DescribeLedger operation returned by the service.
- See Also:
-
exportJournalToS3
default ExportJournalToS3Response exportJournalToS3(ExportJournalToS3Request exportJournalToS3Request) throws ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the ExportJournalToS3 operation returned by the service.
- See Also:
-
exportJournalToS3
default ExportJournalToS3Response exportJournalToS3(Consumer<ExportJournalToS3Request.Builder> exportJournalToS3Request) throws ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the ExportJournalToS3 operation returned by the service.
- See Also:
-
getBlock
default GetBlockResponse getBlock(GetBlockRequest getBlockRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the GetBlock operation returned by the service.
- See Also:
-
getBlock
default GetBlockResponse getBlock(Consumer<GetBlockRequest.Builder> getBlockRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the GetBlock operation returned by the service.
- See Also:
-
getDigest
default GetDigestResponse getDigest(GetDigestRequest getDigestRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the GetDigest operation returned by the service.
- See Also:
-
getDigest
default GetDigestResponse getDigest(Consumer<GetDigestRequest.Builder> getDigestRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the GetDigest operation returned by the service.
- See Also:
-
getRevision
default GetRevisionResponse getRevision(GetRevisionRequest getRevisionRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the GetRevision operation returned by the service.
- See Also:
-
getRevision
default GetRevisionResponse getRevision(Consumer<GetRevisionRequest.Builder> getRevisionRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the GetRevision operation returned by the service.
- See Also:
-
listJournalKinesisStreamsForLedger
default ListJournalKinesisStreamsForLedgerResponse listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListJournalKinesisStreamsForLedger operation returned by the service.
- See Also:
-
listJournalKinesisStreamsForLedger
default ListJournalKinesisStreamsForLedgerResponse listJournalKinesisStreamsForLedger(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListJournalKinesisStreamsForLedger operation returned by the service.
- See Also:
-
listJournalKinesisStreamsForLedgerPaginator
default ListJournalKinesisStreamsForLedgerIterable listJournalKinesisStreamsForLedgerPaginator(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException This is a variant of
listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerIterable responses = client.listJournalKinesisStreamsForLedgerPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerIterable responses = client .listJournalKinesisStreamsForLedgerPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerIterable responses = client.listJournalKinesisStreamsForLedgerPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listJournalKinesisStreamsForLedgerPaginator
default ListJournalKinesisStreamsForLedgerIterable listJournalKinesisStreamsForLedgerPaginator(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException This is a variant of
listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerIterable responses = client.listJournalKinesisStreamsForLedgerPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerIterable responses = client .listJournalKinesisStreamsForLedgerPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerIterable responses = client.listJournalKinesisStreamsForLedgerPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listJournalS3Exports
default ListJournalS3ExportsResponse listJournalS3Exports(ListJournalS3ExportsRequest listJournalS3ExportsRequest) throws AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListJournalS3Exports operation returned by the service.
- See Also:
-
listJournalS3Exports
default ListJournalS3ExportsResponse listJournalS3Exports(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) throws AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListJournalS3Exports operation returned by the service.
- See Also:
-
listJournalS3ExportsPaginator
default ListJournalS3ExportsIterable listJournalS3ExportsPaginator(ListJournalS3ExportsRequest listJournalS3ExportsRequest) throws AwsServiceException, SdkClientException, QldbException This is a variant of
listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsIterable responses = client.listJournalS3ExportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsIterable responses = client .listJournalS3ExportsPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsIterable responses = client.listJournalS3ExportsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listJournalS3ExportsPaginator
default ListJournalS3ExportsIterable listJournalS3ExportsPaginator(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) throws AwsServiceException, SdkClientException, QldbException This is a variant of
listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsIterable responses = client.listJournalS3ExportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsIterable responses = client .listJournalS3ExportsPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsIterable responses = client.listJournalS3ExportsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listJournalS3ExportsForLedger
default ListJournalS3ExportsForLedgerResponse listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) throws AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListJournalS3ExportsForLedger operation returned by the service.
- See Also:
-
listJournalS3ExportsForLedger
default ListJournalS3ExportsForLedgerResponse listJournalS3ExportsForLedger(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) throws AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListJournalS3ExportsForLedger operation returned by the service.
- See Also:
-
listJournalS3ExportsForLedgerPaginator
default ListJournalS3ExportsForLedgerIterable listJournalS3ExportsForLedgerPaginator(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) throws AwsServiceException, SdkClientException, QldbException This is a variant of
listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerIterable responses = client.listJournalS3ExportsForLedgerPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerIterable responses = client .listJournalS3ExportsForLedgerPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerIterable responses = client.listJournalS3ExportsForLedgerPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listJournalS3ExportsForLedgerPaginator
default ListJournalS3ExportsForLedgerIterable listJournalS3ExportsForLedgerPaginator(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) throws AwsServiceException, SdkClientException, QldbException This is a variant of
listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerIterable responses = client.listJournalS3ExportsForLedgerPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerIterable responses = client .listJournalS3ExportsForLedgerPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerIterable responses = client.listJournalS3ExportsForLedgerPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listLedgers
default ListLedgersResponse listLedgers(ListLedgersRequest listLedgersRequest) throws AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListLedgers operation returned by the service.
- See Also:
-
listLedgers
default ListLedgersResponse listLedgers(Consumer<ListLedgersRequest.Builder> listLedgersRequest) throws AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListLedgers operation returned by the service.
- See Also:
-
listLedgersPaginator
default ListLedgersIterable listLedgersPaginator(ListLedgersRequest listLedgersRequest) throws AwsServiceException, SdkClientException, QldbException This is a variant of
listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListLedgersIterable responses = client.listLedgersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListLedgersIterable responses = client.listLedgersPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListLedgersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListLedgersIterable responses = client.listLedgersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listLedgersPaginator
default ListLedgersIterable listLedgersPaginator(Consumer<ListLedgersRequest.Builder> listLedgersRequest) throws AwsServiceException, SdkClientException, QldbException This is a variant of
listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qldb.paginators.ListLedgersIterable responses = client.listLedgersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qldb.paginators.ListLedgersIterable responses = client.listLedgersPaginator(request); for (software.amazon.awssdk.services.qldb.model.ListLedgersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qldb.paginators.ListLedgersIterable responses = client.listLedgersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException Returns all tags for a specified Amazon QLDB resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
streamJournalToKinesis
default StreamJournalToKinesisResponse streamJournalToKinesis(StreamJournalToKinesisRequest streamJournalToKinesisRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the StreamJournalToKinesis operation returned by the service.
- See Also:
-
streamJournalToKinesis
default StreamJournalToKinesisResponse streamJournalToKinesis(Consumer<StreamJournalToKinesisRequest.Builder> streamJournalToKinesisRequest) throws InvalidParameterException, ResourceNotFoundException, ResourcePreconditionNotMetException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the StreamJournalToKinesis operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateLedger
default UpdateLedgerResponse updateLedger(UpdateLedgerRequest updateLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException Updates properties on a ledger.
- Parameters:
updateLedgerRequest
-- Returns:
- Result of the UpdateLedger operation returned by the service.
- See Also:
-
updateLedger
default UpdateLedgerResponse updateLedger(Consumer<UpdateLedgerRequest.Builder> updateLedgerRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the UpdateLedger operation returned by the service.
- See Also:
-
updateLedgerPermissionsMode
default UpdateLedgerPermissionsModeResponse updateLedgerPermissionsMode(UpdateLedgerPermissionsModeRequest updateLedgerPermissionsModeRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the UpdateLedgerPermissionsMode operation returned by the service.
- See Also:
-
updateLedgerPermissionsMode
default UpdateLedgerPermissionsModeResponse updateLedgerPermissionsMode(Consumer<UpdateLedgerPermissionsModeRequest.Builder> updateLedgerPermissionsModeRequest) throws InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, QldbException 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:
- Result of the UpdateLedgerPermissionsMode operation returned by the service.
- See Also:
-
create
Create aQldbClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQldbClient
. -
serviceMetadata
-
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
-