VmBackupsService.AddRequest (oVirt Java SDK 4.5.1 API)

All Superinterfaces:

Request<VmBackupsService.AddRequest,VmBackupsService.AddResponse>

Enclosing interface:

VmBackupsService
```
public static interface VmBackupsService.AddRequest
extends Request<VmBackupsService.AddRequest,VmBackupsService.AddResponse>
```
Adds a new backup entity to a virtual machine. For example, to start a new incremental backup of a virtual machine since checkpoint id `previous-checkpoint-uuid`, send a request like this: [source] ---- POST /ovirt-engine/api/vms/123/backups ---- With a request body like this: [source,xml] ---- previous-checkpoint-uuid ... ---- The response body: [source,xml] ---- previous-checkpoint-uuid new-checkpoint-uuid ... ... initializing ---- To provide the ID of the created backup, send a request like this: [source] ---- POST /ovirt-engine/api/vms/123/backups ---- With a request body like this: [source,xml] ---- previous-checkpoint-uuid ... ----

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`VmBackupsService.AddRequest`	`backup(BackupBuilder backup)`	The information about the virtual machine backup entity.
`VmBackupsService.AddRequest`	`backup(Backup backup)`
`VmBackupsService.AddRequest`	`requireConsistency(Boolean requireConsistency)`	Indicates if the backup will fail if VM failed to freeze or not.
`VmBackupsService.AddRequest`	`useActive(Boolean useActive)`	Indicate whether to use the active volume for performing the backup.

Methods inherited from interface org.ovirt.engine.sdk4.Request
header, query, send

- Method Detail
  - backup
```
VmBackupsService.AddRequest backup(Backup backup)
```
  - backup
```
VmBackupsService.AddRequest backup(BackupBuilder backup)
```
    The information about the virtual machine backup entity.
  - requireConsistency
```
VmBackupsService.AddRequest requireConsistency(Boolean requireConsistency)
```
    Indicates if the backup will fail if VM failed to freeze or not. If requireConsistency=True VM backup will fail in case of a failure to freeze the VM. The REST API call should look like this: .... POST /ovirt-engine/api/vms/123/backups?require_consistency=true .... The default value of the requireConsistency flag is `false`.
  - useActive
```
VmBackupsService.AddRequest useActive(Boolean useActive)
```
    Indicate whether to use the active volume for performing the backup. If useActive=False a snapshot will be created for the backup operation. The REST API call should look like this: .... POST /ovirt-engine/api/vms/123/backups?use_active=false .... The default value of the useActive flag is `false`.