org.ovirt.engine.sdk.decorators

Class VmPools

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<VmPool,VmPools,VmPool>

org.ovirt.engine.sdk.decorators.VmPools

public class VmPools
extends CollectionDecorator<VmPool,VmPools,VmPool>

VmPools providing relation and functional services

to VmPools.

Constructor Summary

Constructors

Constructor and Description
VmPools(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
VmPool	add(VmPool vmpool) Adds VmPool object.
VmPool	add(VmPool vmpool, String expect) Adds VmPool object.
VmPool	add(VmPool vmpool, String expect, String correlationId) Adds VmPool object.
VmPool	get(UUID id) Fetches VmPool object by id.
VmPool	getById(String id) Fetches VmPool object by id.
List<VmPool>	list() Lists VmPool objects.
List<VmPool>	list(String query, Boolean caseSensitive, Integer max) Lists VmPool objects.

Methods inherited from class org.ovirt.engine.sdk.common.CollectionDecorator

get

Methods inherited from class java.lang.Object

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

Constructor Detail

VmPools

public VmPools(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

public List<VmPool> list()
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Lists VmPool objects.

Specified by:

list in class CollectionDecorator<VmPool,VmPools,VmPool>

Returns:

List of 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.

get

public VmPool get(UUID id)
           throws org.apache.http.client.ClientProtocolException,
                  ServerException,
                  IOException

Fetches VmPool object by id.

Specified by:

get in class CollectionDecorator<VmPool,VmPools,VmPool>

Parameters:

id - entity id

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.

getById

public VmPool getById(String id)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Fetches VmPool object by id.

Specified by:

getById in class CollectionDecorator<VmPool,VmPools,VmPool>

Parameters:

id - entity id

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.

list

public List<VmPool> list(String query,
                         Boolean caseSensitive,
                         Integer max)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Lists VmPool objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of 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.

add

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

Adds VmPool object.

Parameters:

vmpool - VmPool

    vmpool.cluster.id|name
    vmpool.template.id|name
    vmpool.name
    [vmpool.comment]
    [vmpool.size]
    [vmpool.max_user_vms]
    [vmpool.display.proxy]
    [vmpool.description]
    [vmpool.soundcard_enabled]
    

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.

add

public VmPool add(VmPool vmpool,
                  String expect)
           throws org.apache.http.client.ClientProtocolException,
                  ServerException,
                  IOException

Adds VmPool object.

Parameters:

vmpool - VmPool

    vmpool.cluster.id|name
    vmpool.template.id|name
    vmpool.name
    [vmpool.comment]
    [vmpool.size]
    [vmpool.max_user_vms]
    [vmpool.display.proxy]
    [vmpool.description]
    [vmpool.soundcard_enabled]
    

expect -

    [201-created]
    

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.

add

public VmPool add(VmPool vmpool,
                  String expect,
                  String correlationId)
           throws org.apache.http.client.ClientProtocolException,
                  ServerException,
                  IOException

Adds VmPool object.

Parameters:

vmpool - VmPool

    vmpool.cluster.id|name
    vmpool.template.id|name
    vmpool.name
    [vmpool.comment]
    [vmpool.size]
    [vmpool.max_user_vms]
    [vmpool.display.proxy]
    [vmpool.description]
    [vmpool.soundcard_enabled]
    

expect -

    [201-created]
    

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.