com.amazonaws.services.backupgateway.AWSBackupGatewayAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-backupgateway Show documentation
/*
* Copyright 2017-2022 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.backupgateway;
import javax.annotation.Generated;
import com.amazonaws.services.backupgateway.model.*;
/**
* Interface for accessing AWS Backup Gateway 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.backupgateway.AbstractAWSBackupGatewayAsync} instead.
*
*
*
* Backup gateway
*
* Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual
* machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
*
*
* Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the
* resources in your hypervisor.
*
*
* Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have
* backed up your resources, you can view them and restore them like any resource supported by Backup.
*
*
* To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways,
* then choose Create gateway.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBackupGatewayAsync extends AWSBackupGateway {
/**
*
* Associates a backup gateway with your server. After you complete the association process, you can back up and
* restore your VMs through the gateway.
*
*
* @param associateGatewayToServerRequest
* @return A Java Future containing the result of the AssociateGatewayToServer operation returned by the service.
* @sample AWSBackupGatewayAsync.AssociateGatewayToServer
* @see AWS API Documentation
*/
java.util.concurrent.Future associateGatewayToServerAsync(AssociateGatewayToServerRequest associateGatewayToServerRequest);
/**
*
* Associates a backup gateway with your server. After you complete the association process, you can back up and
* restore your VMs through the gateway.
*
*
* @param associateGatewayToServerRequest
* @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 AssociateGatewayToServer operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.AssociateGatewayToServer
* @see AWS API Documentation
*/
java.util.concurrent.Future associateGatewayToServerAsync(AssociateGatewayToServerRequest associateGatewayToServerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the
* AssociateGatewayToServer operation.
*
*
* @param createGatewayRequest
* @return A Java Future containing the result of the CreateGateway operation returned by the service.
* @sample AWSBackupGatewayAsync.CreateGateway
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createGatewayAsync(CreateGatewayRequest createGatewayRequest);
/**
*
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the
* AssociateGatewayToServer operation.
*
*
* @param createGatewayRequest
* @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 CreateGateway operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.CreateGateway
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createGatewayAsync(CreateGatewayRequest createGatewayRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a backup gateway.
*
*
* @param deleteGatewayRequest
* @return A Java Future containing the result of the DeleteGateway operation returned by the service.
* @sample AWSBackupGatewayAsync.DeleteGateway
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest);
/**
*
* Deletes a backup gateway.
*
*
* @param deleteGatewayRequest
* @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 DeleteGateway operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.DeleteGateway
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a hypervisor.
*
*
* @param deleteHypervisorRequest
* @return A Java Future containing the result of the DeleteHypervisor operation returned by the service.
* @sample AWSBackupGatewayAsync.DeleteHypervisor
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteHypervisorAsync(DeleteHypervisorRequest deleteHypervisorRequest);
/**
*
* Deletes a hypervisor.
*
*
* @param deleteHypervisorRequest
* @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 DeleteHypervisor operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.DeleteHypervisor
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteHypervisorAsync(DeleteHypervisorRequest deleteHypervisorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway
* can no longer access the virtual machines on the server.
*
*
* @param disassociateGatewayFromServerRequest
* @return A Java Future containing the result of the DisassociateGatewayFromServer operation returned by the
* service.
* @sample AWSBackupGatewayAsync.DisassociateGatewayFromServer
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateGatewayFromServerAsync(
DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest);
/**
*
* Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway
* can no longer access the virtual machines on the server.
*
*
* @param disassociateGatewayFromServerRequest
* @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 DisassociateGatewayFromServer operation returned by the
* service.
* @sample AWSBackupGatewayAsyncHandler.DisassociateGatewayFromServer
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateGatewayFromServerAsync(
DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Connect to a hypervisor by importing its configuration.
*
*
* @param importHypervisorConfigurationRequest
* @return A Java Future containing the result of the ImportHypervisorConfiguration operation returned by the
* service.
* @sample AWSBackupGatewayAsync.ImportHypervisorConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future importHypervisorConfigurationAsync(
ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest);
/**
*
* Connect to a hypervisor by importing its configuration.
*
*
* @param importHypervisorConfigurationRequest
* @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 ImportHypervisorConfiguration operation returned by the
* service.
* @sample AWSBackupGatewayAsyncHandler.ImportHypervisorConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future importHypervisorConfigurationAsync(
ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list
* is ordered by gateway Amazon Resource Name (ARN).
*
*
* @param listGatewaysRequest
* @return A Java Future containing the result of the ListGateways operation returned by the service.
* @sample AWSBackupGatewayAsync.ListGateways
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listGatewaysAsync(ListGatewaysRequest listGatewaysRequest);
/**
*
* Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list
* is ordered by gateway Amazon Resource Name (ARN).
*
*
* @param listGatewaysRequest
* @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 ListGateways operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.ListGateways
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listGatewaysAsync(ListGatewaysRequest listGatewaysRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists your hypervisors.
*
*
* @param listHypervisorsRequest
* @return A Java Future containing the result of the ListHypervisors operation returned by the service.
* @sample AWSBackupGatewayAsync.ListHypervisors
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listHypervisorsAsync(ListHypervisorsRequest listHypervisorsRequest);
/**
*
* Lists your hypervisors.
*
*
* @param listHypervisorsRequest
* @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 ListHypervisors operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.ListHypervisors
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listHypervisorsAsync(ListHypervisorsRequest listHypervisorsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSBackupGatewayAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
*
*
* @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 AWSBackupGatewayAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists your virtual machines.
*
*
* @param listVirtualMachinesRequest
* @return A Java Future containing the result of the ListVirtualMachines operation returned by the service.
* @sample AWSBackupGatewayAsync.ListVirtualMachines
* @see AWS API Documentation
*/
java.util.concurrent.Future listVirtualMachinesAsync(ListVirtualMachinesRequest listVirtualMachinesRequest);
/**
*
* Lists your virtual machines.
*
*
* @param listVirtualMachinesRequest
* @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 ListVirtualMachines operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.ListVirtualMachines
* @see AWS API Documentation
*/
java.util.concurrent.Future listVirtualMachinesAsync(ListVirtualMachinesRequest listVirtualMachinesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Set the maintenance start time for a gateway.
*
*
* @param putMaintenanceStartTimeRequest
* @return A Java Future containing the result of the PutMaintenanceStartTime operation returned by the service.
* @sample AWSBackupGatewayAsync.PutMaintenanceStartTime
* @see AWS API Documentation
*/
java.util.concurrent.Future putMaintenanceStartTimeAsync(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest);
/**
*
* Set the maintenance start time for a gateway.
*
*
* @param putMaintenanceStartTimeRequest
* @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 PutMaintenanceStartTime operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.PutMaintenanceStartTime
* @see AWS API Documentation
*/
java.util.concurrent.Future putMaintenanceStartTimeAsync(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Tag the resource.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSBackupGatewayAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Tag the 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 AWSBackupGatewayAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
* resources.
*
*
* @param testHypervisorConfigurationRequest
* @return A Java Future containing the result of the TestHypervisorConfiguration operation returned by the service.
* @sample AWSBackupGatewayAsync.TestHypervisorConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future testHypervisorConfigurationAsync(
TestHypervisorConfigurationRequest testHypervisorConfigurationRequest);
/**
*
* Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
* resources.
*
*
* @param testHypervisorConfigurationRequest
* @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 TestHypervisorConfiguration operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.TestHypervisorConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future testHypervisorConfigurationAsync(
TestHypervisorConfigurationRequest testHypervisorConfigurationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes tags from the resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSBackupGatewayAsync.UntagResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes tags from the 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 AWSBackupGatewayAsyncHandler.UntagResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in
* your request.
*
*
* @param updateGatewayInformationRequest
* @return A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
* @sample AWSBackupGatewayAsync.UpdateGatewayInformation
* @see AWS API Documentation
*/
java.util.concurrent.Future updateGatewayInformationAsync(UpdateGatewayInformationRequest updateGatewayInformationRequest);
/**
*
* Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in
* your request.
*
*
* @param updateGatewayInformationRequest
* @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 UpdateGatewayInformation operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.UpdateGatewayInformation
* @see AWS API Documentation
*/
java.util.concurrent.Future updateGatewayInformationAsync(UpdateGatewayInformationRequest updateGatewayInformationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update
* using the Amazon Resource Name (ARN) of the hypervisor in your request.
*
*
* @param updateHypervisorRequest
* @return A Java Future containing the result of the UpdateHypervisor operation returned by the service.
* @sample AWSBackupGatewayAsync.UpdateHypervisor
* @see AWS API Documentation
*/
java.util.concurrent.Future updateHypervisorAsync(UpdateHypervisorRequest updateHypervisorRequest);
/**
*
* Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update
* using the Amazon Resource Name (ARN) of the hypervisor in your request.
*
*
* @param updateHypervisorRequest
* @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 UpdateHypervisor operation returned by the service.
* @sample AWSBackupGatewayAsyncHandler.UpdateHypervisor
* @see AWS API Documentation
*/
java.util.concurrent.Future updateHypervisorAsync(UpdateHypervisorRequest updateHypervisorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}