Package software.amazon.awssdk.services.backupstorage

Interface BackupStorageAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BackupStorageAsyncClient extends AwsClient
Service client for accessing AWS Backup Storage asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. The frontend service for Cryo Storage.

  • Field Details

  • Method Details

    • deleteObject

      default CompletableFuture<DeleteObjectResponse> deleteObject(DeleteObjectRequest deleteObjectRequest)
      Delete Object from the incremental base Backup.
      Parameters:
      deleteObjectRequest -
      Returns:
      A Java Future containing the result of the DeleteObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteObject

      default CompletableFuture<DeleteObjectResponse> deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
      Delete Object from the incremental base Backup.

      This is a convenience which creates an instance of the DeleteObjectRequest.Builder avoiding the need to create one manually via DeleteObjectRequest.builder()

      Parameters:
      deleteObjectRequest - A Consumer that will call methods on DeleteObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChunk

      default <ReturnT> CompletableFuture<ReturnT> getChunk(GetChunkRequest getChunkRequest, AsyncResponseTransformer<GetChunkResponse,ReturnT> asyncResponseTransformer)
      Gets the specified object's chunk.
      Parameters:
      getChunkRequest -
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Chunk data'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChunk

      default <ReturnT> CompletableFuture<ReturnT> getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, AsyncResponseTransformer<GetChunkResponse,ReturnT> asyncResponseTransformer)
      Gets the specified object's chunk.

      This is a convenience which creates an instance of the GetChunkRequest.Builder avoiding the need to create one manually via GetChunkRequest.builder()

      Parameters:
      getChunkRequest - A Consumer that will call methods on GetChunkRequest.Builder to create a request.
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Chunk data'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChunk

      default CompletableFuture<GetChunkResponse> getChunk(GetChunkRequest getChunkRequest, Path destinationPath)
      Gets the specified object's chunk.
      Parameters:
      getChunkRequest -
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'Chunk data'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChunk

      default CompletableFuture<GetChunkResponse> getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, Path destinationPath)
      Gets the specified object's chunk.

      This is a convenience which creates an instance of the GetChunkRequest.Builder avoiding the need to create one manually via GetChunkRequest.builder()

      Parameters:
      getChunkRequest - A Consumer that will call methods on GetChunkRequest.Builder to create a request.
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'Chunk data'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectMetadata

      default <ReturnT> CompletableFuture<ReturnT> getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, AsyncResponseTransformer<GetObjectMetadataResponse,ReturnT> asyncResponseTransformer)
      Get metadata associated with an Object.
      Parameters:
      getObjectMetadataRequest -
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Metadata blob.'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectMetadata

      default <ReturnT> CompletableFuture<ReturnT> getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, AsyncResponseTransformer<GetObjectMetadataResponse,ReturnT> asyncResponseTransformer)
      Get metadata associated with an Object.

      This is a convenience which creates an instance of the GetObjectMetadataRequest.Builder avoiding the need to create one manually via GetObjectMetadataRequest.builder()

      Parameters:
      getObjectMetadataRequest - A Consumer that will call methods on GetObjectMetadataRequest.Builder to create a request.
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Metadata blob.'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectMetadata

      default CompletableFuture<GetObjectMetadataResponse> getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, Path destinationPath)
      Get metadata associated with an Object.
      Parameters:
      getObjectMetadataRequest -
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'Metadata blob.'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectMetadata

      default CompletableFuture<GetObjectMetadataResponse> getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, Path destinationPath)
      Get metadata associated with an Object.

      This is a convenience which creates an instance of the GetObjectMetadataRequest.Builder avoiding the need to create one manually via GetObjectMetadataRequest.builder()

      Parameters:
      getObjectMetadataRequest - A Consumer that will call methods on GetObjectMetadataRequest.Builder to create a request.
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'Metadata blob.'.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChunks

      default CompletableFuture<ListChunksResponse> listChunks(ListChunksRequest listChunksRequest)
      List chunks in a given Object
      Parameters:
      listChunksRequest -
      Returns:
      A Java Future containing the result of the ListChunks 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChunks

      default CompletableFuture<ListChunksResponse> listChunks(Consumer<ListChunksRequest.Builder> listChunksRequest)
      List chunks in a given Object

      This is a convenience which creates an instance of the ListChunksRequest.Builder avoiding the need to create one manually via ListChunksRequest.builder()

      Parameters:
      listChunksRequest - A Consumer that will call methods on ListChunksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListChunks 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChunksPaginator

      default ListChunksPublisher listChunksPaginator(ListChunksRequest listChunksRequest)

      This is a variant of listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListChunksPublisher publisher = client.listChunksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListChunksPublisher publisher = client.listChunksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupstorage.model.ListChunksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupstorage.model.ListChunksResponse 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 listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest) operation.

      Parameters:
      listChunksRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChunksPaginator

      default ListChunksPublisher listChunksPaginator(Consumer<ListChunksRequest.Builder> listChunksRequest)

      This is a variant of listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListChunksPublisher publisher = client.listChunksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListChunksPublisher publisher = client.listChunksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupstorage.model.ListChunksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupstorage.model.ListChunksResponse 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 listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest) operation.


      This is a convenience which creates an instance of the ListChunksRequest.Builder avoiding the need to create one manually via ListChunksRequest.builder()

      Parameters:
      listChunksRequest - A Consumer that will call methods on ListChunksRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjects

      default CompletableFuture<ListObjectsResponse> listObjects(ListObjectsRequest listObjectsRequest)
      List all Objects in a given Backup.
      Parameters:
      listObjectsRequest -
      Returns:
      A Java Future containing the result of the ListObjects 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjects

      default CompletableFuture<ListObjectsResponse> listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
      List all Objects in a given Backup.

      This is a convenience which creates an instance of the ListObjectsRequest.Builder avoiding the need to create one manually via ListObjectsRequest.builder()

      Parameters:
      listObjectsRequest - A Consumer that will call methods on ListObjectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjects 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectsPaginator

      default ListObjectsPublisher listObjectsPaginator(ListObjectsRequest listObjectsRequest)

      This is a variant of listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListObjectsPublisher publisher = client.listObjectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListObjectsPublisher publisher = client.listObjectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupstorage.model.ListObjectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupstorage.model.ListObjectsResponse 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 listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest) operation.

      Parameters:
      listObjectsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectsPaginator

      default ListObjectsPublisher listObjectsPaginator(Consumer<ListObjectsRequest.Builder> listObjectsRequest)

      This is a variant of listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListObjectsPublisher publisher = client.listObjectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backupstorage.paginators.ListObjectsPublisher publisher = client.listObjectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupstorage.model.ListObjectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupstorage.model.ListObjectsResponse 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 listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest) operation.


      This is a convenience which creates an instance of the ListObjectsRequest.Builder avoiding the need to create one manually via ListObjectsRequest.builder()

      Parameters:
      listObjectsRequest - A Consumer that will call methods on ListObjectsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyObjectComplete

      default CompletableFuture<NotifyObjectCompleteResponse> notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, AsyncRequestBody requestBody)
      Complete upload
      Parameters:
      notifyObjectCompleteRequest -
      requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestBody for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'Optional metadata associated with an Object. Maximum length is 4MB.'
      Returns:
      A Java Future containing the result of the NotifyObjectComplete 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyObjectComplete

      default CompletableFuture<NotifyObjectCompleteResponse> notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, AsyncRequestBody requestBody)
      Complete upload

      This is a convenience which creates an instance of the NotifyObjectCompleteRequest.Builder avoiding the need to create one manually via NotifyObjectCompleteRequest.builder()

      Parameters:
      notifyObjectCompleteRequest - A Consumer that will call methods on NotifyObjectCompleteRequest.Builder to create a request.
      requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestBody for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'Optional metadata associated with an Object. Maximum length is 4MB.'
      Returns:
      A Java Future containing the result of the NotifyObjectComplete 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyObjectComplete

      default CompletableFuture<NotifyObjectCompleteResponse> notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, Path sourcePath)
      Complete upload
      Parameters:
      notifyObjectCompleteRequest -
      sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'Optional metadata associated with an Object. Maximum length is 4MB.'
      Returns:
      A Java Future containing the result of the NotifyObjectComplete 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyObjectComplete

      default CompletableFuture<NotifyObjectCompleteResponse> notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, Path sourcePath)
      Complete upload

      This is a convenience which creates an instance of the NotifyObjectCompleteRequest.Builder avoiding the need to create one manually via NotifyObjectCompleteRequest.builder()

      Parameters:
      notifyObjectCompleteRequest - A Consumer that will call methods on NotifyObjectCompleteRequest.Builder to create a request.
      sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'Optional metadata associated with an Object. Maximum length is 4MB.'
      Returns:
      A Java Future containing the result of the NotifyObjectComplete 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putChunk

      default CompletableFuture<PutChunkResponse> putChunk(PutChunkRequest putChunkRequest, AsyncRequestBody requestBody)
      Upload chunk.
      Parameters:
      putChunkRequest -
      requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestBody for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'Data to be uploaded'
      Returns:
      A Java Future containing the result of the PutChunk 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putChunk

      default CompletableFuture<PutChunkResponse> putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, AsyncRequestBody requestBody)
      Upload chunk.

      This is a convenience which creates an instance of the PutChunkRequest.Builder avoiding the need to create one manually via PutChunkRequest.builder()

      Parameters:
      putChunkRequest - A Consumer that will call methods on PutChunkRequest.Builder to create a request.
      requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestBody for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'Data to be uploaded'
      Returns:
      A Java Future containing the result of the PutChunk 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putChunk

      default CompletableFuture<PutChunkResponse> putChunk(PutChunkRequest putChunkRequest, Path sourcePath)
      Upload chunk.
      Parameters:
      putChunkRequest -
      sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'Data to be uploaded'
      Returns:
      A Java Future containing the result of the PutChunk 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putChunk

      default CompletableFuture<PutChunkResponse> putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, Path sourcePath)
      Upload chunk.

      This is a convenience which creates an instance of the PutChunkRequest.Builder avoiding the need to create one manually via PutChunkRequest.builder()

      Parameters:
      putChunkRequest - A Consumer that will call methods on PutChunkRequest.Builder to create a request.
      sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'Data to be uploaded'
      Returns:
      A Java Future containing the result of the PutChunk 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putObject

      default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, AsyncRequestBody requestBody)
      Upload object that can store object metadata String and data blob in single API call using inline chunk field.
      Parameters:
      putObjectRequest -
      requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestBody for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'Inline chunk data to be uploaded.'
      Returns:
      A Java Future containing the result of the PutObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putObject

      default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, AsyncRequestBody requestBody)
      Upload object that can store object metadata String and data blob in single API call using inline chunk field.

      This is a convenience which creates an instance of the PutObjectRequest.Builder avoiding the need to create one manually via PutObjectRequest.builder()

      Parameters:
      putObjectRequest - A Consumer that will call methods on PutObjectRequest.Builder to create a request.
      requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestBody for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'Inline chunk data to be uploaded.'
      Returns:
      A Java Future containing the result of the PutObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putObject

      default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, Path sourcePath)
      Upload object that can store object metadata String and data blob in single API call using inline chunk field.
      Parameters:
      putObjectRequest -
      sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'Inline chunk data to be uploaded.'
      Returns:
      A Java Future containing the result of the PutObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putObject

      default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, Path sourcePath)
      Upload object that can store object metadata String and data blob in single API call using inline chunk field.

      This is a convenience which creates an instance of the PutObjectRequest.Builder avoiding the need to create one manually via PutObjectRequest.builder()

      Parameters:
      putObjectRequest - A Consumer that will call methods on PutObjectRequest.Builder to create a request.
      sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'Inline chunk data to be uploaded.'
      Returns:
      A Java Future containing the result of the PutObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • KmsInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startObject

      default CompletableFuture<StartObjectResponse> startObject(StartObjectRequest startObjectRequest)
      Start upload containing one or many chunks.
      Parameters:
      startObjectRequest -
      Returns:
      A Java Future containing the result of the StartObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • DataAlreadyExistsException Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startObject

      default CompletableFuture<StartObjectResponse> startObject(Consumer<StartObjectRequest.Builder> startObjectRequest)
      Start upload containing one or many chunks.

      This is a convenience which creates an instance of the StartObjectRequest.Builder avoiding the need to create one manually via StartObjectRequest.builder()

      Parameters:
      startObjectRequest - A Consumer that will call methods on StartObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartObject 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 Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException Retryable exception, indicates internal server error.
      • ServiceInternalException Deprecated. To be removed from the model.
      • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.
      • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.
      • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.
      • DataAlreadyExistsException Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.
      • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.
      • AccessDeniedException
      • 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.
      • BackupStorageException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default BackupStorageServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static BackupStorageAsyncClient create()
      Create a BackupStorageAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BackupStorageAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BackupStorageAsyncClient.