org.ovirt.engine.sdk.decorators

Class VMNICs

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<NIC,Nics,VMNIC>

org.ovirt.engine.sdk.decorators.VMNICs

public class VMNICs
extends CollectionDecorator<NIC,Nics,VMNIC>

VMNICs providing relation and functional services

to Nics.

Constructor Summary

Constructors

Constructor and Description
VMNICs(HttpProxyBroker proxy, VM parent)

Method Summary

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

VMNICs

public VMNICs(HttpProxyBroker proxy,
              VM parent)

Parameters:

proxy - HttpProxyBroker

parent - VM

Method Detail

list

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

Lists VMNIC objects.

Specified by:

list in class CollectionDecorator<NIC,Nics,VMNIC>

Returns:

List of VMNIC

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

Fetches VMNIC object by id.

Specified by:

get in class CollectionDecorator<NIC,Nics,VMNIC>

Parameters:

id - entity id

Returns:

VMNIC

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

Fetches VMNIC object by id.

Specified by:

getById in class CollectionDecorator<NIC,Nics,VMNIC>

Parameters:

id - entity id

Returns:

VMNIC

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

Lists VMNIC objects.

Parameters:

max -

    [max results]
    

Returns:

List of VMNIC

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

Lists VMNIC objects.

Parameters:

allContent -

    [true|false]
    

max -

    [max results]
    

Returns:

List of VMNIC

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

Adds NIC object.

Parameters:

nic - NIC

    Overload 1:

      add a new network interface to
      the given virtual machine with
      vnic profile id

      nic.name
      [nic.vnic_profile.id]
      [nic.linked]
      [nic.mac.address]
      [nic.interface]
      [nic.plugged]

    Overload 2:

      add a new network interface to
      the given virtual machine with
      port mirroring options

      nic.name
      [nic.network.id|name]
      [nic.linked]
      [nic.mac.address]
      [nic.interface]
      [nic.port_mirroring.networks.network]
      [nic.plugged]
    

Returns:

VMNIC

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

Adds NIC object.

Parameters:

nic - NIC

    Overload 1:

      add a new network interface to
      the given virtual machine with
      vnic profile id

      nic.name
      [nic.vnic_profile.id]
      [nic.linked]
      [nic.mac.address]
      [nic.interface]
      [nic.plugged]

    Overload 2:

      add a new network interface to
      the given virtual machine with
      port mirroring options

      nic.name
      [nic.network.id|name]
      [nic.linked]
      [nic.mac.address]
      [nic.interface]
      [nic.port_mirroring.networks.network]
      [nic.plugged]
    

expect -

    [201-created]
    

Returns:

VMNIC

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

Adds NIC object.

Parameters:

nic - NIC

    Overload 1:

      add a new network interface to
      the given virtual machine with
      vnic profile id

      nic.name
      [nic.vnic_profile.id]
      [nic.linked]
      [nic.mac.address]
      [nic.interface]
      [nic.plugged]

    Overload 2:

      add a new network interface to
      the given virtual machine with
      port mirroring options

      nic.name
      [nic.network.id|name]
      [nic.linked]
      [nic.mac.address]
      [nic.interface]
      [nic.port_mirroring.networks.network]
      [nic.plugged]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

VMNIC

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.