org.ovirt.engine.sdk.decorators

Class HostTags

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.HostTags

public class HostTags
extends CollectionDecorator<Tag,Tags,HostTag>

HostTags providing relation and functional services

to Tags.

Constructor Summary

Constructors

Constructor and Description
HostTags(HttpProxyBroker proxy, Host parent)

Method Summary

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

HostTags

public HostTags(HttpProxyBroker proxy,
                Host parent)

Parameters:

proxy - HttpProxyBroker

parent - Host

Method Detail

list

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

Lists HostTag objects.

Specified by:

list in class CollectionDecorator<Tag,Tags,HostTag>

Returns:

List of HostTag

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

Fetches HostTag object by id.

Specified by:

get in class CollectionDecorator<Tag,Tags,HostTag>

Parameters:

id - entity id

Returns:

HostTag

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

Fetches HostTag object by id.

Specified by:

getById in class CollectionDecorator<Tag,Tags,HostTag>

Parameters:

id - entity id

Returns:

HostTag

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

Lists HostTag objects.

Parameters:

max -

    [max results]
    

Returns:

List of HostTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

Returns:

HostTag

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 HostTag 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:

HostTag

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 HostTag 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:

HostTag

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.