/* * Copyright 2018-2023 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 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* 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
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the
* AssociateGatewayToServer
operation.
*
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the
* AssociateGatewayToServer
operation.
*
* 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* 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* 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* 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* 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* 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* Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth * rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth * rate limit schedule. *
* * @param getBandwidthRateLimitScheduleRequest * @return A Java Future containing the result of the GetBandwidthRateLimitSchedule operation returned by the * service. * @sample AWSBackupGatewayAsync.GetBandwidthRateLimitSchedule * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth * rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth * rate limit schedule. *
* * @param getBandwidthRateLimitScheduleRequest * @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 GetBandwidthRateLimitSchedule operation returned by the * service. * @sample AWSBackupGatewayAsyncHandler.GetBandwidthRateLimitSchedule * @see AWS API Documentation */ java.util.concurrent.Future* By providing the ARN (Amazon Resource Name), this API returns the gateway. *
* * @param getGatewayRequest * @return A Java Future containing the result of the GetGateway operation returned by the service. * @sample AWSBackupGatewayAsync.GetGateway * @see AWS API * Documentation */ java.util.concurrent.Future* By providing the ARN (Amazon Resource Name), this API returns the gateway. *
* * @param getGatewayRequest * @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 GetGateway operation returned by the service. * @sample AWSBackupGatewayAsyncHandler.GetGateway * @see AWS API * Documentation */ java.util.concurrent.Future* This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor * is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them. *
* * @param getHypervisorRequest * @return A Java Future containing the result of the GetHypervisor operation returned by the service. * @sample AWSBackupGatewayAsync.GetHypervisor * @see AWS * API Documentation */ java.util.concurrent.Future* This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor * is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them. *
* * @param getHypervisorRequest * @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 GetHypervisor operation returned by the service. * @sample AWSBackupGatewayAsyncHandler.GetHypervisor * @see AWS * API Documentation */ java.util.concurrent.Future* This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays * the relationship of entity properties available from the on-premises hypervisor to the properties available in * Amazon Web Services. *
* * @param getHypervisorPropertyMappingsRequest * @return A Java Future containing the result of the GetHypervisorPropertyMappings operation returned by the * service. * @sample AWSBackupGatewayAsync.GetHypervisorPropertyMappings * @see AWS API Documentation */ java.util.concurrent.Future* This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays * the relationship of entity properties available from the on-premises hypervisor to the properties available in * Amazon Web Services. *
* * @param getHypervisorPropertyMappingsRequest * @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 GetHypervisorPropertyMappings operation returned by the * service. * @sample AWSBackupGatewayAsyncHandler.GetHypervisorPropertyMappings * @see AWS API Documentation */ java.util.concurrent.Future* By providing the ARN (Amazon Resource Name), this API returns the virtual machine. *
* * @param getVirtualMachineRequest * @return A Java Future containing the result of the GetVirtualMachine operation returned by the service. * @sample AWSBackupGatewayAsync.GetVirtualMachine * @see AWS API Documentation */ java.util.concurrent.Future* By providing the ARN (Amazon Resource Name), this API returns the virtual machine. *
* * @param getVirtualMachineRequest * @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 GetVirtualMachine operation returned by the service. * @sample AWSBackupGatewayAsyncHandler.GetVirtualMachine * @see AWS API Documentation */ java.util.concurrent.Future* 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* 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* 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* 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* 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* 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* 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* 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* 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* 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* This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a * bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a * gateway's bandwidth rate limit schedule. *
* * @param putBandwidthRateLimitScheduleRequest * @return A Java Future containing the result of the PutBandwidthRateLimitSchedule operation returned by the * service. * @sample AWSBackupGatewayAsync.PutBandwidthRateLimitSchedule * @see AWS API Documentation */ java.util.concurrent.Future* This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a * bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a * gateway's bandwidth rate limit schedule. *
* * @param putBandwidthRateLimitScheduleRequest * @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 PutBandwidthRateLimitSchedule operation returned by the * service. * @sample AWSBackupGatewayAsyncHandler.PutBandwidthRateLimitSchedule * @see AWS API Documentation */ java.util.concurrent.Future* This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the * relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon * Web Services. *
* * @param putHypervisorPropertyMappingsRequest * @return A Java Future containing the result of the PutHypervisorPropertyMappings operation returned by the * service. * @sample AWSBackupGatewayAsync.PutHypervisorPropertyMappings * @see AWS API Documentation */ java.util.concurrent.Future* This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the * relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon * Web Services. *
* * @param putHypervisorPropertyMappingsRequest * @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 PutHypervisorPropertyMappings operation returned by the * service. * @sample AWSBackupGatewayAsyncHandler.PutHypervisorPropertyMappings * @see AWS API Documentation */ java.util.concurrent.Future* 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* 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* This action sends a request to sync metadata across the specified virtual machines. *
* * @param startVirtualMachinesMetadataSyncRequest * @return A Java Future containing the result of the StartVirtualMachinesMetadataSync operation returned by the * service. * @sample AWSBackupGatewayAsync.StartVirtualMachinesMetadataSync * @see AWS API Documentation */ java.util.concurrent.Future* This action sends a request to sync metadata across the specified virtual machines. *
* * @param startVirtualMachinesMetadataSyncRequest * @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 StartVirtualMachinesMetadataSync operation returned by the * service. * @sample AWSBackupGatewayAsyncHandler.StartVirtualMachinesMetadataSync * @see AWS API Documentation */ java.util.concurrent.Future* 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* 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* 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* 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* 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* 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* 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* 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* Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. *
*
* When you make this request, you get a 200 OK
success response immediately. However, it might take
* some time for the update to complete.
*
* Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. *
*
* When you make this request, you get a 200 OK
success response immediately. However, it might take
* some time for the update to complete.
*
* 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* 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