@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BackupGatewayAsyncClient extends AwsClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateGatewayToServerResponse> |
associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest)
Associates a backup gateway with your server.
|
default CompletableFuture<AssociateGatewayToServerResponse> |
associateGatewayToServer(Consumer<AssociateGatewayToServerRequest.Builder> associateGatewayToServerRequest)
Associates a backup gateway with your server.
|
static BackupGatewayAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
BackupGatewayAsyncClient. |
static BackupGatewayAsyncClient |
create()
Create a
BackupGatewayAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateGatewayResponse> |
createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
Creates a backup gateway.
|
default CompletableFuture<CreateGatewayResponse> |
createGateway(CreateGatewayRequest createGatewayRequest)
Creates a backup gateway.
|
default CompletableFuture<DeleteGatewayResponse> |
deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
Deletes a backup gateway.
|
default CompletableFuture<DeleteGatewayResponse> |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a backup gateway.
|
default CompletableFuture<DeleteHypervisorResponse> |
deleteHypervisor(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest)
Deletes a hypervisor.
|
default CompletableFuture<DeleteHypervisorResponse> |
deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest)
Deletes a hypervisor.
|
default CompletableFuture<DisassociateGatewayFromServerResponse> |
disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest)
Disassociates a backup gateway from the specified server.
|
default CompletableFuture<DisassociateGatewayFromServerResponse> |
disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)
Disassociates a backup gateway from the specified server.
|
default CompletableFuture<GetBandwidthRateLimitScheduleResponse> |
getBandwidthRateLimitSchedule(Consumer<GetBandwidthRateLimitScheduleRequest.Builder> getBandwidthRateLimitScheduleRequest)
Retrieves the bandwidth rate limit schedule for a specified gateway.
|
default CompletableFuture<GetBandwidthRateLimitScheduleResponse> |
getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest)
Retrieves the bandwidth rate limit schedule for a specified gateway.
|
default CompletableFuture<GetGatewayResponse> |
getGateway(Consumer<GetGatewayRequest.Builder> getGatewayRequest)
By providing the ARN (Amazon Resource Name), this API returns the gateway.
|
default CompletableFuture<GetGatewayResponse> |
getGateway(GetGatewayRequest getGatewayRequest)
By providing the ARN (Amazon Resource Name), this API returns the gateway.
|
default CompletableFuture<GetHypervisorResponse> |
getHypervisor(Consumer<GetHypervisorRequest.Builder> getHypervisorRequest)
This action requests information about the specified hypervisor to which the gateway will connect.
|
default CompletableFuture<GetHypervisorResponse> |
getHypervisor(GetHypervisorRequest getHypervisorRequest)
This action requests information about the specified hypervisor to which the gateway will connect.
|
default CompletableFuture<GetHypervisorPropertyMappingsResponse> |
getHypervisorPropertyMappings(Consumer<GetHypervisorPropertyMappingsRequest.Builder> getHypervisorPropertyMappingsRequest)
This action retrieves the property mappings for the specified hypervisor.
|
default CompletableFuture<GetHypervisorPropertyMappingsResponse> |
getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest)
This action retrieves the property mappings for the specified hypervisor.
|
default CompletableFuture<GetVirtualMachineResponse> |
getVirtualMachine(Consumer<GetVirtualMachineRequest.Builder> getVirtualMachineRequest)
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
|
default CompletableFuture<GetVirtualMachineResponse> |
getVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest)
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
|
default CompletableFuture<ImportHypervisorConfigurationResponse> |
importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
|
default CompletableFuture<ImportHypervisorConfigurationResponse> |
importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
|
default CompletableFuture<ListGatewaysResponse> |
listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default CompletableFuture<ListGatewaysResponse> |
listGateways(ListGatewaysRequest listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default ListGatewaysPublisher |
listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default ListGatewaysPublisher |
listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default CompletableFuture<ListHypervisorsResponse> |
listHypervisors(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)
Lists your hypervisors.
|
default CompletableFuture<ListHypervisorsResponse> |
listHypervisors(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
|
default ListHypervisorsPublisher |
listHypervisorsPaginator(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)
Lists your hypervisors.
|
default ListHypervisorsPublisher |
listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<ListVirtualMachinesResponse> |
listVirtualMachines(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)
Lists your virtual machines.
|
default CompletableFuture<ListVirtualMachinesResponse> |
listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
|
default ListVirtualMachinesPublisher |
listVirtualMachinesPaginator(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)
Lists your virtual machines.
|
default ListVirtualMachinesPublisher |
listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
|
default CompletableFuture<PutBandwidthRateLimitScheduleResponse> |
putBandwidthRateLimitSchedule(Consumer<PutBandwidthRateLimitScheduleRequest.Builder> putBandwidthRateLimitScheduleRequest)
This action sets the bandwidth rate limit schedule for a specified gateway.
|
default CompletableFuture<PutBandwidthRateLimitScheduleResponse> |
putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)
This action sets the bandwidth rate limit schedule for a specified gateway.
|
default CompletableFuture<PutHypervisorPropertyMappingsResponse> |
putHypervisorPropertyMappings(Consumer<PutHypervisorPropertyMappingsRequest.Builder> putHypervisorPropertyMappingsRequest)
This action sets the property mappings for the specified hypervisor.
|
default CompletableFuture<PutHypervisorPropertyMappingsResponse> |
putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest)
This action sets the property mappings for the specified hypervisor.
|
default CompletableFuture<PutMaintenanceStartTimeResponse> |
putMaintenanceStartTime(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
|
default CompletableFuture<PutMaintenanceStartTimeResponse> |
putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
|
default BackupGatewayServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartVirtualMachinesMetadataSyncResponse> |
startVirtualMachinesMetadataSync(Consumer<StartVirtualMachinesMetadataSyncRequest.Builder> startVirtualMachinesMetadataSyncRequest)
This action sends a request to sync metadata across the specified virtual machines.
|
default CompletableFuture<StartVirtualMachinesMetadataSyncResponse> |
startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest)
This action sends a request to sync metadata across the specified virtual machines.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag the resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Tag the resource.
|
default CompletableFuture<TestHypervisorConfigurationResponse> |
testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
resources.
|
default CompletableFuture<TestHypervisorConfigurationResponse> |
testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
resources.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource.
|
default CompletableFuture<UpdateGatewayInformationResponse> |
updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest)
Updates a gateway's name.
|
default CompletableFuture<UpdateGatewayInformationResponse> |
updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's name.
|
default CompletableFuture<UpdateGatewaySoftwareNowResponse> |
updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software.
|
default CompletableFuture<UpdateGatewaySoftwareNowResponse> |
updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software.
|
default CompletableFuture<UpdateHypervisorResponse> |
updateHypervisor(Consumer<UpdateHypervisorRequest.Builder> updateHypervisorRequest)
Updates a hypervisor metadata, including its host, username, and password.
|
default CompletableFuture<UpdateHypervisorResponse> |
updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest)
Updates a hypervisor metadata, including its host, username, and password.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateGatewayToServerResponse> associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest)
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
associateGatewayToServerRequest - default CompletableFuture<AssociateGatewayToServerResponse> associateGatewayToServer(Consumer<AssociateGatewayToServerRequest.Builder> associateGatewayToServerRequest)
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
This is a convenience which creates an instance of the AssociateGatewayToServerRequest.Builder avoiding
the need to create one manually via AssociateGatewayToServerRequest.builder()
associateGatewayToServerRequest - A Consumer that will call methods on AssociateGatewayToServerInput.Builder to create a
request.default CompletableFuture<CreateGatewayResponse> createGateway(CreateGatewayRequest createGatewayRequest)
Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer operation.
createGatewayRequest - default CompletableFuture<CreateGatewayResponse> createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer operation.
This is a convenience which creates an instance of the CreateGatewayRequest.Builder avoiding the need to
create one manually via CreateGatewayRequest.builder()
createGatewayRequest - A Consumer that will call methods on CreateGatewayInput.Builder to create a request.default CompletableFuture<DeleteGatewayResponse> deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a backup gateway.
deleteGatewayRequest - default CompletableFuture<DeleteGatewayResponse> deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
Deletes a backup gateway.
This is a convenience which creates an instance of the DeleteGatewayRequest.Builder avoiding the need to
create one manually via DeleteGatewayRequest.builder()
deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayInput.Builder to create a request.default CompletableFuture<DeleteHypervisorResponse> deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest)
Deletes a hypervisor.
deleteHypervisorRequest - default CompletableFuture<DeleteHypervisorResponse> deleteHypervisor(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest)
Deletes a hypervisor.
This is a convenience which creates an instance of the DeleteHypervisorRequest.Builder avoiding the need
to create one manually via DeleteHypervisorRequest.builder()
deleteHypervisorRequest - A Consumer that will call methods on DeleteHypervisorInput.Builder to create a request.default CompletableFuture<DisassociateGatewayFromServerResponse> disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
disassociateGatewayFromServerRequest - default CompletableFuture<DisassociateGatewayFromServerResponse> disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest)
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
This is a convenience which creates an instance of the DisassociateGatewayFromServerRequest.Builder
avoiding the need to create one manually via DisassociateGatewayFromServerRequest.builder()
disassociateGatewayFromServerRequest - A Consumer that will call methods on DisassociateGatewayFromServerInput.Builder to create
a request.default CompletableFuture<GetBandwidthRateLimitScheduleResponse> getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest)
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
getBandwidthRateLimitScheduleRequest - default CompletableFuture<GetBandwidthRateLimitScheduleResponse> getBandwidthRateLimitSchedule(Consumer<GetBandwidthRateLimitScheduleRequest.Builder> getBandwidthRateLimitScheduleRequest)
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
This is a convenience which creates an instance of the GetBandwidthRateLimitScheduleRequest.Builder
avoiding the need to create one manually via GetBandwidthRateLimitScheduleRequest.builder()
getBandwidthRateLimitScheduleRequest - A Consumer that will call methods on GetBandwidthRateLimitScheduleInput.Builder to create
a request.default CompletableFuture<GetGatewayResponse> getGateway(GetGatewayRequest getGatewayRequest)
By providing the ARN (Amazon Resource Name), this API returns the gateway.
getGatewayRequest - default CompletableFuture<GetGatewayResponse> getGateway(Consumer<GetGatewayRequest.Builder> getGatewayRequest)
By providing the ARN (Amazon Resource Name), this API returns the gateway.
This is a convenience which creates an instance of the GetGatewayRequest.Builder avoiding the need to
create one manually via GetGatewayRequest.builder()
getGatewayRequest - A Consumer that will call methods on GetGatewayInput.Builder to create a request.default CompletableFuture<GetHypervisorResponse> getHypervisor(GetHypervisorRequest getHypervisorRequest)
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
getHypervisorRequest - default CompletableFuture<GetHypervisorResponse> getHypervisor(Consumer<GetHypervisorRequest.Builder> getHypervisorRequest)
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
This is a convenience which creates an instance of the GetHypervisorRequest.Builder avoiding the need to
create one manually via GetHypervisorRequest.builder()
getHypervisorRequest - A Consumer that will call methods on GetHypervisorInput.Builder to create a request.default CompletableFuture<GetHypervisorPropertyMappingsResponse> getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest)
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
getHypervisorPropertyMappingsRequest - default CompletableFuture<GetHypervisorPropertyMappingsResponse> getHypervisorPropertyMappings(Consumer<GetHypervisorPropertyMappingsRequest.Builder> getHypervisorPropertyMappingsRequest)
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
This is a convenience which creates an instance of the GetHypervisorPropertyMappingsRequest.Builder
avoiding the need to create one manually via GetHypervisorPropertyMappingsRequest.builder()
getHypervisorPropertyMappingsRequest - A Consumer that will call methods on GetHypervisorPropertyMappingsInput.Builder to create
a request.default CompletableFuture<GetVirtualMachineResponse> getVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest)
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
getVirtualMachineRequest - default CompletableFuture<GetVirtualMachineResponse> getVirtualMachine(Consumer<GetVirtualMachineRequest.Builder> getVirtualMachineRequest)
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
This is a convenience which creates an instance of the GetVirtualMachineRequest.Builder avoiding the need
to create one manually via GetVirtualMachineRequest.builder()
getVirtualMachineRequest - A Consumer that will call methods on GetVirtualMachineInput.Builder to create a request.default CompletableFuture<ImportHypervisorConfigurationResponse> importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
importHypervisorConfigurationRequest - default CompletableFuture<ImportHypervisorConfigurationResponse> importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
This is a convenience which creates an instance of the ImportHypervisorConfigurationRequest.Builder
avoiding the need to create one manually via ImportHypervisorConfigurationRequest.builder()
importHypervisorConfigurationRequest - A Consumer that will call methods on ImportHypervisorConfigurationInput.Builder to create
a request.default CompletableFuture<ListGatewaysResponse> listGateways(ListGatewaysRequest listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
listGatewaysRequest - default CompletableFuture<ListGatewaysResponse> listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysInput.Builder to create a request.default ListGatewaysPublisher listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
This is a variant of
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation.
listGatewaysRequest - default ListGatewaysPublisher listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
This is a variant of
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysInput.Builder to create a request.default CompletableFuture<ListHypervisorsResponse> listHypervisors(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
listHypervisorsRequest - default CompletableFuture<ListHypervisorsResponse> listHypervisors(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)
Lists your hypervisors.
This is a convenience which creates an instance of the ListHypervisorsRequest.Builder avoiding the need
to create one manually via ListHypervisorsRequest.builder()
listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsInput.Builder to create a request.default ListHypervisorsPublisher listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
This is a variant of
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsPublisher publisher = client.listHypervisorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsPublisher publisher = client.listHypervisorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation.
listHypervisorsRequest - default ListHypervisorsPublisher listHypervisorsPaginator(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)
Lists your hypervisors.
This is a variant of
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsPublisher publisher = client.listHypervisorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsPublisher publisher = client.listHypervisorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation.
This is a convenience which creates an instance of the ListHypervisorsRequest.Builder avoiding the need
to create one manually via ListHypervisorsRequest.builder()
listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.default CompletableFuture<ListVirtualMachinesResponse> listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
listVirtualMachinesRequest - default CompletableFuture<ListVirtualMachinesResponse> listVirtualMachines(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)
Lists your virtual machines.
This is a convenience which creates an instance of the ListVirtualMachinesRequest.Builder avoiding the
need to create one manually via ListVirtualMachinesRequest.builder()
listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesInput.Builder to create a request.default ListVirtualMachinesPublisher listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
This is a variant of
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesPublisher publisher = client.listVirtualMachinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesPublisher publisher = client.listVirtualMachinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation.
listVirtualMachinesRequest - default ListVirtualMachinesPublisher listVirtualMachinesPaginator(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)
Lists your virtual machines.
This is a variant of
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesPublisher publisher = client.listVirtualMachinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesPublisher publisher = client.listVirtualMachinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation.
This is a convenience which creates an instance of the ListVirtualMachinesRequest.Builder avoiding the
need to create one manually via ListVirtualMachinesRequest.builder()
listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesInput.Builder to create a request.default CompletableFuture<PutBandwidthRateLimitScheduleResponse> putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
putBandwidthRateLimitScheduleRequest - default CompletableFuture<PutBandwidthRateLimitScheduleResponse> putBandwidthRateLimitSchedule(Consumer<PutBandwidthRateLimitScheduleRequest.Builder> putBandwidthRateLimitScheduleRequest)
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
This is a convenience which creates an instance of the PutBandwidthRateLimitScheduleRequest.Builder
avoiding the need to create one manually via PutBandwidthRateLimitScheduleRequest.builder()
putBandwidthRateLimitScheduleRequest - A Consumer that will call methods on PutBandwidthRateLimitScheduleInput.Builder to create
a request.default CompletableFuture<PutHypervisorPropertyMappingsResponse> putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest)
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
putHypervisorPropertyMappingsRequest - default CompletableFuture<PutHypervisorPropertyMappingsResponse> putHypervisorPropertyMappings(Consumer<PutHypervisorPropertyMappingsRequest.Builder> putHypervisorPropertyMappingsRequest)
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
This is a convenience which creates an instance of the PutHypervisorPropertyMappingsRequest.Builder
avoiding the need to create one manually via PutHypervisorPropertyMappingsRequest.builder()
putHypervisorPropertyMappingsRequest - A Consumer that will call methods on PutHypervisorPropertyMappingsInput.Builder to create
a request.default CompletableFuture<PutMaintenanceStartTimeResponse> putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
putMaintenanceStartTimeRequest - default CompletableFuture<PutMaintenanceStartTimeResponse> putMaintenanceStartTime(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
This is a convenience which creates an instance of the PutMaintenanceStartTimeRequest.Builder avoiding
the need to create one manually via PutMaintenanceStartTimeRequest.builder()
putMaintenanceStartTimeRequest - A Consumer that will call methods on PutMaintenanceStartTimeInput.Builder to create a
request.default CompletableFuture<StartVirtualMachinesMetadataSyncResponse> startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest)
This action sends a request to sync metadata across the specified virtual machines.
startVirtualMachinesMetadataSyncRequest - default CompletableFuture<StartVirtualMachinesMetadataSyncResponse> startVirtualMachinesMetadataSync(Consumer<StartVirtualMachinesMetadataSyncRequest.Builder> startVirtualMachinesMetadataSyncRequest)
This action sends a request to sync metadata across the specified virtual machines.
This is a convenience which creates an instance of the StartVirtualMachinesMetadataSyncRequest.Builder
avoiding the need to create one manually via StartVirtualMachinesMetadataSyncRequest.builder()
startVirtualMachinesMetadataSyncRequest - A Consumer that will call methods on StartVirtualMachinesMetadataSyncInput.Builder to
create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tag the resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag the resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.default CompletableFuture<TestHypervisorConfigurationResponse> testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
testHypervisorConfigurationRequest - default CompletableFuture<TestHypervisorConfigurationResponse> testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
This is a convenience which creates an instance of the TestHypervisorConfigurationRequest.Builder
avoiding the need to create one manually via TestHypervisorConfigurationRequest.builder()
testHypervisorConfigurationRequest - A Consumer that will call methods on TestHypervisorConfigurationInput.Builder to create a
request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.default CompletableFuture<UpdateGatewayInformationResponse> updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
updateGatewayInformationRequest - default CompletableFuture<UpdateGatewayInformationResponse> updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest)
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the UpdateGatewayInformationRequest.Builder avoiding
the need to create one manually via UpdateGatewayInformationRequest.builder()
updateGatewayInformationRequest - A Consumer that will call methods on UpdateGatewayInformationInput.Builder to create a
request.default CompletableFuture<UpdateGatewaySoftwareNowResponse> updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take
some time for the update to complete.
updateGatewaySoftwareNowRequest - default CompletableFuture<UpdateGatewaySoftwareNowResponse> updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take
some time for the update to complete.
This is a convenience which creates an instance of the UpdateGatewaySoftwareNowRequest.Builder avoiding
the need to create one manually via UpdateGatewaySoftwareNowRequest.builder()
updateGatewaySoftwareNowRequest - A Consumer that will call methods on UpdateGatewaySoftwareNowInput.Builder to create a
request.default CompletableFuture<UpdateHypervisorResponse> updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest)
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
updateHypervisorRequest - default CompletableFuture<UpdateHypervisorResponse> updateHypervisor(Consumer<UpdateHypervisorRequest.Builder> updateHypervisorRequest)
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
This is a convenience which creates an instance of the UpdateHypervisorRequest.Builder avoiding the need
to create one manually via UpdateHypervisorRequest.builder()
updateHypervisorRequest - A Consumer that will call methods on UpdateHypervisorInput.Builder to create a request.default BackupGatewayServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic BackupGatewayAsyncClient create()
BackupGatewayAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BackupGatewayAsyncClientBuilder builder()
BackupGatewayAsyncClient.Copyright © 2023. All rights reserved.