org.ovirt.engine.sdk.decorators

Class VMDisks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Disk,Disks,VMDisk>

org.ovirt.engine.sdk.decorators.VMDisks

public class VMDisks
extends CollectionDecorator<Disk,Disks,VMDisk>

VMDisks providing relation and functional services

to Disks.

Constructor Summary

Constructors

Constructor and Description
VMDisks(HttpProxyBroker proxy, VM parent)

Method Summary

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

VMDisks

public VMDisks(HttpProxyBroker proxy,
               VM parent)

Parameters:

proxy - HttpProxyBroker

parent - VM

Method Detail

list

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

Lists VMDisk objects.

Specified by:

list in class CollectionDecorator<Disk,Disks,VMDisk>

Returns:

List of VMDisk

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

Fetches VMDisk object by id.

Specified by:

get in class CollectionDecorator<Disk,Disks,VMDisk>

Parameters:

id - entity id

Returns:

VMDisk

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

Fetches VMDisk object by id.

Specified by:

getById in class CollectionDecorator<Disk,Disks,VMDisk>

Parameters:

id - entity id

Returns:

VMDisk

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

Lists VMDisk objects.

Parameters:

max -

    [max results]
    

Returns:

List of VMDisk

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

Adds Disk object.

Parameters:

disk - Disk

    Overload 1:

      add a new disk to the virtual
      machine allocating space from
      the storage domain

      provisioned_size
      disk.interface
      disk.format
      [disk.alias]
      [disk.name]
      [disk.size]
      [disk.sparse]
      [disk.bootable]
      [disk.shareable]
      [disk.propagate_errors]
      [disk.wipe_after_delete]
      [disk.quota.id]
      [disk.disk_profile.id]
      [disk.storage_domains.storage_domain]

    Overload 2:

      add a new direct lun disk to
      the virtual machine, this
      operation does not require
      size but needs lun connection
      details

      disk.interface
      disk.lun_storage.type
      disk.lun_storage.logical_unit
      [disk.alias]
      [disk.sparse]
      [disk.bootable]
      [disk.shareable]
      [disk.propagate_errors]
      [disk.wipe_after_delete]
      [disk.quota.id]
      [disk.sgio]
      [disk.lun_storage.host]

    Overload 3:

      attach a disk to the virtual machine

      disk.id
      [disk.active]
      [disk.read_only]

    Overload 4:

      attach a disk snapshot to the
      virtual machine

      disk.id
      disk.snapshot.id
      [disk.active]
    

Returns:

VMDisk

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

Adds Disk object.

Parameters:

disk - Disk

    Overload 1:

      add a new disk to the virtual
      machine allocating space from
      the storage domain

      provisioned_size
      disk.interface
      disk.format
      [disk.alias]
      [disk.name]
      [disk.size]
      [disk.sparse]
      [disk.bootable]
      [disk.shareable]
      [disk.propagate_errors]
      [disk.wipe_after_delete]
      [disk.quota.id]
      [disk.disk_profile.id]
      [disk.storage_domains.storage_domain]

    Overload 2:

      add a new direct lun disk to
      the virtual machine, this
      operation does not require
      size but needs lun connection
      details

      disk.interface
      disk.lun_storage.type
      disk.lun_storage.logical_unit
      [disk.alias]
      [disk.sparse]
      [disk.bootable]
      [disk.shareable]
      [disk.propagate_errors]
      [disk.wipe_after_delete]
      [disk.quota.id]
      [disk.sgio]
      [disk.lun_storage.host]

    Overload 3:

      attach a disk to the virtual machine

      disk.id
      [disk.active]
      [disk.read_only]

    Overload 4:

      attach a disk snapshot to the
      virtual machine

      disk.id
      disk.snapshot.id
      [disk.active]
    

expect -

    [201-created]
    

Returns:

VMDisk

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

Adds Disk object.

Parameters:

disk - Disk

    Overload 1:

      add a new disk to the virtual
      machine allocating space from
      the storage domain

      provisioned_size
      disk.interface
      disk.format
      [disk.alias]
      [disk.name]
      [disk.size]
      [disk.sparse]
      [disk.bootable]
      [disk.shareable]
      [disk.propagate_errors]
      [disk.wipe_after_delete]
      [disk.quota.id]
      [disk.disk_profile.id]
      [disk.storage_domains.storage_domain]

    Overload 2:

      add a new direct lun disk to
      the virtual machine, this
      operation does not require
      size but needs lun connection
      details

      disk.interface
      disk.lun_storage.type
      disk.lun_storage.logical_unit
      [disk.alias]
      [disk.sparse]
      [disk.bootable]
      [disk.shareable]
      [disk.propagate_errors]
      [disk.wipe_after_delete]
      [disk.quota.id]
      [disk.sgio]
      [disk.lun_storage.host]

    Overload 3:

      attach a disk to the virtual machine

      disk.id
      [disk.active]
      [disk.read_only]

    Overload 4:

      attach a disk snapshot to the
      virtual machine

      disk.id
      disk.snapshot.id
      [disk.active]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

VMDisk

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.