org.ovirt.engine.sdk.decorators

Class HostNICs

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<HostNIC,HostNics,HostNIC>

org.ovirt.engine.sdk.decorators.HostNICs

public class HostNICs
extends CollectionDecorator<HostNIC,HostNics,HostNIC>

HostNICs providing relation and functional services

to HostNics.

Constructor Summary

Constructors

Constructor and Description
HostNICs(HttpProxyBroker proxy, Host parent)

Method Summary

Modifier and Type	Method and Description
HostNIC	add(HostNIC hostnic) Adds HostNIC object.
HostNIC	add(HostNIC hostnic, String expect) Adds HostNIC object.
HostNIC	add(HostNIC hostnic, String expect, String correlationId) Adds HostNIC object.
HostNIC	get(UUID id) Fetches HostNIC object by id.
HostNIC	getById(String id) Fetches HostNIC object by id.
List<HostNIC>	list() Lists HostNIC objects.
List<HostNIC>	list(Integer max) Lists HostNIC objects.
Action	setupnetworks(Action action) Performs setupnetworks action.
Action	setupnetworks(Action action, String correlationId) Performs setupnetworks action.

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

HostNICs

public HostNICs(HttpProxyBroker proxy,
                Host parent)

Parameters:

proxy - HttpProxyBroker

parent - Host

Method Detail

list

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

Lists HostNIC objects.

Specified by:

list in class CollectionDecorator<HostNIC,HostNics,HostNIC>

Returns:

List of HostNIC

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

Fetches HostNIC object by id.

Specified by:

get in class CollectionDecorator<HostNIC,HostNics,HostNIC>

Parameters:

id - entity id

Returns:

HostNIC

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

Fetches HostNIC object by id.

Specified by:

getById in class CollectionDecorator<HostNIC,HostNics,HostNIC>

Parameters:

id - entity id

Returns:

HostNIC

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.

setupnetworks

public Action setupnetworks(Action action)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs setupnetworks action.

Parameters:

action - Action

    [action.host_nics.host_nic]
    [action.checkConnectivity]
    [action.connectivityTimeout]
    [action.force]
    

Returns:

Action

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.

setupnetworks

public Action setupnetworks(Action action,
                            String correlationId)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs setupnetworks action.

Parameters:

action - Action

    [action.host_nics.host_nic]
    [action.checkConnectivity]
    [action.connectivityTimeout]
    [action.force]
    

correlationId -

    [any string]
    

Returns:

Action

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

Lists HostNIC objects.

Parameters:

max -

    [max results]
    

Returns:

List of HostNIC

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

Adds HostNIC object.

Parameters:

hostnic - HostNIC

    hostnic.network.id|name
    hostnic.name
    hostnic.bonding.slaves.host_nic
    [hostnic.bonding.options.option]
    

Returns:

HostNIC

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

Adds HostNIC object.

Parameters:

hostnic - HostNIC

    hostnic.network.id|name
    hostnic.name
    hostnic.bonding.slaves.host_nic
    [hostnic.bonding.options.option]
    

expect -

    [201-created]
    

Returns:

HostNIC

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

Adds HostNIC object.

Parameters:

hostnic - HostNIC

    hostnic.network.id|name
    hostnic.name
    hostnic.bonding.slaves.host_nic
    [hostnic.bonding.options.option]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

HostNIC

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.