org.ovirt.engine.sdk.decorators

Class VMGraphicsConsoles

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<GraphicsConsole,GraphicsConsoles,VMGraphicsConsole>

org.ovirt.engine.sdk.decorators.VMGraphicsConsoles

public class VMGraphicsConsoles
extends CollectionDecorator<GraphicsConsole,GraphicsConsoles,VMGraphicsConsole>

VMGraphicsConsoles providing relation and functional services

to GraphicsConsoles.

Constructor Summary

Constructors

Constructor and Description
VMGraphicsConsoles(HttpProxyBroker proxy, VM parent)

Method Summary

Methods

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

VMGraphicsConsoles

public VMGraphicsConsoles(HttpProxyBroker proxy,
                  VM parent)

Parameters:

proxy - HttpProxyBroker

parent - VM

Method Detail

list

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

Lists VMGraphicsConsole objects.

Specified by:

list in class CollectionDecorator<GraphicsConsole,GraphicsConsoles,VMGraphicsConsole>

Returns:

List of VMGraphicsConsole

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

Fetches VMGraphicsConsole object by id.

Specified by:

get in class CollectionDecorator<GraphicsConsole,GraphicsConsoles,VMGraphicsConsole>

Parameters:

id - entity id

Returns:

VMGraphicsConsole

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

Fetches VMGraphicsConsole object by id.

Specified by:

getById in class CollectionDecorator<GraphicsConsole,GraphicsConsoles,VMGraphicsConsole>

Parameters:

id - entity id

Returns:

VMGraphicsConsole

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

Adds GraphicsConsole object.

Parameters:

graphicsconsole - GraphicsConsole

    graphics_console.protocol
    

Returns:

VMGraphicsConsole

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 VMGraphicsConsole add(GraphicsConsole graphicsconsole,
                    String correlationId)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Adds GraphicsConsole object.

Parameters:

graphicsconsole - GraphicsConsole

    graphics_console.protocol
    

correlationId -

    [any string]
    

Returns:

VMGraphicsConsole

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

Adds GraphicsConsole object.

Parameters:

graphicsconsole - GraphicsConsole

    graphics_console.protocol
    

correlationId -

    [any string]
    

expect -

    [201-created]
    

Returns:

VMGraphicsConsole

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<VMGraphicsConsole> list(Boolean current)
                             throws org.apache.http.client.ClientProtocolException,
                                    ServerException,
                                    IOException

Lists VMGraphicsConsole objects.

Parameters:

current -

    [true|false]
    

Returns:

List of VMGraphicsConsole

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

Lists VMGraphicsConsole objects.

Parameters:

current -

    [true|false]
    

max -

    [max results]
    

Returns:

List of VMGraphicsConsole

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.