org.ovirt.engine.sdk.decorators

Class VmPool

java.lang.Object

org.ovirt.engine.sdk.entities.ActionableResource

org.ovirt.engine.sdk.entities.BaseResource

org.ovirt.engine.sdk.entities.VmPool

org.ovirt.engine.sdk.decorators.VmPool

public class VmPool
extends VmPool

VmPool providing relation and functional services

to VmPool.

Constructor Summary

Constructors

Constructor and Description
VmPool(HttpProxyBroker proxy)

Method Summary

Methods

Modifier and Type	Method and Description
Action	allocatevm(Action action) Performs allocatevm action.
Action	allocatevm(Action action, String correlationId) Performs allocatevm action.
Action	allocatevm(Action action, String correlationId, Boolean async) Performs allocatevm action.
Response	delete() Deletes object.
Response	delete(Boolean async) Deletes object.
Response	delete(Boolean async, String correlationId) Deletes object.
VmPoolPermissions	getPermissions() Gets the value of the VmPoolPermissions property.
VmPool	update() Updates VmPool object.
VmPool	update(String correlationId) Updates VmPool object.
VmPool	update(String correlationId, Boolean async) Updates VmPool object.
VmPool	update(String correlationId, Boolean async, String expect) Updates VmPool object.

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

getCluster, getDisplay, getMaxUserVms, getPrestartedVms, getRngDevice, getSize, getSoundcardEnabled, getTemplate, getType, getUseLatestTemplateVersion, getVm, isSetCluster, isSetDisplay, isSetMaxUserVms, isSetPrestartedVms, isSetRngDevice, isSetSize, isSetSoundcardEnabled, isSetTemplate, isSetType, isSetUseLatestTemplateVersion, isSetVm, setCluster, setDisplay, setMaxUserVms, setPrestartedVms, setRngDevice, setSize, setSoundcardEnabled, setTemplate, setType, setUseLatestTemplateVersion, 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

VmPool

public VmPool(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

getPermissions

public VmPoolPermissions getPermissions()

Gets the value of the VmPoolPermissions property.

Returns:

VmPoolPermissions

allocatevm

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

Performs allocatevm 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.

allocatevm

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

Performs allocatevm 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.

allocatevm

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

Performs allocatevm action.

Parameters:

action - Action

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

correlationId -

    [any string]
    

async -

    [true|false]
    

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:

async -

    [true|false]
    

correlationId -

    [any string]
    

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.

update

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

Updates VmPool object.

Parameters:

vmpool - VmPool

    [vm_pool.cluster.id|name]
    [vm_pool.template.id|name]
    [vm_pool.name]
    [vm_pool.comment]
    [vm_pool.size]
    [vm_pool.max_user_vms]
    [vm_pool.display.proxy]
    [vm_pool.description]
    [vm_pool.use_latest_template_version]
    [vm_pool.prestarted_vms]
    [vm_pool.type]
    

Returns:

VmPool

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 VmPool update(String correlationId)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Updates VmPool object.

Parameters:

vmpool - VmPool

    [vm_pool.cluster.id|name]
    [vm_pool.template.id|name]
    [vm_pool.name]
    [vm_pool.comment]
    [vm_pool.size]
    [vm_pool.max_user_vms]
    [vm_pool.display.proxy]
    [vm_pool.description]
    [vm_pool.use_latest_template_version]
    [vm_pool.prestarted_vms]
    [vm_pool.type]
    

correlationId -

    [any string]
    

Returns:

VmPool

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 VmPool update(String correlationId,
            Boolean async)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Updates VmPool object.

Parameters:

vmpool - VmPool

    [vm_pool.cluster.id|name]
    [vm_pool.template.id|name]
    [vm_pool.name]
    [vm_pool.comment]
    [vm_pool.size]
    [vm_pool.max_user_vms]
    [vm_pool.display.proxy]
    [vm_pool.description]
    [vm_pool.use_latest_template_version]
    [vm_pool.prestarted_vms]
    [vm_pool.type]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

VmPool

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 VmPool update(String correlationId,
            Boolean async,
            String expect)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Updates VmPool object.

Parameters:

vmpool - VmPool

    [vm_pool.cluster.id|name]
    [vm_pool.template.id|name]
    [vm_pool.name]
    [vm_pool.comment]
    [vm_pool.size]
    [vm_pool.max_user_vms]
    [vm_pool.display.proxy]
    [vm_pool.description]
    [vm_pool.use_latest_template_version]
    [vm_pool.prestarted_vms]
    [vm_pool.type]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

expect -

    [202-accepted]
    

Returns:

VmPool

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.