org.ovirt.engine.sdk.decorators

Class DataCenters

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<DataCenter,DataCenters,DataCenter>

org.ovirt.engine.sdk.decorators.DataCenters

public class DataCenters
extends CollectionDecorator<DataCenter,DataCenters,DataCenter>

DataCenters providing relation and functional services

to DataCenters.

Constructor Summary

Constructors

Constructor and Description
DataCenters(HttpProxyBroker proxy)

Method Summary

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

DataCenters

public DataCenters(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists DataCenter objects.

Specified by:

list in class CollectionDecorator<DataCenter,DataCenters,DataCenter>

Returns:

List of DataCenter

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

Fetches DataCenter object by id.

Specified by:

get in class CollectionDecorator<DataCenter,DataCenters,DataCenter>

Parameters:

id - entity id

Returns:

DataCenter

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

Fetches DataCenter object by id.

Specified by:

getById in class CollectionDecorator<DataCenter,DataCenters,DataCenter>

Parameters:

id - entity id

Returns:

DataCenter

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

Lists DataCenter objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of DataCenter

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

Adds DataCenter object.

Parameters:

datacenter - DataCenter

    datacenter.local
    datacenter.name
    [datacenter.comment]
    [datacenter.description]
    [datacenter.storage_format]
    [datacenter.storage_type]
    [datacenter.version.major]
    [datacenter.version.minor]
    

Returns:

DataCenter

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

Adds DataCenter object.

Parameters:

datacenter - DataCenter

    datacenter.local
    datacenter.name
    [datacenter.comment]
    [datacenter.description]
    [datacenter.storage_format]
    [datacenter.storage_type]
    [datacenter.version.major]
    [datacenter.version.minor]
    

expect -

    [201-created]
    

Returns:

DataCenter

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

Adds DataCenter object.

Parameters:

datacenter - DataCenter

    datacenter.local
    datacenter.name
    [datacenter.comment]
    [datacenter.description]
    [datacenter.storage_format]
    [datacenter.storage_type]
    [datacenter.version.major]
    [datacenter.version.minor]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

DataCenter

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.