org.ovirt.engine.sdk.decorators

Class Template

java.lang.Object

org.ovirt.engine.sdk.entities.ActionableResource

org.ovirt.engine.sdk.entities.BaseResource

org.ovirt.engine.sdk.entities.VmBase

org.ovirt.engine.sdk.entities.Template

org.ovirt.engine.sdk.decorators.Template

public class Template
extends Template

Template providing relation and functional services

to Template.

Constructor Summary

Constructors

Constructor and Description
Template(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Response	delete() Deletes object.
Response	delete(Boolean async) Deletes object.
Response	delete(Boolean async, String correlationId) Deletes object.
Action	exportTemplate(Action action) Performs exportTemplate action.
Action	exportTemplate(Action action, String correlationId) Performs exportTemplate action.
Action	exportTemplate(Action action, String correlationId, Boolean async) Performs exportTemplate action.
TemplateCdRoms	getCdRoms() Gets the value of the TemplateCdRoms property.
TemplateDisks	getDisks() Gets the value of the TemplateDisks property.
TemplateGraphicsConsoles	getGraphicsConsoles() Gets the value of the TemplateGraphicsConsoles property.
TemplateNICs	getNics() Gets the value of the TemplateNICs property.
TemplatePermissions	getPermissions() Gets the value of the TemplatePermissions property.
TemplateTags	getTags() Gets the value of the TemplateTags property.
TemplateWatchDogs	getWatchDogs() Gets the value of the TemplateWatchDogs property.
Template	update() Updates Template object.
Template	update(String correlationId) Updates Template object.
Template	update(String correlationId, Boolean async) Updates Template object.
Template	update(String correlationId, Boolean async, String expect) Updates Template object.

Methods inherited from class org.ovirt.engine.sdk.entities.Template

getVersion, getVm, isSetPermissions, isSetVersion, isSetVm, setPermissions, setVersion, setVm

Methods inherited from class org.ovirt.engine.sdk.entities.VmBase

getBios, getCluster, getConsole, getCpu, getCpuProfile, getCpuShares, getCreationTime, getCustomCpuModel, getCustomEmulatedMachine, getCustomProperties, getDeleteProtected, getDisplay, getDomain, getHighAvailability, getIo, getLargeIcon, getMemory, getMemoryPolicy, getMigration, getMigrationDowntime, getOrigin, getOs, getRngDevice, getSerialNumber, getSmallIcon, getSoundcardEnabled, getSso, getStartPaused, getStateless, getStatus, getStorageDomain, getTimezone, getTimeZone, getTunnelMigration, getType, getUsb, getVirtioScsi, isSetBios, isSetCluster, isSetConsole, isSetCpu, isSetCpuProfile, isSetCpuShares, isSetCreationTime, isSetCustomCpuModel, isSetCustomEmulatedMachine, isSetCustomProperties, isSetDeleteProtected, isSetDisplay, isSetDomain, isSetHighAvailability, isSetIo, isSetLargeIcon, isSetMemory, isSetMemoryPolicy, isSetMigration, isSetMigrationDowntime, isSetOrigin, isSetOs, isSetRngDevice, isSetSerialNumber, isSetSmallIcon, isSetSoundcardEnabled, isSetSso, isSetStartPaused, isSetStateless, isSetStatus, isSetStorageDomain, isSetTimezone, isSetTimeZone, isSetTunnelMigration, isSetType, isSetUsb, isSetVirtioScsi, setBios, setCluster, setConsole, setCpu, setCpuProfile, setCpuShares, setCreationTime, setCustomCpuModel, setCustomEmulatedMachine, setCustomProperties, setDeleteProtected, setDisplay, setDomain, setHighAvailability, setIo, setLargeIcon, setMemory, setMemoryPolicy, setMigration, setMigrationDowntime, setOrigin, setOs, setRngDevice, setSerialNumber, setSmallIcon, setSoundcardEnabled, setSso, setStartPaused, setStateless, setStatus, setStorageDomain, setTimezone, setTimeZone, setTunnelMigration, setType, setUsb, setVirtioScsi

Methods inherited from class org.ovirt.engine.sdk.entities.BaseResource

getComment, getCreationStatus, getDescription, getHref, getId, getLinks, getName, isSetComment, isSetCreationStatus, isSetDescription, isSetHref, isSetId, isSetLinks, isSetName, setComment, setCreationStatus, setDescription, setHref, setId, setName, unsetLinks

Methods inherited from class org.ovirt.engine.sdk.entities.ActionableResource

getActions, isSetActions, setActions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Template

public Template(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

getCdRoms

public TemplateCdRoms getCdRoms()

Gets the value of the TemplateCdRoms property.

Returns:

TemplateCdRoms

getDisks

public TemplateDisks getDisks()

Gets the value of the TemplateDisks property.

Returns:

TemplateDisks

getGraphicsConsoles

public TemplateGraphicsConsoles getGraphicsConsoles()

Gets the value of the TemplateGraphicsConsoles property.

Returns:

TemplateGraphicsConsoles

getNics

public TemplateNICs getNics()

Gets the value of the TemplateNICs property.

Returns:

TemplateNICs

getPermissions

public TemplatePermissions getPermissions()

Gets the value of the TemplatePermissions property.

Overrides:

getPermissions in class Template

Returns:

TemplatePermissions

getTags

public TemplateTags getTags()

Gets the value of the TemplateTags property.

Returns:

TemplateTags

getWatchDogs

public TemplateWatchDogs getWatchDogs()

Gets the value of the TemplateWatchDogs property.

Returns:

TemplateWatchDogs

delete

public Response delete()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Returns:

Response

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.

delete

public Response delete(Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

async -

    [true|false]
    

Returns:

Response

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.

delete

public Response delete(Boolean async,
                       String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Response

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.

exportTemplate

public Action exportTemplate(Action action)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Performs exportTemplate action.

Parameters:

action - Action

    action.storage_domain.id|name
    [action.exclusive]
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

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.

exportTemplate

public Action exportTemplate(Action action,
                             String correlationId)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Performs exportTemplate action.

Parameters:

action - Action

    action.storage_domain.id|name
    [action.exclusive]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

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.

exportTemplate

public Action exportTemplate(Action action,
                             String correlationId,
                             Boolean async)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Performs exportTemplate action.

Parameters:

action - Action

    action.storage_domain.id|name
    [action.exclusive]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

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.

update

public Template update()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Updates Template object.

Parameters:

template - Template

    [template.name]
    [template.memory]
    [template.io.threads]
    [template.memory_policy.guaranteed]
    [template.memory_policy.ballooning]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.time_zone.name]
    [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]
    [vm.display.file_transfer_enabled]
    [vm.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.display.disconnect_action]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.custom_emulated_machine]
    [template.custom_cpu_model]
    [template.version.version_name]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.start_paused]
    [template.cpu_profile.id]
    [template.migration.auto_converge]
    [template.migration.compressed]
    [template.small_icon.id]
    [template.large_icon.id]
    [template.large_icon.media_type]
    [template.large_icon.data]
    

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.

update

public Template update(String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Updates Template object.

Parameters:

template - Template

    [template.name]
    [template.memory]
    [template.io.threads]
    [template.memory_policy.guaranteed]
    [template.memory_policy.ballooning]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.time_zone.name]
    [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]
    [vm.display.file_transfer_enabled]
    [vm.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.display.disconnect_action]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.custom_emulated_machine]
    [template.custom_cpu_model]
    [template.version.version_name]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.start_paused]
    [template.cpu_profile.id]
    [template.migration.auto_converge]
    [template.migration.compressed]
    [template.small_icon.id]
    [template.large_icon.id]
    [template.large_icon.media_type]
    [template.large_icon.data]
    

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.

update

public Template update(String correlationId,
                       Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Updates Template object.

Parameters:

template - Template

    [template.name]
    [template.memory]
    [template.io.threads]
    [template.memory_policy.guaranteed]
    [template.memory_policy.ballooning]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.time_zone.name]
    [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]
    [vm.display.file_transfer_enabled]
    [vm.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.display.disconnect_action]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.custom_emulated_machine]
    [template.custom_cpu_model]
    [template.version.version_name]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.start_paused]
    [template.cpu_profile.id]
    [template.migration.auto_converge]
    [template.migration.compressed]
    [template.small_icon.id]
    [template.large_icon.id]
    [template.large_icon.media_type]
    [template.large_icon.data]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

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.

update

public Template update(String correlationId,
                       Boolean async,
                       String expect)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Updates Template object.

Parameters:

template - Template

    [template.name]
    [template.memory]
    [template.io.threads]
    [template.memory_policy.guaranteed]
    [template.memory_policy.ballooning]
    [template.cpu.topology.cores]
    [template.high_availability.enabled]
    [template.os.cmdline]
    [template.origin]
    [template.high_availability.priority]
    [template.timezone]
    [template.time_zone.name]
    [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]
    [vm.display.file_transfer_enabled]
    [vm.display.copy_paste_enabled]
    [template.display.keyboard_layout]
    [template.display.disconnect_action]
    [template.os.initRd]
    [template.usb.enabled]
    [template.usb.type]
    [template.tunnel_migration]
    [template.migration_downtime]
    [template.virtio_scsi.enabled]
    [template.soundcard_enabled]
    [template.custom_emulated_machine]
    [template.custom_cpu_model]
    [template.version.version_name]
    [template.serial_number.policy]
    [template.serial_number.value]
    [template.bios.boot_menu.enabled]
    [template.start_paused]
    [template.cpu_profile.id]
    [template.migration.auto_converge]
    [template.migration.compressed]
    [template.small_icon.id]
    [template.large_icon.id]
    [template.large_icon.media_type]
    [template.large_icon.data]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

expect -

    [202-accepted]
    

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.