software.amazon.awssdk.services.qldb.QldbAsyncClient Maven / Gradle / Ivy
Show all versions of qldb Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.qldb;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.qldb.model.CancelJournalKinesisStreamRequest;
import software.amazon.awssdk.services.qldb.model.CancelJournalKinesisStreamResponse;
import software.amazon.awssdk.services.qldb.model.CreateLedgerRequest;
import software.amazon.awssdk.services.qldb.model.CreateLedgerResponse;
import software.amazon.awssdk.services.qldb.model.DeleteLedgerRequest;
import software.amazon.awssdk.services.qldb.model.DeleteLedgerResponse;
import software.amazon.awssdk.services.qldb.model.DescribeJournalKinesisStreamRequest;
import software.amazon.awssdk.services.qldb.model.DescribeJournalKinesisStreamResponse;
import software.amazon.awssdk.services.qldb.model.DescribeJournalS3ExportRequest;
import software.amazon.awssdk.services.qldb.model.DescribeJournalS3ExportResponse;
import software.amazon.awssdk.services.qldb.model.DescribeLedgerRequest;
import software.amazon.awssdk.services.qldb.model.DescribeLedgerResponse;
import software.amazon.awssdk.services.qldb.model.ExportJournalToS3Request;
import software.amazon.awssdk.services.qldb.model.ExportJournalToS3Response;
import software.amazon.awssdk.services.qldb.model.GetBlockRequest;
import software.amazon.awssdk.services.qldb.model.GetBlockResponse;
import software.amazon.awssdk.services.qldb.model.GetDigestRequest;
import software.amazon.awssdk.services.qldb.model.GetDigestResponse;
import software.amazon.awssdk.services.qldb.model.GetRevisionRequest;
import software.amazon.awssdk.services.qldb.model.GetRevisionResponse;
import software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest;
import software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse;
import software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest;
import software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse;
import software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest;
import software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse;
import software.amazon.awssdk.services.qldb.model.ListLedgersRequest;
import software.amazon.awssdk.services.qldb.model.ListLedgersResponse;
import software.amazon.awssdk.services.qldb.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.qldb.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.qldb.model.StreamJournalToKinesisRequest;
import software.amazon.awssdk.services.qldb.model.StreamJournalToKinesisResponse;
import software.amazon.awssdk.services.qldb.model.TagResourceRequest;
import software.amazon.awssdk.services.qldb.model.TagResourceResponse;
import software.amazon.awssdk.services.qldb.model.UntagResourceRequest;
import software.amazon.awssdk.services.qldb.model.UntagResourceResponse;
import software.amazon.awssdk.services.qldb.model.UpdateLedgerPermissionsModeRequest;
import software.amazon.awssdk.services.qldb.model.UpdateLedgerPermissionsModeResponse;
import software.amazon.awssdk.services.qldb.model.UpdateLedgerRequest;
import software.amazon.awssdk.services.qldb.model.UpdateLedgerResponse;
import software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher;
import software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher;
import software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher;
import software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher;
/**
* Service client for accessing QLDB asynchronously. This can be created using the static {@link #builder()} method.The
* asynchronous client performs non-blocking I/O when configured with any {@code 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
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface QldbAsyncClient extends AwsClient {
String SERVICE_NAME = "qldb";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "qldb";
/**
*
* 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.
*
*
* @param cancelJournalKinesisStreamRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.CancelJournalKinesisStream
* @see AWS API Documentation
*/
default CompletableFuture cancelJournalKinesisStream(
CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CancelJournalKinesisStreamRequest.Builder} avoiding
* the need to create one manually via {@link CancelJournalKinesisStreamRequest#builder()}
*
*
* @param cancelJournalKinesisStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.CancelJournalKinesisStreamRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.CancelJournalKinesisStream
* @see AWS API Documentation
*/
default CompletableFuture cancelJournalKinesisStream(
Consumer cancelJournalKinesisStreamRequest) {
return cancelJournalKinesisStream(CancelJournalKinesisStreamRequest.builder()
.applyMutation(cancelJournalKinesisStreamRequest).build());
}
/**
*
* Creates a new ledger in your Amazon Web Services account in the current Region.
*
*
* @param createLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.CreateLedger
* @see AWS API
* Documentation
*/
default CompletableFuture createLedger(CreateLedgerRequest createLedgerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new ledger in your Amazon Web Services account in the current Region.
*
*
*
* This is a convenience which creates an instance of the {@link CreateLedgerRequest.Builder} avoiding the need to
* create one manually via {@link CreateLedgerRequest#builder()}
*
*
* @param createLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.CreateLedgerRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.CreateLedger
* @see AWS API
* Documentation
*/
default CompletableFuture createLedger(Consumer createLedgerRequest) {
return createLedger(CreateLedgerRequest.builder().applyMutation(createLedgerRequest).build());
}
/**
*
* 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 to false.
*
*
* @param deleteLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DeleteLedger
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLedger(DeleteLedgerRequest deleteLedgerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 to false.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteLedgerRequest.Builder} avoiding the need to
* create one manually via {@link DeleteLedgerRequest#builder()}
*
*
* @param deleteLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.DeleteLedgerRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DeleteLedger
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLedger(Consumer deleteLedgerRequest) {
return deleteLedger(DeleteLedgerRequest.builder().applyMutation(deleteLedgerRequest).build());
}
/**
*
* 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.
*
*
* @param describeJournalKinesisStreamRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DescribeJournalKinesisStream
* @see AWS API Documentation
*/
default CompletableFuture describeJournalKinesisStream(
DescribeJournalKinesisStreamRequest describeJournalKinesisStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeJournalKinesisStreamRequest.Builder}
* avoiding the need to create one manually via {@link DescribeJournalKinesisStreamRequest#builder()}
*
*
* @param describeJournalKinesisStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.DescribeJournalKinesisStreamRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DescribeJournalKinesisStream
* @see AWS API Documentation
*/
default CompletableFuture describeJournalKinesisStream(
Consumer describeJournalKinesisStreamRequest) {
return describeJournalKinesisStream(DescribeJournalKinesisStreamRequest.builder()
.applyMutation(describeJournalKinesisStreamRequest).build());
}
/**
*
* 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 throws
* ResourceNotFoundException.
*
*
* If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
*
*
* @param describeJournalS3ExportRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DescribeJournalS3Export
* @see AWS
* API Documentation
*/
default CompletableFuture describeJournalS3Export(
DescribeJournalS3ExportRequest describeJournalS3ExportRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 throws
* ResourceNotFoundException.
*
*
* If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeJournalS3ExportRequest.Builder} avoiding
* the need to create one manually via {@link DescribeJournalS3ExportRequest#builder()}
*
*
* @param describeJournalS3ExportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.DescribeJournalS3ExportRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DescribeJournalS3Export
* @see AWS
* API Documentation
*/
default CompletableFuture describeJournalS3Export(
Consumer describeJournalS3ExportRequest) {
return describeJournalS3Export(DescribeJournalS3ExportRequest.builder().applyMutation(describeJournalS3ExportRequest)
.build());
}
/**
*
* Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when
* it was created.
*
*
* @param describeLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DescribeLedger
* @see AWS API
* Documentation
*/
default CompletableFuture describeLedger(DescribeLedgerRequest describeLedgerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeLedgerRequest.Builder} avoiding the need to
* create one manually via {@link DescribeLedgerRequest#builder()}
*
*
* @param describeLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.DescribeLedgerRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.DescribeLedger
* @see AWS API
* Documentation
*/
default CompletableFuture describeLedger(Consumer describeLedgerRequest) {
return describeLedger(DescribeLedgerRequest.builder().applyMutation(describeLedgerRequest).build());
}
/**
*
* 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 throws ResourceNotFoundException.
*
*
* If the ledger with the given Name is in CREATING status, then throws
* ResourcePreconditionNotMetException.
*
*
* You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export
* requests throw LimitExceededException.
*
*
* @param exportJournalToS3Request
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ExportJournalToS3
* @see AWS API
* Documentation
*/
default CompletableFuture exportJournalToS3(ExportJournalToS3Request exportJournalToS3Request) {
throw new UnsupportedOperationException();
}
/**
*
* 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 throws ResourceNotFoundException.
*
*
* If the ledger with the given Name is in CREATING status, then throws
* ResourcePreconditionNotMetException.
*
*
* You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export
* requests throw LimitExceededException.
*
*
*
* This is a convenience which creates an instance of the {@link ExportJournalToS3Request.Builder} avoiding the need
* to create one manually via {@link ExportJournalToS3Request#builder()}
*
*
* @param exportJournalToS3Request
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ExportJournalToS3Request.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ExportJournalToS3
* @see AWS API
* Documentation
*/
default CompletableFuture exportJournalToS3(
Consumer exportJournalToS3Request) {
return exportJournalToS3(ExportJournalToS3Request.builder().applyMutation(exportJournalToS3Request).build());
}
/**
*
* 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 throws
* ResourceNotFoundException.
*
*
* If the specified ledger is in CREATING status, then throws
* ResourcePreconditionNotMetException.
*
*
* If no block exists with the specified address, then throws InvalidParameterException.
*
*
* @param getBlockRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.GetBlock
* @see AWS API
* Documentation
*/
default CompletableFuture getBlock(GetBlockRequest getBlockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 throws
* ResourceNotFoundException.
*
*
* If the specified ledger is in CREATING status, then throws
* ResourcePreconditionNotMetException.
*
*
* If no block exists with the specified address, then throws InvalidParameterException.
*
*
*
* This is a convenience which creates an instance of the {@link GetBlockRequest.Builder} avoiding the need to
* create one manually via {@link GetBlockRequest#builder()}
*
*
* @param getBlockRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.GetBlockRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.GetBlock
* @see AWS API
* Documentation
*/
default CompletableFuture getBlock(Consumer getBlockRequest) {
return getBlock(GetBlockRequest.builder().applyMutation(getBlockRequest).build());
}
/**
*
* 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.
*
*
* @param getDigestRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.GetDigest
* @see AWS API
* Documentation
*/
default CompletableFuture getDigest(GetDigestRequest getDigestRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDigestRequest.Builder} avoiding the need to
* create one manually via {@link GetDigestRequest#builder()}
*
*
* @param getDigestRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.GetDigestRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.GetDigest
* @see AWS API
* Documentation
*/
default CompletableFuture getDigest(Consumer getDigestRequest) {
return getDigest(GetDigestRequest.builder().applyMutation(getDigestRequest).build());
}
/**
*
* 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.
*
*
* @param getRevisionRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.GetRevision
* @see AWS API
* Documentation
*/
default CompletableFuture getRevision(GetRevisionRequest getRevisionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetRevisionRequest.Builder} avoiding the need to
* create one manually via {@link GetRevisionRequest#builder()}
*
*
* @param getRevisionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.GetRevisionRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.GetRevision
* @see AWS API
* Documentation
*/
default CompletableFuture getRevision(Consumer getRevisionRequest) {
return getRevision(GetRevisionRequest.builder().applyMutation(getRevisionRequest).build());
}
/**
*
* 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 calling ListJournalKinesisStreamsForLedger multiple times.
*
*
* @param listJournalKinesisStreamsForLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalKinesisStreamsForLedger
* @see AWS API Documentation
*/
default CompletableFuture listJournalKinesisStreamsForLedger(
ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 calling ListJournalKinesisStreamsForLedger multiple times.
*
*
*
* This is a convenience which creates an instance of the {@link ListJournalKinesisStreamsForLedgerRequest.Builder}
* avoiding the need to create one manually via {@link ListJournalKinesisStreamsForLedgerRequest#builder()}
*
*
* @param listJournalKinesisStreamsForLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest.Builder} to
* create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalKinesisStreamsForLedger
* @see AWS API Documentation
*/
default CompletableFuture listJournalKinesisStreamsForLedger(
Consumer listJournalKinesisStreamsForLedgerRequest) {
return listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest.builder()
.applyMutation(listJournalKinesisStreamsForLedgerRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)}
* operation.
*
*
* @param listJournalKinesisStreamsForLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalKinesisStreamsForLedger
* @see AWS API Documentation
*/
default ListJournalKinesisStreamsForLedgerPublisher listJournalKinesisStreamsForLedgerPaginator(
ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) {
return new ListJournalKinesisStreamsForLedgerPublisher(this, listJournalKinesisStreamsForLedgerRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListJournalKinesisStreamsForLedgerRequest.Builder}
* avoiding the need to create one manually via {@link ListJournalKinesisStreamsForLedgerRequest#builder()}
*
*
* @param listJournalKinesisStreamsForLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest.Builder} to
* create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalKinesisStreamsForLedger
* @see AWS API Documentation
*/
default ListJournalKinesisStreamsForLedgerPublisher listJournalKinesisStreamsForLedgerPaginator(
Consumer listJournalKinesisStreamsForLedgerRequest) {
return listJournalKinesisStreamsForLedgerPaginator(ListJournalKinesisStreamsForLedgerRequest.builder()
.applyMutation(listJournalKinesisStreamsForLedgerRequest).build());
}
/**
*
* 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 calling ListJournalS3Exports multiple times.
*
*
* This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
*
*
* @param listJournalS3ExportsRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3Exports
* @see AWS API
* Documentation
*/
default CompletableFuture listJournalS3Exports(
ListJournalS3ExportsRequest listJournalS3ExportsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 calling ListJournalS3Exports 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 {@link ListJournalS3ExportsRequest.Builder} avoiding the
* need to create one manually via {@link ListJournalS3ExportsRequest#builder()}
*
*
* @param listJournalS3ExportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3Exports
* @see AWS API
* Documentation
*/
default CompletableFuture listJournalS3Exports(
Consumer listJournalS3ExportsRequest) {
return listJournalS3Exports(ListJournalS3ExportsRequest.builder().applyMutation(listJournalS3ExportsRequest).build());
}
/**
*
* 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 calling ListJournalS3ExportsForLedger multiple times.
*
*
* This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
*
*
* @param listJournalS3ExportsForLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3ExportsForLedger
* @see AWS API Documentation
*/
default CompletableFuture listJournalS3ExportsForLedger(
ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 calling ListJournalS3ExportsForLedger 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 {@link ListJournalS3ExportsForLedgerRequest.Builder}
* avoiding the need to create one manually via {@link ListJournalS3ExportsForLedgerRequest#builder()}
*
*
* @param listJournalS3ExportsForLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest.Builder} to create
* a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3ExportsForLedger
* @see AWS API Documentation
*/
default CompletableFuture listJournalS3ExportsForLedger(
Consumer listJournalS3ExportsForLedgerRequest) {
return listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest.builder()
.applyMutation(listJournalS3ExportsForLedgerRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)}
* operation.
*
*
* @param listJournalS3ExportsForLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3ExportsForLedger
* @see AWS API Documentation
*/
default ListJournalS3ExportsForLedgerPublisher listJournalS3ExportsForLedgerPaginator(
ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) {
return new ListJournalS3ExportsForLedgerPublisher(this, listJournalS3ExportsForLedgerRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListJournalS3ExportsForLedgerRequest.Builder}
* avoiding the need to create one manually via {@link ListJournalS3ExportsForLedgerRequest#builder()}
*
*
* @param listJournalS3ExportsForLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest.Builder} to create
* a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3ExportsForLedger
* @see AWS API Documentation
*/
default ListJournalS3ExportsForLedgerPublisher listJournalS3ExportsForLedgerPaginator(
Consumer listJournalS3ExportsForLedgerRequest) {
return listJournalS3ExportsForLedgerPaginator(ListJournalS3ExportsForLedgerRequest.builder()
.applyMutation(listJournalS3ExportsForLedgerRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)}
* operation.
*
*
* @param listJournalS3ExportsRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3Exports
* @see AWS API
* Documentation
*/
default ListJournalS3ExportsPublisher listJournalS3ExportsPaginator(ListJournalS3ExportsRequest listJournalS3ExportsRequest) {
return new ListJournalS3ExportsPublisher(this, listJournalS3ExportsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListJournalS3ExportsRequest.Builder} avoiding the
* need to create one manually via {@link ListJournalS3ExportsRequest#builder()}
*
*
* @param listJournalS3ExportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListJournalS3Exports
* @see AWS API
* Documentation
*/
default ListJournalS3ExportsPublisher listJournalS3ExportsPaginator(
Consumer listJournalS3ExportsRequest) {
return listJournalS3ExportsPaginator(ListJournalS3ExportsRequest.builder().applyMutation(listJournalS3ExportsRequest)
.build());
}
/**
*
* 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 calling ListLedgers multiple times.
*
*
* @param listLedgersRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListLedgers
* @see AWS API
* Documentation
*/
default CompletableFuture listLedgers(ListLedgersRequest listLedgersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 calling ListLedgers multiple times.
*
*
*
* This is a convenience which creates an instance of the {@link ListLedgersRequest.Builder} avoiding the need to
* create one manually via {@link ListLedgersRequest#builder()}
*
*
* @param listLedgersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListLedgersRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListLedgers
* @see AWS API
* Documentation
*/
default CompletableFuture listLedgers(Consumer listLedgersRequest) {
return listLedgers(ListLedgersRequest.builder().applyMutation(listLedgersRequest).build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListLedgersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)} operation.
*
*
* @param listLedgersRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListLedgers
* @see AWS API
* Documentation
*/
default ListLedgersPublisher listLedgersPaginator(ListLedgersRequest listLedgersRequest) {
return new ListLedgersPublisher(this, listLedgersRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.qldb.model.ListLedgersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListLedgersRequest.Builder} avoiding the need to
* create one manually via {@link ListLedgersRequest#builder()}
*
*
* @param listLedgersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListLedgersRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListLedgers
* @see AWS API
* Documentation
*/
default ListLedgersPublisher listLedgersPaginator(Consumer listLedgersRequest) {
return listLedgersPaginator(ListLedgersRequest.builder().applyMutation(listLedgersRequest).build());
}
/**
*
* Returns all tags for a specified Amazon QLDB resource.
*
*
* @param listTagsForResourceRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns all tags for a specified Amazon QLDB resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.ListTagsForResourceRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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.
*
*
* @param streamJournalToKinesisRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.StreamJournalToKinesis
* @see AWS
* API Documentation
*/
default CompletableFuture streamJournalToKinesis(
StreamJournalToKinesisRequest streamJournalToKinesisRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StreamJournalToKinesisRequest.Builder} avoiding the
* need to create one manually via {@link StreamJournalToKinesisRequest#builder()}
*
*
* @param streamJournalToKinesisRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.StreamJournalToKinesisRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.StreamJournalToKinesis
* @see AWS
* API Documentation
*/
default CompletableFuture streamJournalToKinesis(
Consumer streamJournalToKinesisRequest) {
return streamJournalToKinesis(StreamJournalToKinesisRequest.builder().applyMutation(streamJournalToKinesisRequest)
.build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.TagResourceRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
*
*
* @param untagResourceRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.UntagResourceRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates properties on a ledger.
*
*
* @param updateLedgerRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.UpdateLedger
* @see AWS API
* Documentation
*/
default CompletableFuture updateLedger(UpdateLedgerRequest updateLedgerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates properties on a ledger.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateLedgerRequest.Builder} avoiding the need to
* create one manually via {@link UpdateLedgerRequest#builder()}
*
*
* @param updateLedgerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.UpdateLedgerRequest.Builder} to create a request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.UpdateLedger
* @see AWS API
* Documentation
*/
default CompletableFuture updateLedger(Consumer updateLedgerRequest) {
return updateLedger(UpdateLedgerRequest.builder().applyMutation(updateLedgerRequest).build());
}
/**
*
* 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.
*
*
*
* @param updateLedgerPermissionsModeRequest
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.UpdateLedgerPermissionsMode
* @see AWS API Documentation
*/
default CompletableFuture updateLedgerPermissionsMode(
UpdateLedgerPermissionsModeRequest updateLedgerPermissionsModeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateLedgerPermissionsModeRequest.Builder}
* avoiding the need to create one manually via {@link UpdateLedgerPermissionsModeRequest#builder()}
*
*
* @param updateLedgerPermissionsModeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.qldb.model.UpdateLedgerPermissionsModeRequest.Builder} to create a
* request.
* @return 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 invoke
* {@link Throwable#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.
*
* @sample QldbAsyncClient.UpdateLedgerPermissionsMode
* @see AWS API Documentation
*/
default CompletableFuture updateLedgerPermissionsMode(
Consumer updateLedgerPermissionsModeRequest) {
return updateLedgerPermissionsMode(UpdateLedgerPermissionsModeRequest.builder()
.applyMutation(updateLedgerPermissionsModeRequest).build());
}
@Override
default QldbServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link QldbAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static QldbAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link QldbAsyncClient}.
*/
static QldbAsyncClientBuilder builder() {
return new DefaultQldbAsyncClientBuilder();
}
}