Package org.ovirt.engine.sdk4.services

Interface ImageTransfersService

All Superinterfaces:

Service

All Known Implementing Classes:

ImageTransfersServiceImpl

public interface ImageTransfersService
extends Service

This service manages image transfers, for performing Image I/O API in {product-name}. Please refer to <> for further documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ImageTransfersService.AddForDiskRequest
static interface	ImageTransfersService.AddForDiskResponse
static interface	ImageTransfersService.AddForImageRequest
static interface	ImageTransfersService.AddForImageResponse
static interface	ImageTransfersService.AddForSnapshotRequest
static interface	ImageTransfersService.AddForSnapshotResponse
static interface	ImageTransfersService.AddRequest	Add a new image transfer.
static interface	ImageTransfersService.AddResponse	Add a new image transfer.
static interface	ImageTransfersService.ListRequest	Retrieves the list of image transfers that are currently being performed.
static interface	ImageTransfersService.ListResponse	Retrieves the list of image transfers that are currently being performed.

Method Summary

Modifier and Type	Method	Description
ImageTransfersService.AddRequest	add()	Add a new image transfer.
ImageTransfersService.AddForDiskRequest	addForDisk()
ImageTransfersService.AddForImageRequest	addForImage()
ImageTransfersService.AddForSnapshotRequest	addForSnapshot()
ImageTransferService	imageTransferService(String id)	Returns a reference to the service that manages an specific image transfer.
ImageTransfersService.ListRequest	list()	Retrieves the list of image transfers that are currently being performed.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.

Method Detail

add

ImageTransfersService.AddRequest add()

Add a new image transfer. An image, disk or disk snapshot needs to be specified in order to make a new transfer. IMPORTANT: The `image` attribute is deprecated since version 4.2 of the engine. Use the `disk` or `snapshot` attributes instead. *Creating a new image transfer for downloading or uploading a `disk`:* To create an image transfer to download or upload a disk with id `123`, send the following request: [source] ---- POST /ovirt-engine/api/imagetransfers ---- With a request body like this: [source,xml] ---- upload|download ---- *Creating a new image transfer for downloading or uploading a `disk_snapshot`:* To create an image transfer to download or upload a `disk_snapshot` with id `456`, send the following request: [source] ---- POST /ovirt-engine/api/imagetransfers ---- With a request body like this: [source,xml] ---- download|upload ----

addForDisk

ImageTransfersService.AddForDiskRequest addForDisk()

addForImage

ImageTransfersService.AddForImageRequest addForImage()

addForSnapshot

ImageTransfersService.AddForSnapshotRequest addForSnapshot()

list

ImageTransfersService.ListRequest list()

Retrieves the list of image transfers that are currently being performed. The order of the returned list of image transfers is not guaranteed.

imageTransferService

ImageTransferService imageTransferService(String id)

Returns a reference to the service that manages an specific image transfer.

service

Service service(String path)

Service locator method, returns individual service on which the URI is dispatched.