org.ovirt.engine.sdk.decorators

Class VMDisk

java.lang.Object

org.ovirt.engine.sdk.entities.ActionableResource

org.ovirt.engine.sdk.entities.BaseResource

org.ovirt.engine.sdk.entities.BaseDevice

org.ovirt.engine.sdk.entities.Disk

org.ovirt.engine.sdk.decorators.VMDisk

public class VMDisk
extends Disk

VMDisk providing relation and functional services

to Disk.

Constructor Summary

Constructors

Constructor and Description
VMDisk(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Action	activate(Action action) Performs activate action.
Action	activate(Action action, String correlationId) Performs activate action.
Action	deactivate(Action action) Performs deactivate action.
Action	deactivate(Action action, String correlationId) Performs deactivate action.
Response	delete() Deletes object.
Response	delete(Action action, Boolean async) Deletes object.
Response	delete(Action action, Boolean async, String correlationId) Deletes object.
Response	delete(Boolean async) Deletes object.
Response	delete(Boolean async, String correlationId) Deletes object.
Action	exportDisk(Action action) Performs exportDisk action.
Action	exportDisk(Action action, String correlationId) Performs exportDisk action.
VMDiskPermissions	getPermissions() Gets the value of the VMDiskPermissions property.
VMDiskStatistics	getStatistics() Gets the value of the VMDiskStatistics property.
Action	move(Action action) Performs move action.
Action	move(Action action, String correlationId) Performs move action.
VMDisk	update() Updates VMDisk object.
VMDisk	update(String correlationId) Updates VMDisk object.

Methods inherited from class org.ovirt.engine.sdk.entities.Disk

getActive, getActualSize, getAlias, getBootable, getDiskProfile, getFormat, getImageId, getInterface, getLogicalName, getLunStorage, getPropagateErrors, getProvisionedSize, getQuota, getReadOnly, getSgio, getShareable, getSize, getSnapshot, getSparse, getStatus, getStorageDomain, getStorageDomains, getType, getWipeAfterDelete, isSetActive, isSetActualSize, isSetAlias, isSetBootable, isSetDiskProfile, isSetFormat, isSetImageId, isSetInterface, isSetLogicalName, isSetLunStorage, isSetPropagateErrors, isSetProvisionedSize, isSetQuota, isSetReadOnly, isSetSgio, isSetShareable, isSetSize, isSetSnapshot, isSetSparse, isSetStatistics, isSetStatus, isSetStorageDomain, isSetStorageDomains, isSetType, isSetWipeAfterDelete, setActive, setActualSize, setAlias, setBootable, setDiskProfile, setFormat, setImageId, setInterface, setLogicalName, setLunStorage, setPropagateErrors, setProvisionedSize, setQuota, setReadOnly, setSgio, setShareable, setSize, setSnapshot, setSparse, setStatistics, setStatus, setStorageDomain, setStorageDomains, setType, setWipeAfterDelete

Methods inherited from class org.ovirt.engine.sdk.entities.BaseDevice

getTemplate, getVm, isSetTemplate, isSetVm, setTemplate, setVm

Methods inherited from class org.ovirt.engine.sdk.entities.BaseResource

getComment, getCreationStatus, getDescription, getHref, getId, getLinks, getName, isSetComment, isSetCreationStatus, isSetDescription, isSetHref, isSetId, isSetLinks, isSetName, setComment, setCreationStatus, setDescription, setHref, setId, setName, unsetLinks

Methods inherited from class org.ovirt.engine.sdk.entities.ActionableResource

getActions, isSetActions, setActions

Methods inherited from class java.lang.Object

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

Constructor Detail

VMDisk

public VMDisk(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

getPermissions

public VMDiskPermissions getPermissions()

Gets the value of the VMDiskPermissions property.

Returns:

VMDiskPermissions

getStatistics

public VMDiskStatistics getStatistics()

Gets the value of the VMDiskStatistics property.

Overrides:

getStatistics in class Disk

Returns:

VMDiskStatistics

activate

public Action activate(Action action)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

activate

public Action activate(Action action,
                       String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public VMDisk update()
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Updates VMDisk object.

Parameters:

disk - Disk

    [size]
    [provisioned_size]
    [disk.interface]
    [disk.format]
    [disk.sparse]
    [disk.bootable]
    [disk.shareable]
    [disk.propagate_errors]
    [disk.wipe_after_delete]
    [disk.quota.id]
    [disk.disk_profile.id]
    [disk.sgio]
    [disk.read_only]
    [description]
    

Returns:

VMDisk

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public VMDisk update(String correlationId)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Updates VMDisk object.

Parameters:

disk - Disk

    [size]
    [provisioned_size]
    [disk.interface]
    [disk.format]
    [disk.sparse]
    [disk.bootable]
    [disk.shareable]
    [disk.propagate_errors]
    [disk.wipe_after_delete]
    [disk.quota.id]
    [disk.disk_profile.id]
    [disk.sgio]
    [disk.read_only]
    [description]
    

correlationId -

    [any string]
    

Returns:

VMDisk

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

exportDisk

public Action exportDisk(Action action)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs exportDisk action.

Parameters:

action - Action

    storagedomain.id|name
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

exportDisk

public Action exportDisk(Action action,
                         String correlationId)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs exportDisk action.

Parameters:

action - Action

    storagedomain.id|name
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Boolean async,
                       String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Action action,
                       Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

action - Action

    action.detach
    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Action action,
                       Boolean async,
                       String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

action - Action

    action.detach
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action,
                         String correlationId)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

move

public Action move(Action action)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Performs move action.

Parameters:

action - Action

    storagedomain.id|name
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

move

public Action move(Action action,
                   String correlationId)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Performs move action.

Parameters:

action - Action

    storagedomain.id|name
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.