org.ovirt.engine.sdk.decorators

Class Templates

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Template,Templates,Template>

org.ovirt.engine.sdk.decorators.Templates

public class Templates
extends CollectionDecorator<Template,Templates,Template>

Templates providing relation and functional services

to Templates.

Constructor Summary

Constructors

Constructor and Description
Templates(HttpProxyBroker proxy)

Method Summary

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

Templates

public Templates(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Template objects.

Specified by:

list in class CollectionDecorator<Template,Templates,Template>

Returns:

List of Template

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

Fetches Template object by id.

Specified by:

get in class CollectionDecorator<Template,Templates,Template>

Parameters:

id - entity id

Returns:

Template

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

Fetches Template object by id.

Specified by:

getById in class CollectionDecorator<Template,Templates,Template>

Parameters:

id - entity id

Returns:

Template

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

Lists Template objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of Template

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<Template> list(String query,
                           Boolean caseSensitive,
                           Integer max,
                           String allContent)
                    throws org.apache.http.client.ClientProtocolException,
                           ServerException,
                           IOException

Lists Template objects.

Parameters:

allContent -

    [true|false]
    

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of Template

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

Adds Template object.

Parameters:

template - Template

    template.vm.id|name
    template.name
    [template.memory]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.domain.name]
    [template.type]
    [template.stateless]
    [template.delete_protected]
    [template.sso.methods.method]
    [vm.rng_device.rate.bytes]
    [vm.rng_device.rate.period]
    [vm.rng_device.source]
    [template.console.enabled]
    [template.placement_policy.affinity]
    [template.description]
    [template.comment]
    [template.custom_properties.custom_property]
    [template.os.type]
    [template.os.boot]
    [template.cpu.topology.sockets]
    [template.cpu_shares]
    [template.cpu.architecture]
    [template.os.kernel]
    [template.display.type]
    [template.display.monitors]
    [vm.display.single_qxl_pci]
    [template.display.allow_override]
    [template.display.smartcard_enabled]
    [template.display.file_transfer_enabled]
    [template.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.vm.disks.disk]
    [template.permissions.clone]
    [template.version.version_name]
    [template.version.base_template.id]
    [template.cpu.cpu_tune.vcpu_pin]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.cluster.id]
    [template.cluster.name]
    [template.cpu_profile.id]
    

Returns:

Template

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

Adds Template object.

Parameters:

template - Template

    template.vm.id|name
    template.name
    [template.memory]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.domain.name]
    [template.type]
    [template.stateless]
    [template.delete_protected]
    [template.sso.methods.method]
    [vm.rng_device.rate.bytes]
    [vm.rng_device.rate.period]
    [vm.rng_device.source]
    [template.console.enabled]
    [template.placement_policy.affinity]
    [template.description]
    [template.comment]
    [template.custom_properties.custom_property]
    [template.os.type]
    [template.os.boot]
    [template.cpu.topology.sockets]
    [template.cpu_shares]
    [template.cpu.architecture]
    [template.os.kernel]
    [template.display.type]
    [template.display.monitors]
    [vm.display.single_qxl_pci]
    [template.display.allow_override]
    [template.display.smartcard_enabled]
    [template.display.file_transfer_enabled]
    [template.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.vm.disks.disk]
    [template.permissions.clone]
    [template.version.version_name]
    [template.version.base_template.id]
    [template.cpu.cpu_tune.vcpu_pin]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.cluster.id]
    [template.cluster.name]
    [template.cpu_profile.id]
    

expect -

    [201-created]
    

Returns:

Template

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

Adds Template object.

Parameters:

template - Template

    template.vm.id|name
    template.name
    [template.memory]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.domain.name]
    [template.type]
    [template.stateless]
    [template.delete_protected]
    [template.sso.methods.method]
    [vm.rng_device.rate.bytes]
    [vm.rng_device.rate.period]
    [vm.rng_device.source]
    [template.console.enabled]
    [template.placement_policy.affinity]
    [template.description]
    [template.comment]
    [template.custom_properties.custom_property]
    [template.os.type]
    [template.os.boot]
    [template.cpu.topology.sockets]
    [template.cpu_shares]
    [template.cpu.architecture]
    [template.os.kernel]
    [template.display.type]
    [template.display.monitors]
    [vm.display.single_qxl_pci]
    [template.display.allow_override]
    [template.display.smartcard_enabled]
    [template.display.file_transfer_enabled]
    [template.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.vm.disks.disk]
    [template.permissions.clone]
    [template.version.version_name]
    [template.version.base_template.id]
    [template.cpu.cpu_tune.vcpu_pin]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.cluster.id]
    [template.cluster.name]
    [template.cpu_profile.id]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

Template

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.