Interface BackupGatewayClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BackupGatewayClient
extends AwsClient

Service client for accessing AWS Backup Gateway. This can be created using the static builder() method.

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 Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default 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 a BackupGatewayClient.
static BackupGatewayClient	create()	Create a BackupGatewayClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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.
default DisassociateGatewayFromServerResponse	disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest)	Disassociates a backup gateway from the specified server.
default DisassociateGatewayFromServerResponse	disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)	Disassociates a backup gateway from the specified server.
default GetBandwidthRateLimitScheduleResponse	getBandwidthRateLimitSchedule(Consumer<GetBandwidthRateLimitScheduleRequest.Builder> getBandwidthRateLimitScheduleRequest)	Retrieves the bandwidth rate limit schedule for a specified gateway.
default GetBandwidthRateLimitScheduleResponse	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.
default GetHypervisorPropertyMappingsResponse	getHypervisorPropertyMappings(Consumer<GetHypervisorPropertyMappingsRequest.Builder> getHypervisorPropertyMappingsRequest)	This action retrieves the property mappings for the specified hypervisor.
default GetHypervisorPropertyMappingsResponse	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.
default ImportHypervisorConfigurationResponse	importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest)	Connect to a hypervisor by importing its configuration.
default ImportHypervisorConfigurationResponse	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 of listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation.
default ListGatewaysIterable	listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)	This is a variant of listGateways(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 of listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest) operation.
default ListHypervisorsIterable	listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest)	This is a variant of listHypervisors(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 of listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest) operation.
default ListVirtualMachinesIterable	listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest)	This is a variant of listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest) operation.
default PutBandwidthRateLimitScheduleResponse	putBandwidthRateLimitSchedule(Consumer<PutBandwidthRateLimitScheduleRequest.Builder> putBandwidthRateLimitScheduleRequest)	This action sets the bandwidth rate limit schedule for a specified gateway.
default PutBandwidthRateLimitScheduleResponse	putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)	This action sets the bandwidth rate limit schedule for a specified gateway.
default PutHypervisorPropertyMappingsResponse	putHypervisorPropertyMappings(Consumer<PutHypervisorPropertyMappingsRequest.Builder> putHypervisorPropertyMappingsRequest)	This action sets the property mappings for the specified hypervisor.
default PutHypervisorPropertyMappingsResponse	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.
default BackupGatewayServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartVirtualMachinesMetadataSyncResponse	startVirtualMachinesMetadataSync(Consumer<StartVirtualMachinesMetadataSyncRequest.Builder> startVirtualMachinesMetadataSyncRequest)	This action sends a request to sync metadata across the specified virtual machines.
default StartVirtualMachinesMetadataSyncResponse	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.
default TestHypervisorConfigurationResponse	testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest)	Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
default TestHypervisorConfigurationResponse	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• AWS API Documentation

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 via AssociateGatewayToServerRequest.builder()

Parameters:

associateGatewayToServerRequest - A Consumer that will call methods on AssociateGatewayToServerRequest.Builder to create a request.

Returns:

Result of the AssociateGatewayToServer operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CreateGatewayRequest.builder()

Parameters:

createGatewayRequest - A Consumer that will call methods on CreateGatewayRequest.Builder to create a request.

Returns:

Result of the CreateGateway operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteGatewayRequest.builder()

Parameters:

deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayRequest.Builder to create a request.

Returns:

Result of the DeleteGateway operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteHypervisorRequest.builder()

Parameters:

deleteHypervisorRequest - A Consumer that will call methods on DeleteHypervisorRequest.Builder to create a request.

Returns:

Result of the DeleteHypervisor operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DisassociateGatewayFromServerRequest.builder()

Parameters:

disassociateGatewayFromServerRequest - A Consumer that will call methods on DisassociateGatewayFromServerRequest.Builder to create a request.

Returns:

Result of the DisassociateGatewayFromServer operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetBandwidthRateLimitScheduleRequest.builder()

Parameters:

getBandwidthRateLimitScheduleRequest - A Consumer that will call methods on GetBandwidthRateLimitScheduleRequest.Builder to create a request.

Returns:

Result of the GetBandwidthRateLimitSchedule operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetGatewayRequest.builder()

Parameters:

getGatewayRequest - A Consumer that will call methods on GetGatewayRequest.Builder to create a request.

Returns:

Result of the GetGateway operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetHypervisorRequest.builder()

Parameters:

getHypervisorRequest - A Consumer that will call methods on GetHypervisorRequest.Builder to create a request.

Returns:

Result of the GetHypervisor operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetHypervisorPropertyMappingsRequest.builder()

Parameters:

getHypervisorPropertyMappingsRequest - A Consumer that will call methods on GetHypervisorPropertyMappingsRequest.Builder to create a request.

Returns:

Result of the GetHypervisorPropertyMappings operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetVirtualMachineRequest.builder()

Parameters:

getVirtualMachineRequest - A Consumer that will call methods on GetVirtualMachineRequest.Builder to create a request.

Returns:

Result of the GetVirtualMachine operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ImportHypervisorConfigurationRequest.builder()

Parameters:

importHypervisorConfigurationRequest - A Consumer that will call methods on ImportHypervisorConfigurationRequest.Builder to create a request.

Returns:

Result of the ImportHypervisorConfiguration operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListGatewaysRequest.builder()

Parameters:

listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.

Returns:

Result of the ListGateways operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListGatewaysRequest.builder()

Parameters:

listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListHypervisorsRequest.builder()

Parameters:

listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsRequest.Builder to create a request.

Returns:

Result of the ListHypervisors operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListHypervisorsRequest.builder()

Parameters:

listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListVirtualMachinesRequest.builder()

Parameters:

listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesRequest.Builder to create a request.

Returns:

Result of the ListVirtualMachines operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListVirtualMachinesRequest.builder()

Parameters:

listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via PutBandwidthRateLimitScheduleRequest.builder()

Parameters:

putBandwidthRateLimitScheduleRequest - A Consumer that will call methods on PutBandwidthRateLimitScheduleRequest.Builder to create a request.

Returns:

Result of the PutBandwidthRateLimitSchedule operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via PutHypervisorPropertyMappingsRequest.builder()

Parameters:

putHypervisorPropertyMappingsRequest - A Consumer that will call methods on PutHypervisorPropertyMappingsRequest.Builder to create a request.

Returns:

Result of the PutHypervisorPropertyMappings operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via PutMaintenanceStartTimeRequest.builder()

Parameters:

putMaintenanceStartTimeRequest - A Consumer that will call methods on PutMaintenanceStartTimeRequest.Builder to create a request.

Returns:

Result of the PutMaintenanceStartTime operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via StartVirtualMachinesMetadataSyncRequest.builder()

Parameters:

startVirtualMachinesMetadataSyncRequest - A Consumer that will call methods on StartVirtualMachinesMetadataSyncRequest.Builder to create a request.

Returns:

Result of the StartVirtualMachinesMetadataSync operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via TestHypervisorConfigurationRequest.builder()

Parameters:

testHypervisorConfigurationRequest - A Consumer that will call methods on TestHypervisorConfigurationRequest.Builder to create a request.

Returns:

Result of the TestHypervisorConfiguration operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateGatewayInformationRequest.builder()

Parameters:

updateGatewayInformationRequest - A Consumer that will call methods on UpdateGatewayInformationRequest.Builder to create a request.

Returns:

Result of the UpdateGatewayInformation operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateGatewaySoftwareNowRequest.builder()

Parameters:

updateGatewaySoftwareNowRequest - A Consumer that will call methods on UpdateGatewaySoftwareNowRequest.Builder to create a request.

Returns:

Result of the UpdateGatewaySoftwareNow operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateHypervisorRequest.builder()

Parameters:

updateHypervisorRequest - A Consumer that will call methods on UpdateHypervisorRequest.Builder to create a request.

Returns:

Result of the UpdateHypervisor operation returned by the service.

See Also:

• AWS API Documentation

create

static BackupGatewayClient create()

Create a BackupGatewayClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BackupGatewayClientBuilder builder()

Create a builder that can be used to configure and create a BackupGatewayClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

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