org.ovirt.engine.sdk.decorators

Class InstanceTypes

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<InstanceType,InstanceTypes,InstanceType>

org.ovirt.engine.sdk.decorators.InstanceTypes

public class InstanceTypes
extends CollectionDecorator<InstanceType,InstanceTypes,InstanceType>

InstanceTypes providing relation and functional services

to InstanceTypes.

Constructor Summary

Constructors

Constructor and Description
InstanceTypes(HttpProxyBroker proxy)

Method Summary

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

InstanceTypes

public InstanceTypes(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists InstanceType objects.

Specified by:

list in class CollectionDecorator<InstanceType,InstanceTypes,InstanceType>

Returns:

List of InstanceType

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

Fetches InstanceType object by id.

Specified by:

get in class CollectionDecorator<InstanceType,InstanceTypes,InstanceType>

Parameters:

id - entity id

Returns:

InstanceType

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

Fetches InstanceType object by id.

Specified by:

getById in class CollectionDecorator<InstanceType,InstanceTypes,InstanceType>

Parameters:

id - entity id

Returns:

InstanceType

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

Lists InstanceType objects.

Parameters:

max -

    [max results]
    

Returns:

List of InstanceType

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

Adds InstanceType object.

Parameters:

instancetype - InstanceType

    instance_type.name
    [instance_type.memory]
    [instance_type.cpu.topology.cores]
    [instance_type.high_availability.enabled]
    [instance_type.origin]
    [instance_type.high_availability.priority]
    [instance_type.console.enabled]
    [instance_type.description]
    [instance_type.os.boot]
    [instance_type.cpu.topology.sockets]
    [instance_type.cpu_shares]
    [instance_type.cpu.architecture]
    [instance_type.display.type]
    [instance_type.display.monitors]
    [instance_typeay.single_qxl_pci]
    [instance_type.display.smartcard_enabled]
    [instance_type.usb.enabled]
    [instance_type.usb.type]
    [instance_type.migration_downtime]
    [instance_type.virtio_scsi.enabled]
    [instance_type.soundcard_enabled]
    

Returns:

InstanceType

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

Adds InstanceType object.

Parameters:

instancetype - InstanceType

    instance_type.name
    [instance_type.memory]
    [instance_type.cpu.topology.cores]
    [instance_type.high_availability.enabled]
    [instance_type.origin]
    [instance_type.high_availability.priority]
    [instance_type.console.enabled]
    [instance_type.description]
    [instance_type.os.boot]
    [instance_type.cpu.topology.sockets]
    [instance_type.cpu_shares]
    [instance_type.cpu.architecture]
    [instance_type.display.type]
    [instance_type.display.monitors]
    [instance_typeay.single_qxl_pci]
    [instance_type.display.smartcard_enabled]
    [instance_type.usb.enabled]
    [instance_type.usb.type]
    [instance_type.migration_downtime]
    [instance_type.virtio_scsi.enabled]
    [instance_type.soundcard_enabled]
    

expect -

    [201-created]
    

Returns:

InstanceType

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

Adds InstanceType object.

Parameters:

instancetype - InstanceType

    instance_type.name
    [instance_type.memory]
    [instance_type.cpu.topology.cores]
    [instance_type.high_availability.enabled]
    [instance_type.origin]
    [instance_type.high_availability.priority]
    [instance_type.console.enabled]
    [instance_type.description]
    [instance_type.os.boot]
    [instance_type.cpu.topology.sockets]
    [instance_type.cpu_shares]
    [instance_type.cpu.architecture]
    [instance_type.display.type]
    [instance_type.display.monitors]
    [instance_typeay.single_qxl_pci]
    [instance_type.display.smartcard_enabled]
    [instance_type.usb.enabled]
    [instance_type.usb.type]
    [instance_type.migration_downtime]
    [instance_type.virtio_scsi.enabled]
    [instance_type.soundcard_enabled]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

InstanceType

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.