org.ovirt.engine.sdk.decorators

Class Networks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.Networks

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

Networks providing relation and functional services

to Networks.

Constructor Summary

Constructors

Constructor and Description
Networks(HttpProxyBroker proxy)

Method Summary

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

Networks

public Networks(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Network objects.

Specified by:

list in class CollectionDecorator<Network,Networks,Network>

Returns:

List of Network

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

Fetches Network object by id.

Specified by:

get in class CollectionDecorator<Network,Networks,Network>

Parameters:

id - entity id

Returns:

Network

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

Fetches Network object by id.

Specified by:

getById in class CollectionDecorator<Network,Networks,Network>

Parameters:

id - entity id

Returns:

Network

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

Lists Network objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of Network

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

Adds Network object.

Parameters:

network - Network

    network.data_center.id|name
    network.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:

Network

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

Adds Network object.

Parameters:

network - Network

    network.data_center.id|name
    network.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:

Network

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

Adds Network object.

Parameters:

network - Network

    network.data_center.id|name
    network.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:

Network

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.