@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DocDbElasticAsyncClient extends AwsClient
builder()
method.
The new Amazon Elastic DocumentDB service endpoint.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static DocDbElasticAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DocDbElasticAsyncClient. |
static DocDbElasticAsyncClient |
create()
Create a
DocDbElasticAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateClusterResponse> |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
|
default CompletableFuture<CreateClusterResponse> |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
|
default CompletableFuture<CreateClusterSnapshotResponse> |
createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)
Creates a snapshot of a cluster.
|
default CompletableFuture<CreateClusterSnapshotResponse> |
createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a snapshot of a cluster.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Delete a Elastic DocumentDB cluster.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Delete a Elastic DocumentDB cluster.
|
default CompletableFuture<DeleteClusterSnapshotResponse> |
deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)
Delete a Elastic DocumentDB snapshot.
|
default CompletableFuture<DeleteClusterSnapshotResponse> |
deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
Delete a Elastic DocumentDB snapshot.
|
default CompletableFuture<GetClusterResponse> |
getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)
Returns information about a specific Elastic DocumentDB cluster.
|
default CompletableFuture<GetClusterResponse> |
getCluster(GetClusterRequest getClusterRequest)
Returns information about a specific Elastic DocumentDB cluster.
|
default CompletableFuture<GetClusterSnapshotResponse> |
getClusterSnapshot(Consumer<GetClusterSnapshotRequest.Builder> getClusterSnapshotRequest)
Returns information about a specific Elastic DocumentDB snapshot
|
default CompletableFuture<GetClusterSnapshotResponse> |
getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest)
Returns information about a specific Elastic DocumentDB snapshot
|
default CompletableFuture<ListClustersResponse> |
listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns information about provisioned Elastic DocumentDB clusters.
|
default CompletableFuture<ListClustersResponse> |
listClusters(ListClustersRequest listClustersRequest)
Returns information about provisioned Elastic DocumentDB clusters.
|
default CompletableFuture<ListClusterSnapshotsResponse> |
listClusterSnapshots(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)
Returns information about Elastic DocumentDB snapshots for a specified cluster.
|
default CompletableFuture<ListClusterSnapshotsResponse> |
listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest)
Returns information about Elastic DocumentDB snapshots for a specified cluster.
|
default ListClusterSnapshotsPublisher |
listClusterSnapshotsPaginator(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)
Returns information about Elastic DocumentDB snapshots for a specified cluster.
|
default ListClusterSnapshotsPublisher |
listClusterSnapshotsPaginator(ListClusterSnapshotsRequest listClusterSnapshotsRequest)
Returns information about Elastic DocumentDB snapshots for a specified cluster.
|
default ListClustersPublisher |
listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns information about provisioned Elastic DocumentDB clusters.
|
default ListClustersPublisher |
listClustersPaginator(ListClustersRequest listClustersRequest)
Returns information about provisioned Elastic DocumentDB clusters.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on a Elastic DocumentDB resource
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a Elastic DocumentDB resource
|
default CompletableFuture<RestoreClusterFromSnapshotResponse> |
restoreClusterFromSnapshot(Consumer<RestoreClusterFromSnapshotRequest.Builder> restoreClusterFromSnapshotRequest)
Restores a Elastic DocumentDB cluster from a snapshot.
|
default CompletableFuture<RestoreClusterFromSnapshotResponse> |
restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)
Restores a Elastic DocumentDB cluster from a snapshot.
|
default DocDbElasticServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds metadata tags to a Elastic DocumentDB resource
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a Elastic DocumentDB resource
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes metadata tags to a Elastic DocumentDB resource
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags to a Elastic DocumentDB resource
|
default CompletableFuture<UpdateClusterResponse> |
updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
Modifies a Elastic DocumentDB cluster.
|
default CompletableFuture<UpdateClusterResponse> |
updateCluster(UpdateClusterRequest updateClusterRequest)
Modifies a Elastic DocumentDB cluster.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)
Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
createClusterRequest - 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()
createClusterRequest - A Consumer that will call methods on CreateClusterInput.Builder to create a request.default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a snapshot of a cluster.
createClusterSnapshotRequest - 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()
createClusterSnapshotRequest - A Consumer that will call methods on CreateClusterSnapshotInput.Builder to create a
request.default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)
Delete a Elastic DocumentDB cluster.
deleteClusterRequest - 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()
deleteClusterRequest - A Consumer that will call methods on DeleteClusterInput.Builder to create a request.default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
Delete a Elastic DocumentDB snapshot.
deleteClusterSnapshotRequest - 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()
deleteClusterSnapshotRequest - A Consumer that will call methods on DeleteClusterSnapshotInput.Builder to create a
request.default CompletableFuture<GetClusterResponse> getCluster(GetClusterRequest getClusterRequest)
Returns information about a specific Elastic DocumentDB cluster.
getClusterRequest - 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()
getClusterRequest - A Consumer that will call methods on GetClusterInput.Builder to create a request.default CompletableFuture<GetClusterSnapshotResponse> getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest)
Returns information about a specific Elastic DocumentDB snapshot
getClusterSnapshotRequest - 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()
getClusterSnapshotRequest - A Consumer that will call methods on GetClusterSnapshotInput.Builder to create a request.default CompletableFuture<ListClusterSnapshotsResponse> listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest)
Returns information about Elastic DocumentDB snapshots for a specified cluster.
listClusterSnapshotsRequest - 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()
listClusterSnapshotsRequest - A Consumer that will call methods on ListClusterSnapshotsInput.Builder to create a
request.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.
listClusterSnapshotsRequest - 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()
listClusterSnapshotsRequest - A Consumer that will call methods on ListClusterSnapshotsInput.Builder to create a
request.default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)
Returns information about provisioned Elastic DocumentDB clusters.
listClustersRequest - 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()
listClustersRequest - A Consumer that will call methods on ListClustersInput.Builder to create a request.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.
listClustersRequest - 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()
listClustersRequest - A Consumer that will call methods on ListClustersInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a Elastic DocumentDB resource
listTagsForResourceRequest - 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<RestoreClusterFromSnapshotResponse> restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)
Restores a Elastic DocumentDB cluster from a snapshot.
restoreClusterFromSnapshotRequest - 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()
restoreClusterFromSnapshotRequest - A Consumer that will call methods on RestoreClusterFromSnapshotInput.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a Elastic DocumentDB resource
tagResourceRequest - 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()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags to a Elastic DocumentDB resource
untagResourceRequest - 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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
updateClusterRequest - 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()
updateClusterRequest - A Consumer that will call methods on UpdateClusterInput.Builder to create a request.default DocDbElasticServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic DocDbElasticAsyncClient create()
DocDbElasticAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DocDbElasticAsyncClientBuilder builder()
DocDbElasticAsyncClient.Copyright © 2023. All rights reserved.