Package software.amazon.awssdk.services.docdbelastic

Interface DocDbElasticAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DocDbElasticAsyncClient extends AwsClient
Service client for accessing DocDB Elastic asynchronously. This can be created using the static builder() method.

The new Amazon Elastic DocumentDB service endpoint.

  • Field Details

  • Method Details

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

      Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

      Parameters:
      createClusterRequest -
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ServiceQuotaExceededException The service quota for the action was exceeded.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

      Creates a new Elastic DocumentDB cluster and returns its Cluster structure.


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

      Parameters:
      createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ServiceQuotaExceededException The service quota for the action was exceeded.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createClusterSnapshot

      default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)

      Creates a snapshot of a cluster.

      Parameters:
      createClusterSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ServiceQuotaExceededException The service quota for the action was exceeded.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createClusterSnapshot

      default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)

      Creates a snapshot of a cluster.


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

      Parameters:
      createClusterSnapshotRequest - A Consumer that will call methods on CreateClusterSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ServiceQuotaExceededException The service quota for the action was exceeded.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)

      Delete a Elastic DocumentDB cluster.

      Parameters:
      deleteClusterRequest -
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

      Delete a Elastic DocumentDB cluster.


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

      Parameters:
      deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteClusterSnapshot

      default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)

      Delete a Elastic DocumentDB snapshot.

      Parameters:
      deleteClusterSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteClusterSnapshot

      default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)

      Delete a Elastic DocumentDB snapshot.


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

      Parameters:
      deleteClusterSnapshotRequest - A Consumer that will call methods on DeleteClusterSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCluster

      default CompletableFuture<GetClusterResponse> getCluster(GetClusterRequest getClusterRequest)

      Returns information about a specific Elastic DocumentDB cluster.

      Parameters:
      getClusterRequest -
      Returns:
      A Java Future containing the result of the GetCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCluster

      default CompletableFuture<GetClusterResponse> getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)

      Returns information about a specific Elastic DocumentDB cluster.


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

      Parameters:
      getClusterRequest - A Consumer that will call methods on GetClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getClusterSnapshot

      default CompletableFuture<GetClusterSnapshotResponse> getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest)

      Returns information about a specific Elastic DocumentDB snapshot

      Parameters:
      getClusterSnapshotRequest -
      Returns:
      A Java Future containing the result of the GetClusterSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getClusterSnapshot

      default CompletableFuture<GetClusterSnapshotResponse> getClusterSnapshot(Consumer<GetClusterSnapshotRequest.Builder> getClusterSnapshotRequest)

      Returns information about a specific Elastic DocumentDB snapshot


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

      Parameters:
      getClusterSnapshotRequest - A Consumer that will call methods on GetClusterSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetClusterSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterSnapshots

      default CompletableFuture<ListClusterSnapshotsResponse> listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest)

      Returns information about Elastic DocumentDB snapshots for a specified cluster.

      Parameters:
      listClusterSnapshotsRequest -
      Returns:
      A Java Future containing the result of the ListClusterSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterSnapshots

      default CompletableFuture<ListClusterSnapshotsResponse> listClusterSnapshots(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)

      Returns information about Elastic DocumentDB snapshots for a specified cluster.


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

      Parameters:
      listClusterSnapshotsRequest - A Consumer that will call methods on ListClusterSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusterSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterSnapshotsPaginator

      default ListClusterSnapshotsPublisher listClusterSnapshotsPaginator(ListClusterSnapshotsRequest listClusterSnapshotsRequest)

      Returns information about Elastic DocumentDB snapshots for a specified cluster.


      This is a variant of listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) 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.docdbelastic.paginators.ListClusterSnapshotsPublisher publisher = client.listClusterSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsPublisher publisher = client.listClusterSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse 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 listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation.

      Parameters:
      listClusterSnapshotsRequest -
      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.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterSnapshotsPaginator

      default ListClusterSnapshotsPublisher listClusterSnapshotsPaginator(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)

      Returns information about Elastic DocumentDB snapshots for a specified cluster.


      This is a variant of listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) 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.docdbelastic.paginators.ListClusterSnapshotsPublisher publisher = client.listClusterSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsPublisher publisher = client.listClusterSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse 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 listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation.

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

      Parameters:
      listClusterSnapshotsRequest - A Consumer that will call methods on ListClusterSnapshotsRequest.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.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

      Returns information about provisioned Elastic DocumentDB clusters.

      Parameters:
      listClustersRequest -
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)

      Returns information about provisioned Elastic DocumentDB clusters.


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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)

      Returns information about provisioned Elastic DocumentDB clusters.


      This is a variant of listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) 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.docdbelastic.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.docdbelastic.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse 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 listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation.

      Parameters:
      listClustersRequest -
      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.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)

      Returns information about provisioned Elastic DocumentDB clusters.


      This is a variant of listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) 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.docdbelastic.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.docdbelastic.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse 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 listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation.

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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.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.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags on a Elastic DocumentDB resource

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags on a Elastic DocumentDB resource


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreClusterFromSnapshot

      default CompletableFuture<RestoreClusterFromSnapshotResponse> restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)

      Restores a Elastic DocumentDB cluster from a snapshot.

      Parameters:
      restoreClusterFromSnapshotRequest -
      Returns:
      A Java Future containing the result of the RestoreClusterFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ServiceQuotaExceededException The service quota for the action was exceeded.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreClusterFromSnapshot

      default CompletableFuture<RestoreClusterFromSnapshotResponse> restoreClusterFromSnapshot(Consumer<RestoreClusterFromSnapshotRequest.Builder> restoreClusterFromSnapshotRequest)

      Restores a Elastic DocumentDB cluster from a snapshot.


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

      Parameters:
      restoreClusterFromSnapshotRequest - A Consumer that will call methods on RestoreClusterFromSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestoreClusterFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ServiceQuotaExceededException The service quota for the action was exceeded.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds metadata tags to a Elastic DocumentDB resource

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds metadata tags to a Elastic DocumentDB resource


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes metadata tags to a Elastic DocumentDB resource

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes metadata tags to a Elastic DocumentDB resource


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)

      Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

      Parameters:
      updateClusterRequest -
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)

      Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window


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

      Parameters:
      updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.
      • ValidationException A structure defining a validation exception.
      • ConflictException There was an access conflict.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The specified resource could not be located.
      • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.
      • 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.
      • DocDbElasticException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default DocDbElasticServiceClientConfiguration 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 DocDbElasticAsyncClient create()
      Create a DocDbElasticAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static DocDbElasticAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a DocDbElasticAsyncClient.