com.amazonaws.services.docdbelastic.AmazonDocDBElasticAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-docdbelastic Show documentation
The AWS Java SDK for Amazon DocumentDB Elastic Clusters module holds the client classes that are used for communicating with Amazon DocumentDB Elastic Clusters Service
There is a newer version: 1.12.778
Show newest version
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.docdbelastic;

import javax.annotation.Generated;

import com.amazonaws.services.docdbelastic.model.*;

/**
 * Interface for accessing DocDB Elastic asynchronously. Each asynchronous method will return a Java Future object
 * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
 * notification when an asynchronous operation completes.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.docdbelastic.AbstractAmazonDocDBElasticAsync} instead.
 * 
 * 
 * 

 * Amazon DocumentDB elastic clusters
 * 

 * Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of
 * storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB
 * elastic-clusters by eliminating the need to choose, manage or upgrade instances.
 * 
 * 
 * Amazon DocumentDB elastic-clusters were created to:
 * 
 * 
 * 
 * 
 * provide a solution for customers looking for a database that provides virtually limitless scale with rich query
 * capabilities and MongoDB API compatibility.
 * 
 * 
 * 
 * 
 * give customers higher connection limits, and to reduce downtime from patching.
 * 
 * 
 * 
 * 
 * continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.
 * 
 * 
 * 
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDocDBElasticAsync extends AmazonDocDBElastic {

    /**
     * 
     * Copies a snapshot of an elastic cluster.
     * 
     * 
     * @param copyClusterSnapshotRequest
     * @return A Java Future containing the result of the CopyClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsync.CopyClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future copyClusterSnapshotAsync(CopyClusterSnapshotRequest copyClusterSnapshotRequest);

    /**
     * 
     * Copies a snapshot of an elastic cluster.
     * 
     * 
     * @param copyClusterSnapshotRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the CopyClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.CopyClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future copyClusterSnapshotAsync(CopyClusterSnapshotRequest copyClusterSnapshotRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
     * 
     * 
     * @param createClusterRequest
     * @return A Java Future containing the result of the CreateCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsync.CreateCluster
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future createClusterAsync(CreateClusterRequest createClusterRequest);

    /**
     * 
     * Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
     * 
     * 
     * @param createClusterRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the CreateCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.CreateCluster
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future createClusterAsync(CreateClusterRequest createClusterRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Creates a snapshot of an elastic cluster.
     * 
     * 
     * @param createClusterSnapshotRequest
     * @return A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsync.CreateClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future createClusterSnapshotAsync(CreateClusterSnapshotRequest createClusterSnapshotRequest);

    /**
     * 
     * Creates a snapshot of an elastic cluster.
     * 
     * 
     * @param createClusterSnapshotRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.CreateClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future createClusterSnapshotAsync(CreateClusterSnapshotRequest createClusterSnapshotRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Delete an elastic cluster.
     * 
     * 
     * @param deleteClusterRequest
     * @return A Java Future containing the result of the DeleteCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsync.DeleteCluster
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future deleteClusterAsync(DeleteClusterRequest deleteClusterRequest);

    /**
     * 
     * Delete an elastic cluster.
     * 
     * 
     * @param deleteClusterRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the DeleteCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.DeleteCluster
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future deleteClusterAsync(DeleteClusterRequest deleteClusterRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Delete an elastic cluster snapshot.
     * 
     * 
     * @param deleteClusterSnapshotRequest
     * @return A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsync.DeleteClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest);

    /**
     * 
     * Delete an elastic cluster snapshot.
     * 
     * 
     * @param deleteClusterSnapshotRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.DeleteClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Returns information about a specific elastic cluster.
     * 
     * 
     * @param getClusterRequest
     * @return A Java Future containing the result of the GetCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsync.GetCluster
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future getClusterAsync(GetClusterRequest getClusterRequest);

    /**
     * 
     * Returns information about a specific elastic cluster.
     * 
     * 
     * @param getClusterRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the GetCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.GetCluster
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future getClusterAsync(GetClusterRequest getClusterRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Returns information about a specific elastic cluster snapshot
     * 
     * 
     * @param getClusterSnapshotRequest
     * @return A Java Future containing the result of the GetClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsync.GetClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future getClusterSnapshotAsync(GetClusterSnapshotRequest getClusterSnapshotRequest);

    /**
     * 
     * Returns information about a specific elastic cluster snapshot
     * 
     * 
     * @param getClusterSnapshotRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the GetClusterSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.GetClusterSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future getClusterSnapshotAsync(GetClusterSnapshotRequest getClusterSnapshotRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Returns information about snapshots for a specified elastic cluster.
     * 
     * 
     * @param listClusterSnapshotsRequest
     * @return A Java Future containing the result of the ListClusterSnapshots operation returned by the service.
     * @sample AmazonDocDBElasticAsync.ListClusterSnapshots
     * @see AWS API Documentation
     */
    java.util.concurrent.Future listClusterSnapshotsAsync(ListClusterSnapshotsRequest listClusterSnapshotsRequest);

    /**
     * 
     * Returns information about snapshots for a specified elastic cluster.
     * 
     * 
     * @param listClusterSnapshotsRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the ListClusterSnapshots operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.ListClusterSnapshots
     * @see AWS API Documentation
     */
    java.util.concurrent.Future listClusterSnapshotsAsync(ListClusterSnapshotsRequest listClusterSnapshotsRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Returns information about provisioned Amazon DocumentDB elastic clusters.
     * 
     * 
     * @param listClustersRequest
     * @return A Java Future containing the result of the ListClusters operation returned by the service.
     * @sample AmazonDocDBElasticAsync.ListClusters
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future listClustersAsync(ListClustersRequest listClustersRequest);

    /**
     * 
     * Returns information about provisioned Amazon DocumentDB elastic clusters.
     * 
     * 
     * @param listClustersRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the ListClusters operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.ListClusters
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future listClustersAsync(ListClustersRequest listClustersRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Lists all tags on a elastic cluster resource
     * 
     * 
     * @param listTagsForResourceRequest
     * @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
     * @sample AmazonDocDBElasticAsync.ListTagsForResource
     * @see AWS API Documentation
     */
    java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);

    /**
     * 
     * Lists all tags on a elastic cluster resource
     * 
     * 
     * @param listTagsForResourceRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.ListTagsForResource
     * @see AWS API Documentation
     */
    java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Restores an elastic cluster from a snapshot.
     * 
     * 
     * @param restoreClusterFromSnapshotRequest
     * @return A Java Future containing the result of the RestoreClusterFromSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsync.RestoreClusterFromSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future restoreClusterFromSnapshotAsync(
            RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest);

    /**
     * 
     * Restores an elastic cluster from a snapshot.
     * 
     * 
     * @param restoreClusterFromSnapshotRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the RestoreClusterFromSnapshot operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.RestoreClusterFromSnapshot
     * @see AWS API Documentation
     */
    java.util.concurrent.Future restoreClusterFromSnapshotAsync(
            RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Restarts the stopped elastic cluster that is specified by clusterARN.
     * 
     * 
     * @param startClusterRequest
     * @return A Java Future containing the result of the StartCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsync.StartCluster
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future startClusterAsync(StartClusterRequest startClusterRequest);

    /**
     * 
     * Restarts the stopped elastic cluster that is specified by clusterARN.
     * 
     * 
     * @param startClusterRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the StartCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.StartCluster
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future startClusterAsync(StartClusterRequest startClusterRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in
     * the available state.
     * 
     * 
     * @param stopClusterRequest
     * @return A Java Future containing the result of the StopCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsync.StopCluster
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future stopClusterAsync(StopClusterRequest stopClusterRequest);

    /**
     * 
     * Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in
     * the available state.
     * 
     * 
     * @param stopClusterRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the StopCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.StopCluster
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future stopClusterAsync(StopClusterRequest stopClusterRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Adds metadata tags to an elastic cluster resource
     * 
     * 
     * @param tagResourceRequest
     * @return A Java Future containing the result of the TagResource operation returned by the service.
     * @sample AmazonDocDBElasticAsync.TagResource
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);

    /**
     * 
     * Adds metadata tags to an elastic cluster resource
     * 
     * 
     * @param tagResourceRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the TagResource operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.TagResource
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Removes metadata tags from an elastic cluster resource
     * 
     * 
     * @param untagResourceRequest
     * @return A Java Future containing the result of the UntagResource operation returned by the service.
     * @sample AmazonDocDBElasticAsync.UntagResource
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);

    /**
     * 
     * Removes metadata tags from an elastic cluster resource
     * 
     * 
     * @param untagResourceRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the UntagResource operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.UntagResource
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and
     * setting up a backup window and maintenance window
     * 
     * 
     * @param updateClusterRequest
     * @return A Java Future containing the result of the UpdateCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsync.UpdateCluster
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future updateClusterAsync(UpdateClusterRequest updateClusterRequest);

    /**
     * 
     * Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and
     * setting up a backup window and maintenance window
     * 
     * 
     * @param updateClusterRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the UpdateCluster operation returned by the service.
     * @sample AmazonDocDBElasticAsyncHandler.UpdateCluster
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future updateClusterAsync(UpdateClusterRequest updateClusterRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

}