org.ovirt.engine.sdk.decorators

Class VMTags

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Tag,Tags,VMTag>

org.ovirt.engine.sdk.decorators.VMTags

public class VMTags
extends CollectionDecorator<Tag,Tags,VMTag>

VMTags providing relation and functional services

to Tags.

Constructor Summary

Constructors

Constructor and Description
VMTags(HttpProxyBroker proxy, VM parent)

Method Summary

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

VMTags

public VMTags(HttpProxyBroker proxy,
              VM parent)

Parameters:

proxy - HttpProxyBroker

parent - VM

Method Detail

list

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

Lists VMTag objects.

Specified by:

list in class CollectionDecorator<Tag,Tags,VMTag>

Returns:

List of VMTag

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

Fetches VMTag object by id.

Specified by:

get in class CollectionDecorator<Tag,Tags,VMTag>

Parameters:

id - entity id

Returns:

VMTag

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

Fetches VMTag object by id.

Specified by:

getById in class CollectionDecorator<Tag,Tags,VMTag>

Parameters:

id - entity id

Returns:

VMTag

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

Lists VMTag objects.

Parameters:

max -

    [max results]
    

Returns:

List of VMTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

Returns:

VMTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

expect -

    [201-created]
    

Returns:

VMTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

VMTag

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.