org.ovirt.engine.sdk.decorators

Class ClusterNetworks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.ClusterNetworks

public class ClusterNetworks
extends CollectionDecorator<Network,Networks,ClusterNetwork>

ClusterNetworks providing relation and functional services

to Networks.

Constructor Summary

Constructors

Constructor and Description
ClusterNetworks(HttpProxyBroker proxy, Cluster parent)

Method Summary

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

ClusterNetworks

public ClusterNetworks(HttpProxyBroker proxy,
                       Cluster parent)

Parameters:

proxy - HttpProxyBroker

parent - Cluster

Method Detail

list

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

Lists ClusterNetwork objects.

Specified by:

list in class CollectionDecorator<Network,Networks,ClusterNetwork>

Returns:

List of ClusterNetwork

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

Fetches ClusterNetwork object by id.

Specified by:

get in class CollectionDecorator<Network,Networks,ClusterNetwork>

Parameters:

id - entity id

Returns:

ClusterNetwork

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

Fetches ClusterNetwork object by id.

Specified by:

getById in class CollectionDecorator<Network,Networks,ClusterNetwork>

Parameters:

id - entity id

Returns:

ClusterNetwork

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

Lists ClusterNetwork objects.

Parameters:

max -

    [max results]
    

Returns:

List of ClusterNetwork

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

Adds Network object.

Parameters:

network - Network

    network.id|name
    [network.usages.usage]
    

Returns:

ClusterNetwork

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

Adds Network object.

Parameters:

network - Network

    network.id|name
    [network.usages.usage]
    

expect -

    [201-created]
    

Returns:

ClusterNetwork

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 ClusterNetwork 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.usages.usage]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

ClusterNetwork

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.