com.amazonaws.services.backupgateway

Class AbstractAWSBackupGateway

java.lang.Object

com.amazonaws.services.backupgateway.AbstractAWSBackupGateway

All Implemented Interfaces:

AWSBackupGateway

Direct Known Subclasses:

AbstractAWSBackupGatewayAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSBackupGateway
extends Object
implements AWSBackupGateway

Abstract implementation of AWSBackupGateway. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.backupgateway.AWSBackupGateway

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateGatewayToServerResult	associateGatewayToServer(AssociateGatewayToServerRequest request) Associates a backup gateway with your server.
CreateGatewayResult	createGateway(CreateGatewayRequest request) Creates a backup gateway.
DeleteGatewayResult	deleteGateway(DeleteGatewayRequest request) Deletes a backup gateway.
DeleteHypervisorResult	deleteHypervisor(DeleteHypervisorRequest request) Deletes a hypervisor.
DisassociateGatewayFromServerResult	disassociateGatewayFromServer(DisassociateGatewayFromServerRequest request) Disassociates a backup gateway from the specified server.
GetBandwidthRateLimitScheduleResult	getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest request) Retrieves the bandwidth rate limit schedule for a specified gateway.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetGatewayResult	getGateway(GetGatewayRequest request) By providing the ARN (Amazon Resource Name), this API returns the gateway.
GetHypervisorResult	getHypervisor(GetHypervisorRequest request) This action requests information about the specified hypervisor to which the gateway will connect.
GetHypervisorPropertyMappingsResult	getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest request) This action retrieves the property mappings for the specified hypervisor.
GetVirtualMachineResult	getVirtualMachine(GetVirtualMachineRequest request) By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
ImportHypervisorConfigurationResult	importHypervisorConfiguration(ImportHypervisorConfigurationRequest request) Connect to a hypervisor by importing its configuration.
ListGatewaysResult	listGateways(ListGatewaysRequest request) Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
ListHypervisorsResult	listHypervisors(ListHypervisorsRequest request) Lists your hypervisors.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
ListVirtualMachinesResult	listVirtualMachines(ListVirtualMachinesRequest request) Lists your virtual machines.
PutBandwidthRateLimitScheduleResult	putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest request) This action sets the bandwidth rate limit schedule for a specified gateway.
PutHypervisorPropertyMappingsResult	putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest request) This action sets the property mappings for the specified hypervisor.
PutMaintenanceStartTimeResult	putMaintenanceStartTime(PutMaintenanceStartTimeRequest request) Set the maintenance start time for a gateway.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartVirtualMachinesMetadataSyncResult	startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest request) This action sends a request to sync metadata across the specified virtual machines.
TagResourceResult	tagResource(TagResourceRequest request) Tag the resource.
TestHypervisorConfigurationResult	testHypervisorConfiguration(TestHypervisorConfigurationRequest request) Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the resource.
UpdateGatewayInformationResult	updateGatewayInformation(UpdateGatewayInformationRequest request) Updates a gateway's name.
UpdateGatewaySoftwareNowResult	updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest request) Updates the gateway virtual machine (VM) software.
UpdateHypervisorResult	updateHypervisor(UpdateHypervisorRequest request) Updates a hypervisor metadata, including its host, username, and password.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

associateGatewayToServer

public AssociateGatewayToServerResult associateGatewayToServer(AssociateGatewayToServerRequest request)

Description copied from interface: AWSBackupGateway

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Specified by:

associateGatewayToServer in interface AWSBackupGateway

Returns:

Result of the AssociateGatewayToServer operation returned by the service.

See Also:

AWS API Documentation

createGateway

public CreateGatewayResult createGateway(CreateGatewayRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

createGateway in interface AWSBackupGateway

Returns:

Result of the CreateGateway operation returned by the service.

See Also:

AWS API Documentation

deleteGateway

public DeleteGatewayResult deleteGateway(DeleteGatewayRequest request)

Description copied from interface: AWSBackupGateway

Deletes a backup gateway.

Specified by:

deleteGateway in interface AWSBackupGateway

Returns:

Result of the DeleteGateway operation returned by the service.

See Also:

AWS API Documentation

deleteHypervisor

public DeleteHypervisorResult deleteHypervisor(DeleteHypervisorRequest request)

Description copied from interface: AWSBackupGateway

Deletes a hypervisor.

Specified by:

deleteHypervisor in interface AWSBackupGateway

Returns:

Result of the DeleteHypervisor operation returned by the service.

See Also:

AWS API Documentation

disassociateGatewayFromServer

public DisassociateGatewayFromServerResult disassociateGatewayFromServer(DisassociateGatewayFromServerRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

disassociateGatewayFromServer in interface AWSBackupGateway

Returns:

Result of the DisassociateGatewayFromServer operation returned by the service.

See Also:

AWS API Documentation

getBandwidthRateLimitSchedule

public GetBandwidthRateLimitScheduleResult getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

getBandwidthRateLimitSchedule in interface AWSBackupGateway

Returns:

Result of the GetBandwidthRateLimitSchedule operation returned by the service.

See Also:

AWS API Documentation

getGateway

public GetGatewayResult getGateway(GetGatewayRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

getGateway in interface AWSBackupGateway

Returns:

Result of the GetGateway operation returned by the service.

See Also:

AWS API Documentation

getHypervisor

public GetHypervisorResult getHypervisor(GetHypervisorRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

getHypervisor in interface AWSBackupGateway

Returns:

Result of the GetHypervisor operation returned by the service.

See Also:

AWS API Documentation

getHypervisorPropertyMappings

public GetHypervisorPropertyMappingsResult getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

getHypervisorPropertyMappings in interface AWSBackupGateway

Returns:

Result of the GetHypervisorPropertyMappings operation returned by the service.

See Also:

AWS API Documentation

getVirtualMachine

public GetVirtualMachineResult getVirtualMachine(GetVirtualMachineRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

getVirtualMachine in interface AWSBackupGateway

Returns:

Result of the GetVirtualMachine operation returned by the service.

See Also:

AWS API Documentation

importHypervisorConfiguration

public ImportHypervisorConfigurationResult importHypervisorConfiguration(ImportHypervisorConfigurationRequest request)

Description copied from interface: AWSBackupGateway

Connect to a hypervisor by importing its configuration.

Specified by:

importHypervisorConfiguration in interface AWSBackupGateway

Returns:

Result of the ImportHypervisorConfiguration operation returned by the service.

See Also:

AWS API Documentation

listGateways

public ListGatewaysResult listGateways(ListGatewaysRequest request)

Description copied from interface: AWSBackupGateway

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).

Specified by:

listGateways in interface AWSBackupGateway

Returns:

Result of the ListGateways operation returned by the service.

See Also:

AWS API Documentation

listHypervisors

public ListHypervisorsResult listHypervisors(ListHypervisorsRequest request)

Description copied from interface: AWSBackupGateway

Lists your hypervisors.

Specified by:

listHypervisors in interface AWSBackupGateway

Returns:

Result of the ListHypervisors operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

listTagsForResource in interface AWSBackupGateway

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listVirtualMachines

public ListVirtualMachinesResult listVirtualMachines(ListVirtualMachinesRequest request)

Description copied from interface: AWSBackupGateway

Lists your virtual machines.

Specified by:

listVirtualMachines in interface AWSBackupGateway

Returns:

Result of the ListVirtualMachines operation returned by the service.

See Also:

AWS API Documentation

putBandwidthRateLimitSchedule

public PutBandwidthRateLimitScheduleResult putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

putBandwidthRateLimitSchedule in interface AWSBackupGateway

Returns:

Result of the PutBandwidthRateLimitSchedule operation returned by the service.

See Also:

AWS API Documentation

putHypervisorPropertyMappings

public PutHypervisorPropertyMappingsResult putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

putHypervisorPropertyMappings in interface AWSBackupGateway

Returns:

Result of the PutHypervisorPropertyMappings operation returned by the service.

See Also:

AWS API Documentation

putMaintenanceStartTime

public PutMaintenanceStartTimeResult putMaintenanceStartTime(PutMaintenanceStartTimeRequest request)

Description copied from interface: AWSBackupGateway

Set the maintenance start time for a gateway.

Specified by:

putMaintenanceStartTime in interface AWSBackupGateway

Returns:

Result of the PutMaintenanceStartTime operation returned by the service.

See Also:

AWS API Documentation

startVirtualMachinesMetadataSync

public StartVirtualMachinesMetadataSyncResult startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

startVirtualMachinesMetadataSync in interface AWSBackupGateway

Returns:

Result of the StartVirtualMachinesMetadataSync operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AWSBackupGateway

Tag the resource.

Specified by:

tagResource in interface AWSBackupGateway

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

testHypervisorConfiguration

public TestHypervisorConfigurationResult testHypervisorConfiguration(TestHypervisorConfigurationRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

testHypervisorConfiguration in interface AWSBackupGateway

Returns:

Result of the TestHypervisorConfiguration operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AWSBackupGateway

Removes tags from the resource.

Specified by:

untagResource in interface AWSBackupGateway

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateGatewayInformation

public UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest request)

Description copied from interface: AWSBackupGateway

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

Specified by:

updateGatewayInformation in interface AWSBackupGateway

Returns:

Result of the UpdateGatewayInformation operation returned by the service.

See Also:

AWS API Documentation

updateGatewaySoftwareNow

public UpdateGatewaySoftwareNowResult updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

updateGatewaySoftwareNow in interface AWSBackupGateway

Returns:

Result of the UpdateGatewaySoftwareNow operation returned by the service.

See Also:

AWS API Documentation

updateHypervisor

public UpdateHypervisorResult updateHypervisor(UpdateHypervisorRequest request)

Description copied from interface: AWSBackupGateway

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.

Specified by:

updateHypervisor in interface AWSBackupGateway

Returns:

Result of the UpdateHypervisor operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSBackupGateway

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSBackupGateway

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSBackupGateway

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSBackupGateway

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.