Package org.ovirt.engine.sdk4.services

Interface VmService.PreviewSnapshotRequest

All Superinterfaces:

Request<VmService.PreviewSnapshotRequest,VmService.PreviewSnapshotResponse>

Enclosing interface:

VmService

public static interface VmService.PreviewSnapshotRequest
extends Request<VmService.PreviewSnapshotRequest,VmService.PreviewSnapshotResponse>

Temporarily restores the virtual machine to the state of a snapshot. The snapshot is indicated with the `snapshot.id` parameter. It is restored temporarily, so that the content can be inspected. Once that inspection is finished, the state of the virtual machine can be made permanent, using the <> method, or discarded using the <> method.

Method Summary

Modifier and Type	Method	Description
VmService.PreviewSnapshotRequest	async(Boolean async)	Indicates if the preview should be performed asynchronously.
VmService.PreviewSnapshotRequest	disks(List<Disk> disks)
VmService.PreviewSnapshotRequest	disks(DiskBuilder... disks)	Specify the disks included in the snapshot's preview.
VmService.PreviewSnapshotRequest	disks(Disk... disks)	Specify the disks included in the snapshot's preview.
VmService.PreviewSnapshotRequest	lease(StorageDomainLeaseBuilder lease)	Specify the lease storage domain ID to use in the preview of the snapshot.
VmService.PreviewSnapshotRequest	lease(StorageDomainLease lease)
VmService.PreviewSnapshotRequest	restoreMemory(Boolean restoreMemory)
VmService.PreviewSnapshotRequest	snapshot(SnapshotBuilder snapshot)
VmService.PreviewSnapshotRequest	snapshot(Snapshot snapshot)
VmService.PreviewSnapshotRequest	vm(VmBuilder vm)
VmService.PreviewSnapshotRequest	vm(Vm vm)

Methods inherited from interface org.ovirt.engine.sdk4.Request

header, query, send

Method Detail

async

VmService.PreviewSnapshotRequest async(Boolean async)

Indicates if the preview should be performed asynchronously.

disks

VmService.PreviewSnapshotRequest disks(List<Disk> disks)

disks

VmService.PreviewSnapshotRequest disks(Disk... disks)

Specify the disks included in the snapshot's preview. For each disk parameter, it is also required to specify its `image_id`. For example, to preview a snapshot with identifier `456` which includes a disk with identifier `111` and its `image_id` as `222`, send a request like this: [source] ---- POST /ovirt-engine/api/vms/123/previewsnapshot ---- Request body: [source,xml] ---- 222 ----

disks

VmService.PreviewSnapshotRequest disks(DiskBuilder... disks)

Specify the disks included in the snapshot's preview. For each disk parameter, it is also required to specify its `image_id`. For example, to preview a snapshot with identifier `456` which includes a disk with identifier `111` and its `image_id` as `222`, send a request like this: [source] ---- POST /ovirt-engine/api/vms/123/previewsnapshot ---- Request body: [source,xml] ---- 222 ----

lease

VmService.PreviewSnapshotRequest lease(StorageDomainLease lease)

lease

VmService.PreviewSnapshotRequest lease(StorageDomainLeaseBuilder lease)

Specify the lease storage domain ID to use in the preview of the snapshot. If lease parameter is not passed, then the previewed snapshot lease storage domain will be used. If lease parameter is passed with empty storage domain parameter, then no lease will be used for the snapshot preview. If lease parameter is passed with storage domain parameter then the storage domain ID can be only one of the leases domain IDs that belongs to one of the virtual machine snapshots. This is an optional parameter, set by default to `null`

restoreMemory

VmService.PreviewSnapshotRequest restoreMemory(Boolean restoreMemory)

snapshot

VmService.PreviewSnapshotRequest snapshot(Snapshot snapshot)

snapshot

VmService.PreviewSnapshotRequest snapshot(SnapshotBuilder snapshot)

vm

VmService.PreviewSnapshotRequest vm(Vm vm)

vm

VmService.PreviewSnapshotRequest vm(VmBuilder vm)