org.ovirt.engine.sdk.decorators

Class DataCenterNetworks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Network,Networks,DataCenterNetwork>

org.ovirt.engine.sdk.decorators.DataCenterNetworks

public class DataCenterNetworks
extends CollectionDecorator<Network,Networks,DataCenterNetwork>

DataCenterNetworks providing relation and functional services

to Networks.

Constructor Summary

Constructors

Constructor and Description
DataCenterNetworks(HttpProxyBroker proxy, DataCenter parent)

Method Summary

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

DataCenterNetworks

public DataCenterNetworks(HttpProxyBroker proxy,
                          DataCenter parent)

Parameters:

proxy - HttpProxyBroker

parent - DataCenter

Method Detail

list

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

Lists DataCenterNetwork objects.

Specified by:

list in class CollectionDecorator<Network,Networks,DataCenterNetwork>

Returns:

List of DataCenterNetwork

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

Fetches DataCenterNetwork object by id.

Specified by:

get in class CollectionDecorator<Network,Networks,DataCenterNetwork>

Parameters:

id - entity id

Returns:

DataCenterNetwork

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

Fetches DataCenterNetwork object by id.

Specified by:

getById in class CollectionDecorator<Network,Networks,DataCenterNetwork>

Parameters:

id - entity id

Returns:

DataCenterNetwork

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<DataCenterNetwork> list(Integer max)
                             throws org.apache.http.client.ClientProtocolException,
                                    ServerException,
                                    IOException

Lists DataCenterNetwork objects.

Parameters:

max -

    [max results]
    

Returns:

List of DataCenterNetwork

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

Adds Network object.

Parameters:

network - Network

    network.id|name
    [network.description]
    [network.comment]
    [network.vlan.id]
    [network.ip.address]
    [network.ip.gateway]
    [network.ip.netmask]
    [network.stp]
    [network.mtu]
    [network.profile_required]
    [network.usages.usage]
    

Returns:

DataCenterNetwork

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

Adds Network object.

Parameters:

network - Network

    network.id|name
    [network.description]
    [network.comment]
    [network.vlan.id]
    [network.ip.address]
    [network.ip.gateway]
    [network.ip.netmask]
    [network.stp]
    [network.mtu]
    [network.profile_required]
    [network.usages.usage]
    

expect -

    [201-created]
    

Returns:

DataCenterNetwork

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

Adds Network object.

Parameters:

network - Network

    network.id|name
    [network.description]
    [network.comment]
    [network.vlan.id]
    [network.ip.address]
    [network.ip.gateway]
    [network.ip.netmask]
    [network.stp]
    [network.mtu]
    [network.profile_required]
    [network.usages.usage]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

DataCenterNetwork

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.