org.ovirt.engine.sdk.decorators

Class TemplateNICs

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.TemplateNICs

public class TemplateNICs
extends CollectionDecorator<NIC,Nics,TemplateNIC>

TemplateNICs providing relation and functional services

to Nics.

Constructor Summary

Constructors

Constructor and Description
TemplateNICs(HttpProxyBroker proxy, Template parent)

Method Summary

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

TemplateNICs

public TemplateNICs(HttpProxyBroker proxy,
                    Template parent)

Parameters:

proxy - HttpProxyBroker

parent - Template

Method Detail

list

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

Lists TemplateNIC objects.

Specified by:

list in class CollectionDecorator<NIC,Nics,TemplateNIC>

Returns:

List of TemplateNIC

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

Fetches TemplateNIC object by id.

Specified by:

get in class CollectionDecorator<NIC,Nics,TemplateNIC>

Parameters:

id - entity id

Returns:

TemplateNIC

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

Fetches TemplateNIC object by id.

Specified by:

getById in class CollectionDecorator<NIC,Nics,TemplateNIC>

Parameters:

id - entity id

Returns:

TemplateNIC

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

Lists TemplateNIC objects.

Parameters:

max -

    [max results]
    

Returns:

List of TemplateNIC

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

Adds NIC object.

Parameters:

nic - NIC

    Overload 1:

      add a new network interface
      card to the template using a
      virtual network interface card
      profile

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

    Overload 2:

      add a new network interface
      card to the template using a
      network with optional port
      mirroring options. This has
      been deprecated

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

Returns:

TemplateNIC

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 TemplateNIC 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
      card to the template using a
      virtual network interface card
      profile

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

    Overload 2:

      add a new network interface
      card to the template using a
      network with optional port
      mirroring options. This has
      been deprecated

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

expect -

    [201-created]
    

Returns:

TemplateNIC

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 TemplateNIC 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
      card to the template using a
      virtual network interface card
      profile

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

    Overload 2:

      add a new network interface
      card to the template using a
      network with optional port
      mirroring options. This has
      been deprecated

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

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

TemplateNIC

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.