org.ovirt.engine.sdk.decorators

Class Clusters

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Cluster,Clusters,Cluster>

org.ovirt.engine.sdk.decorators.Clusters

public class Clusters
extends CollectionDecorator<Cluster,Clusters,Cluster>

Clusters providing relation and functional services

to Clusters.

Constructor Summary

Constructors

Constructor and Description
Clusters(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Cluster	add(Cluster cluster) Adds Cluster object.
Cluster	add(Cluster cluster, String expect) Adds Cluster object.
Cluster	add(Cluster cluster, String expect, String correlationId) Adds Cluster object.
Cluster	get(UUID id) Fetches Cluster object by id.
Cluster	getById(String id) Fetches Cluster object by id.
List<Cluster>	list() Lists Cluster objects.
List<Cluster>	list(String query, Boolean caseSensitive, Integer max) Lists Cluster 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

Clusters

public Clusters(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Cluster objects.

Specified by:

list in class CollectionDecorator<Cluster,Clusters,Cluster>

Returns:

List of Cluster

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 Cluster get(UUID id)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Fetches Cluster object by id.

Specified by:

get in class CollectionDecorator<Cluster,Clusters,Cluster>

Parameters:

id - entity id

Returns:

Cluster

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 Cluster getById(String id)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Fetches Cluster object by id.

Specified by:

getById in class CollectionDecorator<Cluster,Clusters,Cluster>

Parameters:

id - entity id

Returns:

Cluster

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<Cluster> list(String query,
                          Boolean caseSensitive,
                          Integer max)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Lists Cluster objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of Cluster

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 Cluster add(Cluster cluster)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Adds Cluster object.

Parameters:

cluster - Cluster

    cluster.data_center.id|name
    cluster.name
    cluster.version.major
    cluster.version.minor
    cluster.cpu.id
    [cluster.description]
    [cluster.comment]
    [cluster.memory_policy.overcommit.percent]
    [cluster.memory_policy.transparent_hugepages.enabled]
    [cluster.scheduling_policy.policy]
    [cluster.scheduling_policy.thresholds.low]
    [cluster.scheduling_policy.thresholds.high]
    [cluster.scheduling_policy.thresholds.duration]
    [cluster.scheduling_policy.id]
    [cluster.scheduling_policy.properties.property]
    [cluster.error_handling.on_error]
    [cluster.virt_service]
    [cluster.gluster_service]
    [cluster.threads_as_cores]
    [cluster.tunnel_migration]
    [cluster.trusted_service]
    [cluster.ha_reservation]
    [cluster.ballooning_enabled]
    [cluster.cpu.architecture]
    [cluster.display.proxy]
    [cluster.ksm.enabled]
    

Returns:

Cluster

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 Cluster add(Cluster cluster,
                   String expect)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Adds Cluster object.

Parameters:

cluster - Cluster

    cluster.data_center.id|name
    cluster.name
    cluster.version.major
    cluster.version.minor
    cluster.cpu.id
    [cluster.description]
    [cluster.comment]
    [cluster.memory_policy.overcommit.percent]
    [cluster.memory_policy.transparent_hugepages.enabled]
    [cluster.scheduling_policy.policy]
    [cluster.scheduling_policy.thresholds.low]
    [cluster.scheduling_policy.thresholds.high]
    [cluster.scheduling_policy.thresholds.duration]
    [cluster.scheduling_policy.id]
    [cluster.scheduling_policy.properties.property]
    [cluster.error_handling.on_error]
    [cluster.virt_service]
    [cluster.gluster_service]
    [cluster.threads_as_cores]
    [cluster.tunnel_migration]
    [cluster.trusted_service]
    [cluster.ha_reservation]
    [cluster.ballooning_enabled]
    [cluster.cpu.architecture]
    [cluster.display.proxy]
    [cluster.ksm.enabled]
    

expect -

    [201-created]
    

Returns:

Cluster

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 Cluster add(Cluster cluster,
                   String expect,
                   String correlationId)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Adds Cluster object.

Parameters:

cluster - Cluster

    cluster.data_center.id|name
    cluster.name
    cluster.version.major
    cluster.version.minor
    cluster.cpu.id
    [cluster.description]
    [cluster.comment]
    [cluster.memory_policy.overcommit.percent]
    [cluster.memory_policy.transparent_hugepages.enabled]
    [cluster.scheduling_policy.policy]
    [cluster.scheduling_policy.thresholds.low]
    [cluster.scheduling_policy.thresholds.high]
    [cluster.scheduling_policy.thresholds.duration]
    [cluster.scheduling_policy.id]
    [cluster.scheduling_policy.properties.property]
    [cluster.error_handling.on_error]
    [cluster.virt_service]
    [cluster.gluster_service]
    [cluster.threads_as_cores]
    [cluster.tunnel_migration]
    [cluster.trusted_service]
    [cluster.ha_reservation]
    [cluster.ballooning_enabled]
    [cluster.cpu.architecture]
    [cluster.display.proxy]
    [cluster.ksm.enabled]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

Cluster

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.