Interface BackupGatewayClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateGatewayToServerResponse
associateGatewayToServer
(Consumer<AssociateGatewayToServerRequest.Builder> associateGatewayToServerRequest) Associates a backup gateway with your server.default AssociateGatewayToServerResponse
associateGatewayToServer
(AssociateGatewayToServerRequest associateGatewayToServerRequest) Associates a backup gateway with your server.static BackupGatewayClientBuilder
builder()
Create a builder that can be used to configure and create aBackupGatewayClient
.static BackupGatewayClient
create()
Create aBackupGatewayClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateGatewayResponse
createGateway
(Consumer<CreateGatewayRequest.Builder> createGatewayRequest) Creates a backup gateway.default CreateGatewayResponse
createGateway
(CreateGatewayRequest createGatewayRequest) Creates a backup gateway.default DeleteGatewayResponse
deleteGateway
(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) Deletes a backup gateway.default DeleteGatewayResponse
deleteGateway
(DeleteGatewayRequest deleteGatewayRequest) Deletes a backup gateway.default DeleteHypervisorResponse
deleteHypervisor
(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest) Deletes a hypervisor.default DeleteHypervisorResponse
deleteHypervisor
(DeleteHypervisorRequest deleteHypervisorRequest) Deletes a hypervisor.disassociateGatewayFromServer
(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest) Disassociates a backup gateway from the specified server.disassociateGatewayFromServer
(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest) Disassociates a backup gateway from the specified server.getBandwidthRateLimitSchedule
(Consumer<GetBandwidthRateLimitScheduleRequest.Builder> getBandwidthRateLimitScheduleRequest) Retrieves the bandwidth rate limit schedule for a specified gateway.getBandwidthRateLimitSchedule
(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest) Retrieves the bandwidth rate limit schedule for a specified gateway.default GetGatewayResponse
getGateway
(Consumer<GetGatewayRequest.Builder> getGatewayRequest) By providing the ARN (Amazon Resource Name), this API returns the gateway.default GetGatewayResponse
getGateway
(GetGatewayRequest getGatewayRequest) By providing the ARN (Amazon Resource Name), this API returns the gateway.default GetHypervisorResponse
getHypervisor
(Consumer<GetHypervisorRequest.Builder> getHypervisorRequest) This action requests information about the specified hypervisor to which the gateway will connect.default GetHypervisorResponse
getHypervisor
(GetHypervisorRequest getHypervisorRequest) This action requests information about the specified hypervisor to which the gateway will connect.getHypervisorPropertyMappings
(Consumer<GetHypervisorPropertyMappingsRequest.Builder> getHypervisorPropertyMappingsRequest) This action retrieves the property mappings for the specified hypervisor.getHypervisorPropertyMappings
(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest) This action retrieves the property mappings for the specified hypervisor.default GetVirtualMachineResponse
getVirtualMachine
(Consumer<GetVirtualMachineRequest.Builder> getVirtualMachineRequest) By providing the ARN (Amazon Resource Name), this API returns the virtual machine.default GetVirtualMachineResponse
getVirtualMachine
(GetVirtualMachineRequest getVirtualMachineRequest) By providing the ARN (Amazon Resource Name), this API returns the virtual machine.importHypervisorConfiguration
(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest) Connect to a hypervisor by importing its configuration.importHypervisorConfiguration
(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest) Connect to a hypervisor by importing its configuration.default ListGatewaysResponse
listGateways
(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.default ListGatewaysResponse
listGateways
(ListGatewaysRequest listGatewaysRequest) Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.default ListGatewaysIterable
listGatewaysPaginator
(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) This is a variant oflistGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest)
operation.default ListGatewaysIterable
listGatewaysPaginator
(ListGatewaysRequest listGatewaysRequest) This is a variant oflistGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest)
operation.default ListHypervisorsResponse
listHypervisors
(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest) Lists your hypervisors.default ListHypervisorsResponse
listHypervisors
(ListHypervisorsRequest listHypervisorsRequest) Lists your hypervisors.default ListHypervisorsIterable
listHypervisorsPaginator
(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest) This is a variant oflistHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation.default ListHypervisorsIterable
listHypervisorsPaginator
(ListHypervisorsRequest listHypervisorsRequest) This is a variant oflistHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).default ListVirtualMachinesResponse
listVirtualMachines
(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest) Lists your virtual machines.default ListVirtualMachinesResponse
listVirtualMachines
(ListVirtualMachinesRequest listVirtualMachinesRequest) Lists your virtual machines.default ListVirtualMachinesIterable
listVirtualMachinesPaginator
(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest) This is a variant oflistVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation.default ListVirtualMachinesIterable
listVirtualMachinesPaginator
(ListVirtualMachinesRequest listVirtualMachinesRequest) This is a variant oflistVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation.putBandwidthRateLimitSchedule
(Consumer<PutBandwidthRateLimitScheduleRequest.Builder> putBandwidthRateLimitScheduleRequest) This action sets the bandwidth rate limit schedule for a specified gateway.putBandwidthRateLimitSchedule
(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest) This action sets the bandwidth rate limit schedule for a specified gateway.putHypervisorPropertyMappings
(Consumer<PutHypervisorPropertyMappingsRequest.Builder> putHypervisorPropertyMappingsRequest) This action sets the property mappings for the specified hypervisor.putHypervisorPropertyMappings
(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest) This action sets the property mappings for the specified hypervisor.default PutMaintenanceStartTimeResponse
putMaintenanceStartTime
(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest) Set the maintenance start time for a gateway.default PutMaintenanceStartTimeResponse
putMaintenanceStartTime
(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest) Set the maintenance start time for a gateway.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
startVirtualMachinesMetadataSync
(Consumer<StartVirtualMachinesMetadataSyncRequest.Builder> startVirtualMachinesMetadataSyncRequest) This action sends a request to sync metadata across the specified virtual machines.startVirtualMachinesMetadataSync
(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest) This action sends a request to sync metadata across the specified virtual machines.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tag the resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Tag the resource.testHypervisorConfiguration
(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest) Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.testHypervisorConfiguration
(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest) Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the resource.default UpdateGatewayInformationResponse
updateGatewayInformation
(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest) Updates a gateway's name.default UpdateGatewayInformationResponse
updateGatewayInformation
(UpdateGatewayInformationRequest updateGatewayInformationRequest) Updates a gateway's name.default UpdateGatewaySoftwareNowResponse
updateGatewaySoftwareNow
(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest) Updates the gateway virtual machine (VM) software.default UpdateGatewaySoftwareNowResponse
updateGatewaySoftwareNow
(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) Updates the gateway virtual machine (VM) software.default UpdateHypervisorResponse
updateHypervisor
(Consumer<UpdateHypervisorRequest.Builder> updateHypervisorRequest) Updates a hypervisor metadata, including its host, username, and password.default UpdateHypervisorResponse
updateHypervisor
(UpdateHypervisorRequest updateHypervisorRequest) Updates a hypervisor metadata, including its host, username, and password.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateGatewayToServer
default AssociateGatewayToServerResponse associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest) throws ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the AssociateGatewayToServer operation returned by the service.
- See Also:
-
associateGatewayToServer
default AssociateGatewayToServerResponse associateGatewayToServer(Consumer<AssociateGatewayToServerRequest.Builder> associateGatewayToServerRequest) throws ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaAssociateGatewayToServerRequest.builder()
- Parameters:
associateGatewayToServerRequest
- AConsumer
that will call methods onAssociateGatewayToServerRequest.Builder
to create a request.- Returns:
- Result of the AssociateGatewayToServer operation returned by the service.
- See Also:
-
createGateway
default CreateGatewayResponse createGateway(CreateGatewayRequest createGatewayRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer
operation.- Parameters:
createGatewayRequest
-- Returns:
- Result of the CreateGateway operation returned by the service.
- See Also:
-
createGateway
default CreateGatewayResponse createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaCreateGatewayRequest.builder()
- Parameters:
createGatewayRequest
- AConsumer
that will call methods onCreateGatewayRequest.Builder
to create a request.- Returns:
- Result of the CreateGateway operation returned by the service.
- See Also:
-
deleteGateway
default DeleteGatewayResponse deleteGateway(DeleteGatewayRequest deleteGatewayRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Deletes a backup gateway.
- Parameters:
deleteGatewayRequest
-- Returns:
- Result of the DeleteGateway operation returned by the service.
- See Also:
-
deleteGateway
default DeleteGatewayResponse deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Deletes a backup gateway.
This is a convenience which creates an instance of the
DeleteGatewayRequest.Builder
avoiding the need to create one manually viaDeleteGatewayRequest.builder()
- Parameters:
deleteGatewayRequest
- AConsumer
that will call methods onDeleteGatewayRequest.Builder
to create a request.- Returns:
- Result of the DeleteGateway operation returned by the service.
- See Also:
-
deleteHypervisor
default DeleteHypervisorResponse deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Deletes a hypervisor.
- Parameters:
deleteHypervisorRequest
-- Returns:
- Result of the DeleteHypervisor operation returned by the service.
- See Also:
-
deleteHypervisor
default DeleteHypervisorResponse deleteHypervisor(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Deletes a hypervisor.
This is a convenience which creates an instance of the
DeleteHypervisorRequest.Builder
avoiding the need to create one manually viaDeleteHypervisorRequest.builder()
- Parameters:
deleteHypervisorRequest
- AConsumer
that will call methods onDeleteHypervisorRequest.Builder
to create a request.- Returns:
- Result of the DeleteHypervisor operation returned by the service.
- See Also:
-
disassociateGatewayFromServer
default DisassociateGatewayFromServerResponse disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the DisassociateGatewayFromServer operation returned by the service.
- See Also:
-
disassociateGatewayFromServer
default DisassociateGatewayFromServerResponse disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaDisassociateGatewayFromServerRequest.builder()
- Parameters:
disassociateGatewayFromServerRequest
- AConsumer
that will call methods onDisassociateGatewayFromServerRequest.Builder
to create a request.- Returns:
- Result of the DisassociateGatewayFromServer operation returned by the service.
- See Also:
-
getBandwidthRateLimitSchedule
default GetBandwidthRateLimitScheduleResponse getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the GetBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
getBandwidthRateLimitSchedule
default GetBandwidthRateLimitScheduleResponse getBandwidthRateLimitSchedule(Consumer<GetBandwidthRateLimitScheduleRequest.Builder> getBandwidthRateLimitScheduleRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaGetBandwidthRateLimitScheduleRequest.builder()
- Parameters:
getBandwidthRateLimitScheduleRequest
- AConsumer
that will call methods onGetBandwidthRateLimitScheduleRequest.Builder
to create a request.- Returns:
- Result of the GetBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
getGateway
default GetGatewayResponse getGateway(GetGatewayRequest getGatewayRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException By providing the ARN (Amazon Resource Name), this API returns the gateway.
- Parameters:
getGatewayRequest
-- Returns:
- Result of the GetGateway operation returned by the service.
- See Also:
-
getGateway
default GetGatewayResponse getGateway(Consumer<GetGatewayRequest.Builder> getGatewayRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaGetGatewayRequest.builder()
- Parameters:
getGatewayRequest
- AConsumer
that will call methods onGetGatewayRequest.Builder
to create a request.- Returns:
- Result of the GetGateway operation returned by the service.
- See Also:
-
getHypervisor
default GetHypervisorResponse getHypervisor(GetHypervisorRequest getHypervisorRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the GetHypervisor operation returned by the service.
- See Also:
-
getHypervisor
default GetHypervisorResponse getHypervisor(Consumer<GetHypervisorRequest.Builder> getHypervisorRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaGetHypervisorRequest.builder()
- Parameters:
getHypervisorRequest
- AConsumer
that will call methods onGetHypervisorRequest.Builder
to create a request.- Returns:
- Result of the GetHypervisor operation returned by the service.
- See Also:
-
getHypervisorPropertyMappings
default GetHypervisorPropertyMappingsResponse getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the GetHypervisorPropertyMappings operation returned by the service.
- See Also:
-
getHypervisorPropertyMappings
default GetHypervisorPropertyMappingsResponse getHypervisorPropertyMappings(Consumer<GetHypervisorPropertyMappingsRequest.Builder> getHypervisorPropertyMappingsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaGetHypervisorPropertyMappingsRequest.builder()
- Parameters:
getHypervisorPropertyMappingsRequest
- AConsumer
that will call methods onGetHypervisorPropertyMappingsRequest.Builder
to create a request.- Returns:
- Result of the GetHypervisorPropertyMappings operation returned by the service.
- See Also:
-
getVirtualMachine
default GetVirtualMachineResponse getVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
- Parameters:
getVirtualMachineRequest
-- Returns:
- Result of the GetVirtualMachine operation returned by the service.
- See Also:
-
getVirtualMachine
default GetVirtualMachineResponse getVirtualMachine(Consumer<GetVirtualMachineRequest.Builder> getVirtualMachineRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaGetVirtualMachineRequest.builder()
- Parameters:
getVirtualMachineRequest
- AConsumer
that will call methods onGetVirtualMachineRequest.Builder
to create a request.- Returns:
- Result of the GetVirtualMachine operation returned by the service.
- See Also:
-
importHypervisorConfiguration
default ImportHypervisorConfigurationResponse importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Connect to a hypervisor by importing its configuration.
- Parameters:
importHypervisorConfigurationRequest
-- Returns:
- Result of the ImportHypervisorConfiguration operation returned by the service.
- See Also:
-
importHypervisorConfiguration
default ImportHypervisorConfigurationResponse importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaImportHypervisorConfigurationRequest.builder()
- Parameters:
importHypervisorConfigurationRequest
- AConsumer
that will call methods onImportHypervisorConfigurationRequest.Builder
to create a request.- Returns:
- Result of the ImportHypervisorConfiguration operation returned by the service.
- See Also:
-
listGateways
default ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the ListGateways operation returned by the service.
- See Also:
-
listGateways
default ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaListGatewaysRequest.builder()
- Parameters:
listGatewaysRequest
- AConsumer
that will call methods onListGatewaysRequest.Builder
to create a request.- Returns:
- Result of the ListGateways operation returned by the service.
- See Also:
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This is a variant of
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client .listGatewaysPaginator(request); for (software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This is a variant of
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client .listGatewaysPaginator(request); for (software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListGatewaysRequest.builder()
- Parameters:
listGatewaysRequest
- AConsumer
that will call methods onListGatewaysRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHypervisors
default ListHypervisorsResponse listHypervisors(ListHypervisorsRequest listHypervisorsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Lists your hypervisors.
- Parameters:
listHypervisorsRequest
-- Returns:
- Result of the ListHypervisors operation returned by the service.
- See Also:
-
listHypervisors
default ListHypervisorsResponse listHypervisors(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Lists your hypervisors.
This is a convenience which creates an instance of the
ListHypervisorsRequest.Builder
avoiding the need to create one manually viaListHypervisorsRequest.builder()
- Parameters:
listHypervisorsRequest
- AConsumer
that will call methods onListHypervisorsRequest.Builder
to create a request.- Returns:
- Result of the ListHypervisors operation returned by the service.
- See Also:
-
listHypervisorsPaginator
default ListHypervisorsIterable listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This is a variant of
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client .listHypervisorsPaginator(request); for (software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listHypervisorsPaginator
default ListHypervisorsIterable listHypervisorsPaginator(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This is a variant of
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client .listHypervisorsPaginator(request); for (software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListHypervisorsRequest.builder()
- Parameters:
listHypervisorsRequest
- AConsumer
that will call methods onListHypervisorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listVirtualMachines
default ListVirtualMachinesResponse listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Lists your virtual machines.
- Parameters:
listVirtualMachinesRequest
-- Returns:
- Result of the ListVirtualMachines operation returned by the service.
- See Also:
-
listVirtualMachines
default ListVirtualMachinesResponse listVirtualMachines(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Lists your virtual machines.
This is a convenience which creates an instance of the
ListVirtualMachinesRequest.Builder
avoiding the need to create one manually viaListVirtualMachinesRequest.builder()
- Parameters:
listVirtualMachinesRequest
- AConsumer
that will call methods onListVirtualMachinesRequest.Builder
to create a request.- Returns:
- Result of the ListVirtualMachines operation returned by the service.
- See Also:
-
listVirtualMachinesPaginator
default ListVirtualMachinesIterable listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This is a variant of
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client .listVirtualMachinesPaginator(request); for (software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listVirtualMachinesPaginator
default ListVirtualMachinesIterable listVirtualMachinesPaginator(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This is a variant of
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client .listVirtualMachinesPaginator(request); for (software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListVirtualMachinesRequest.builder()
- Parameters:
listVirtualMachinesRequest
- AConsumer
that will call methods onListVirtualMachinesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putBandwidthRateLimitSchedule
default PutBandwidthRateLimitScheduleResponse putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the PutBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
putBandwidthRateLimitSchedule
default PutBandwidthRateLimitScheduleResponse putBandwidthRateLimitSchedule(Consumer<PutBandwidthRateLimitScheduleRequest.Builder> putBandwidthRateLimitScheduleRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaPutBandwidthRateLimitScheduleRequest.builder()
- Parameters:
putBandwidthRateLimitScheduleRequest
- AConsumer
that will call methods onPutBandwidthRateLimitScheduleRequest.Builder
to create a request.- Returns:
- Result of the PutBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
putHypervisorPropertyMappings
default PutHypervisorPropertyMappingsResponse putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the PutHypervisorPropertyMappings operation returned by the service.
- See Also:
-
putHypervisorPropertyMappings
default PutHypervisorPropertyMappingsResponse putHypervisorPropertyMappings(Consumer<PutHypervisorPropertyMappingsRequest.Builder> putHypervisorPropertyMappingsRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaPutHypervisorPropertyMappingsRequest.builder()
- Parameters:
putHypervisorPropertyMappingsRequest
- AConsumer
that will call methods onPutHypervisorPropertyMappingsRequest.Builder
to create a request.- Returns:
- Result of the PutHypervisorPropertyMappings operation returned by the service.
- See Also:
-
putMaintenanceStartTime
default PutMaintenanceStartTimeResponse putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Set the maintenance start time for a gateway.
- Parameters:
putMaintenanceStartTimeRequest
-- Returns:
- Result of the PutMaintenanceStartTime operation returned by the service.
- See Also:
-
putMaintenanceStartTime
default PutMaintenanceStartTimeResponse putMaintenanceStartTime(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaPutMaintenanceStartTimeRequest.builder()
- Parameters:
putMaintenanceStartTimeRequest
- AConsumer
that will call methods onPutMaintenanceStartTimeRequest.Builder
to create a request.- Returns:
- Result of the PutMaintenanceStartTime operation returned by the service.
- See Also:
-
startVirtualMachinesMetadataSync
default StartVirtualMachinesMetadataSyncResponse startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest) throws ValidationException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException This action sends a request to sync metadata across the specified virtual machines.
- Parameters:
startVirtualMachinesMetadataSyncRequest
-- Returns:
- Result of the StartVirtualMachinesMetadataSync operation returned by the service.
- See Also:
-
startVirtualMachinesMetadataSync
default StartVirtualMachinesMetadataSyncResponse startVirtualMachinesMetadataSync(Consumer<StartVirtualMachinesMetadataSyncRequest.Builder> startVirtualMachinesMetadataSyncRequest) throws ValidationException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaStartVirtualMachinesMetadataSyncRequest.builder()
- Parameters:
startVirtualMachinesMetadataSyncRequest
- AConsumer
that will call methods onStartVirtualMachinesMetadataSyncRequest.Builder
to create a request.- Returns:
- Result of the StartVirtualMachinesMetadataSync operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Tag the resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Tag the resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
testHypervisorConfiguration
default TestHypervisorConfigurationResponse testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
- Parameters:
testHypervisorConfigurationRequest
-- Returns:
- Result of the TestHypervisorConfiguration operation returned by the service.
- See Also:
-
testHypervisorConfiguration
default TestHypervisorConfigurationResponse testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaTestHypervisorConfigurationRequest.builder()
- Parameters:
testHypervisorConfigurationRequest
- AConsumer
that will call methods onTestHypervisorConfigurationRequest.Builder
to create a request.- Returns:
- Result of the TestHypervisorConfiguration operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Removes tags from the resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException Removes tags from the resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateGatewayInformation
default UpdateGatewayInformationResponse updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the UpdateGatewayInformation operation returned by the service.
- See Also:
-
updateGatewayInformation
default UpdateGatewayInformationResponse updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaUpdateGatewayInformationRequest.builder()
- Parameters:
updateGatewayInformationRequest
- AConsumer
that will call methods onUpdateGatewayInformationRequest.Builder
to create a request.- Returns:
- Result of the UpdateGatewayInformation operation returned by the service.
- See Also:
-
updateGatewaySoftwareNow
default UpdateGatewaySoftwareNowResponse updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the UpdateGatewaySoftwareNow operation returned by the service.
- See Also:
-
updateGatewaySoftwareNow
default UpdateGatewaySoftwareNowResponse updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaUpdateGatewaySoftwareNowRequest.builder()
- Parameters:
updateGatewaySoftwareNowRequest
- AConsumer
that will call methods onUpdateGatewaySoftwareNowRequest.Builder
to create a request.- Returns:
- Result of the UpdateGatewaySoftwareNow operation returned by the service.
- See Also:
-
updateHypervisor
default UpdateHypervisorResponse updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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:
- Result of the UpdateHypervisor operation returned by the service.
- See Also:
-
updateHypervisor
default UpdateHypervisorResponse updateHypervisor(Consumer<UpdateHypervisorRequest.Builder> updateHypervisorRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, BackupGatewayException 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 viaUpdateHypervisorRequest.builder()
- Parameters:
updateHypervisorRequest
- AConsumer
that will call methods onUpdateHypervisorRequest.Builder
to create a request.- Returns:
- Result of the UpdateHypervisor operation returned by the service.
- See Also:
-
create
Create aBackupGatewayClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aBackupGatewayClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-