Interface BackupGatewayAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BackupGatewayAsyncClient extends AwsClient
Service client for accessing AWS Backup Gateway asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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.

  • Field Details

  • Method Details

    • associateGatewayToServer

      default CompletableFuture<AssociateGatewayToServerResponse> associateGatewayToServer(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.

      Parameters:
      associateGatewayToServerRequest -
      Returns:
      A Java Future containing the result of the AssociateGatewayToServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateGatewayToServer

      default CompletableFuture<AssociateGatewayToServerResponse> associateGatewayToServer(Consumer<AssociateGatewayToServerRequest.Builder> 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.


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

      Parameters:
      associateGatewayToServerRequest - A Consumer that will call methods on AssociateGatewayToServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateGatewayToServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGateway

      default CompletableFuture<CreateGatewayResponse> createGateway(CreateGatewayRequest createGatewayRequest)

      Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

      Parameters:
      createGatewayRequest -
      Returns:
      A Java Future containing the result of the CreateGateway operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGateway

      default CompletableFuture<CreateGatewayResponse> createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)

      Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.


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

      Parameters:
      createGatewayRequest - A Consumer that will call methods on CreateGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGateway operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGateway

      default CompletableFuture<DeleteGatewayResponse> deleteGateway(DeleteGatewayRequest deleteGatewayRequest)

      Deletes a backup gateway.

      Parameters:
      deleteGatewayRequest -
      Returns:
      A Java Future containing the result of the DeleteGateway operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGateway

      default CompletableFuture<DeleteGatewayResponse> deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)

      Deletes a backup gateway.


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

      Parameters:
      deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGateway operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHypervisor

      default CompletableFuture<DeleteHypervisorResponse> deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest)

      Deletes a hypervisor.

      Parameters:
      deleteHypervisorRequest -
      Returns:
      A Java Future containing the result of the DeleteHypervisor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHypervisor

      default CompletableFuture<DeleteHypervisorResponse> deleteHypervisor(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest)

      Deletes a hypervisor.


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

      Parameters:
      deleteHypervisorRequest - A Consumer that will call methods on DeleteHypervisorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHypervisor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateGatewayFromServer

      default CompletableFuture<DisassociateGatewayFromServerResponse> disassociateGatewayFromServer(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.

      Parameters:
      disassociateGatewayFromServerRequest -
      Returns:
      A Java Future containing the result of the DisassociateGatewayFromServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateGatewayFromServer

      default CompletableFuture<DisassociateGatewayFromServerResponse> disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> 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.


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

      Parameters:
      disassociateGatewayFromServerRequest - A Consumer that will call methods on DisassociateGatewayFromServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateGatewayFromServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBandwidthRateLimitSchedule

      default CompletableFuture<GetBandwidthRateLimitScheduleResponse> getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest)

      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.

      Parameters:
      getBandwidthRateLimitScheduleRequest -
      Returns:
      A Java Future containing the result of the GetBandwidthRateLimitSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBandwidthRateLimitSchedule

      default CompletableFuture<GetBandwidthRateLimitScheduleResponse> getBandwidthRateLimitSchedule(Consumer<GetBandwidthRateLimitScheduleRequest.Builder> getBandwidthRateLimitScheduleRequest)

      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.


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

      Parameters:
      getBandwidthRateLimitScheduleRequest - A Consumer that will call methods on GetBandwidthRateLimitScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBandwidthRateLimitSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGateway

      default CompletableFuture<GetGatewayResponse> getGateway(GetGatewayRequest getGatewayRequest)

      By providing the ARN (Amazon Resource Name), this API returns the gateway.

      Parameters:
      getGatewayRequest -
      Returns:
      A Java Future containing the result of the GetGateway operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGateway

      default CompletableFuture<GetGatewayResponse> getGateway(Consumer<GetGatewayRequest.Builder> getGatewayRequest)

      By providing the ARN (Amazon Resource Name), this API returns the gateway.


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

      Parameters:
      getGatewayRequest - A Consumer that will call methods on GetGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGateway operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getHypervisor

      default CompletableFuture<GetHypervisorResponse> getHypervisor(GetHypervisorRequest getHypervisorRequest)

      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.

      Parameters:
      getHypervisorRequest -
      Returns:
      A Java Future containing the result of the GetHypervisor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getHypervisor

      default CompletableFuture<GetHypervisorResponse> getHypervisor(Consumer<GetHypervisorRequest.Builder> getHypervisorRequest)

      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.


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

      Parameters:
      getHypervisorRequest - A Consumer that will call methods on GetHypervisorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetHypervisor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getHypervisorPropertyMappings

      default CompletableFuture<GetHypervisorPropertyMappingsResponse> getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest)

      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.

      Parameters:
      getHypervisorPropertyMappingsRequest -
      Returns:
      A Java Future containing the result of the GetHypervisorPropertyMappings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getHypervisorPropertyMappings

      default CompletableFuture<GetHypervisorPropertyMappingsResponse> getHypervisorPropertyMappings(Consumer<GetHypervisorPropertyMappingsRequest.Builder> getHypervisorPropertyMappingsRequest)

      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.


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

      Parameters:
      getHypervisorPropertyMappingsRequest - A Consumer that will call methods on GetHypervisorPropertyMappingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetHypervisorPropertyMappings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVirtualMachine

      default CompletableFuture<GetVirtualMachineResponse> getVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest)

      By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

      Parameters:
      getVirtualMachineRequest -
      Returns:
      A Java Future containing the result of the GetVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVirtualMachine

      default CompletableFuture<GetVirtualMachineResponse> getVirtualMachine(Consumer<GetVirtualMachineRequest.Builder> getVirtualMachineRequest)

      By providing the ARN (Amazon Resource Name), this API returns the virtual machine.


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

      Parameters:
      getVirtualMachineRequest - A Consumer that will call methods on GetVirtualMachineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importHypervisorConfiguration

      default CompletableFuture<ImportHypervisorConfigurationResponse> importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)

      Connect to a hypervisor by importing its configuration.

      Parameters:
      importHypervisorConfigurationRequest -
      Returns:
      A Java Future containing the result of the ImportHypervisorConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importHypervisorConfiguration

      default CompletableFuture<ImportHypervisorConfigurationResponse> importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest)

      Connect to a hypervisor by importing its configuration.


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

      Parameters:
      importHypervisorConfigurationRequest - A Consumer that will call methods on ImportHypervisorConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportHypervisorConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways(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).

      Parameters:
      listGatewaysRequest -
      Returns:
      A Java Future containing the result of the ListGateways operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways(Consumer<ListGatewaysRequest.Builder> 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).


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

      Parameters:
      listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGateways operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)

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

      Parameters:
      listGatewaysRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)

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


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

      Parameters:
      listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHypervisors

      default CompletableFuture<ListHypervisorsResponse> listHypervisors(ListHypervisorsRequest listHypervisorsRequest)

      Lists your hypervisors.

      Parameters:
      listHypervisorsRequest -
      Returns:
      A Java Future containing the result of the ListHypervisors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHypervisors

      default CompletableFuture<ListHypervisorsResponse> listHypervisors(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)

      Lists your hypervisors.


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

      Parameters:
      listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHypervisors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHypervisorsPaginator

      default ListHypervisorsPublisher listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest)

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

      Parameters:
      listHypervisorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHypervisorsPaginator

      default ListHypervisorsPublisher listHypervisorsPaginator(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)

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


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

      Parameters:
      listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

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

      Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVirtualMachines

      default CompletableFuture<ListVirtualMachinesResponse> listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest)

      Lists your virtual machines.

      Parameters:
      listVirtualMachinesRequest -
      Returns:
      A Java Future containing the result of the ListVirtualMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVirtualMachines

      default CompletableFuture<ListVirtualMachinesResponse> listVirtualMachines(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)

      Lists your virtual machines.


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

      Parameters:
      listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVirtualMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVirtualMachinesPaginator

      default ListVirtualMachinesPublisher listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest)

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

      Parameters:
      listVirtualMachinesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVirtualMachinesPaginator

      default ListVirtualMachinesPublisher listVirtualMachinesPaginator(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)

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


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

      Parameters:
      listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBandwidthRateLimitSchedule

      default CompletableFuture<PutBandwidthRateLimitScheduleResponse> putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)

      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.

      Parameters:
      putBandwidthRateLimitScheduleRequest -
      Returns:
      A Java Future containing the result of the PutBandwidthRateLimitSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBandwidthRateLimitSchedule

      default CompletableFuture<PutBandwidthRateLimitScheduleResponse> putBandwidthRateLimitSchedule(Consumer<PutBandwidthRateLimitScheduleRequest.Builder> putBandwidthRateLimitScheduleRequest)

      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.


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

      Parameters:
      putBandwidthRateLimitScheduleRequest - A Consumer that will call methods on PutBandwidthRateLimitScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBandwidthRateLimitSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putHypervisorPropertyMappings

      default CompletableFuture<PutHypervisorPropertyMappingsResponse> putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest)

      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.

      Parameters:
      putHypervisorPropertyMappingsRequest -
      Returns:
      A Java Future containing the result of the PutHypervisorPropertyMappings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putHypervisorPropertyMappings

      default CompletableFuture<PutHypervisorPropertyMappingsResponse> putHypervisorPropertyMappings(Consumer<PutHypervisorPropertyMappingsRequest.Builder> putHypervisorPropertyMappingsRequest)

      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.


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

      Parameters:
      putHypervisorPropertyMappingsRequest - A Consumer that will call methods on PutHypervisorPropertyMappingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutHypervisorPropertyMappings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMaintenanceStartTime

      default CompletableFuture<PutMaintenanceStartTimeResponse> putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)

      Set the maintenance start time for a gateway.

      Parameters:
      putMaintenanceStartTimeRequest -
      Returns:
      A Java Future containing the result of the PutMaintenanceStartTime operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMaintenanceStartTime

      default CompletableFuture<PutMaintenanceStartTimeResponse> putMaintenanceStartTime(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest)

      Set the maintenance start time for a gateway.


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

      Parameters:
      putMaintenanceStartTimeRequest - A Consumer that will call methods on PutMaintenanceStartTimeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutMaintenanceStartTime operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startVirtualMachinesMetadataSync

      default CompletableFuture<StartVirtualMachinesMetadataSyncResponse> startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest)

      This action sends a request to sync metadata across the specified virtual machines.

      Parameters:
      startVirtualMachinesMetadataSyncRequest -
      Returns:
      A Java Future containing the result of the StartVirtualMachinesMetadataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startVirtualMachinesMetadataSync

      default CompletableFuture<StartVirtualMachinesMetadataSyncResponse> startVirtualMachinesMetadataSync(Consumer<StartVirtualMachinesMetadataSyncRequest.Builder> startVirtualMachinesMetadataSyncRequest)

      This action sends a request to sync metadata across the specified virtual machines.


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

      Parameters:
      startVirtualMachinesMetadataSyncRequest - A Consumer that will call methods on StartVirtualMachinesMetadataSyncRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartVirtualMachinesMetadataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Tag the resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

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

      Tag the resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testHypervisorConfiguration

      default CompletableFuture<TestHypervisorConfigurationResponse> testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)

      Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

      Parameters:
      testHypervisorConfigurationRequest -
      Returns:
      A Java Future containing the result of the TestHypervisorConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testHypervisorConfiguration

      default CompletableFuture<TestHypervisorConfigurationResponse> testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest)

      Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.


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

      Parameters:
      testHypervisorConfigurationRequest - A Consumer that will call methods on TestHypervisorConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TestHypervisorConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from the resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

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

      Removes tags from the resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewayInformation

      default CompletableFuture<UpdateGatewayInformationResponse> updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)

      Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

      Parameters:
      updateGatewayInformationRequest -
      Returns:
      A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewayInformation

      default CompletableFuture<UpdateGatewayInformationResponse> updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest)

      Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.


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

      Parameters:
      updateGatewayInformationRequest - A Consumer that will call methods on UpdateGatewayInformationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewaySoftwareNow

      default CompletableFuture<UpdateGatewaySoftwareNowResponse> updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)

      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.

      Parameters:
      updateGatewaySoftwareNowRequest -
      Returns:
      A Java Future containing the result of the UpdateGatewaySoftwareNow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewaySoftwareNow

      default CompletableFuture<UpdateGatewaySoftwareNowResponse> updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest)

      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.


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

      Parameters:
      updateGatewaySoftwareNowRequest - A Consumer that will call methods on UpdateGatewaySoftwareNowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGatewaySoftwareNow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHypervisor

      default CompletableFuture<UpdateHypervisorResponse> updateHypervisor(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.

      Parameters:
      updateHypervisorRequest -
      Returns:
      A Java Future containing the result of the UpdateHypervisor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHypervisor

      default CompletableFuture<UpdateHypervisorResponse> updateHypervisor(Consumer<UpdateHypervisorRequest.Builder> 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.


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

      Parameters:
      updateHypervisorRequest - A Consumer that will call methods on UpdateHypervisorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHypervisor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The operation did not succeed because a validation error occurred.
      • ConflictException The operation cannot proceed because it is not supported.
      • InternalServerException The operation did not succeed because an internal error occurred. Try again later.
      • AccessDeniedException The operation cannot proceed because you have insufficient permissions.
      • ResourceNotFoundException A resource that is required for the action wasn't found.
      • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default BackupGatewayServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static BackupGatewayAsyncClient create()
      Create a BackupGatewayAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BackupGatewayAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BackupGatewayAsyncClient.