org.ovirt.engine.sdk.decorators

Class Disks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.Disks

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

Disks providing relation and functional services

to Disks.

Constructor Summary

Constructors

Constructor and Description
Disks(HttpProxyBroker proxy)

Method Summary

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

Disks

public Disks(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Disk objects.

Specified by:

list in class CollectionDecorator<Disk,Disks,Disk>

Returns:

List of Disk

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

Fetches Disk object by id.

Specified by:

get in class CollectionDecorator<Disk,Disks,Disk>

Parameters:

id - entity id

Returns:

Disk

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

Fetches Disk object by id.

Specified by:

getById in class CollectionDecorator<Disk,Disks,Disk>

Parameters:

id - entity id

Returns:

Disk

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

Lists Disk objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of Disk

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 Disk 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 system
      with specified size, space
      will be allocated from the
      storage domain for the disk

      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 lun disk to the
      system, this operation does
      not require size but requires
      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]
    

Returns:

Disk

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 Disk 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 system
      with specified size, space
      will be allocated from the
      storage domain for the disk

      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 lun disk to the
      system, this operation does
      not require size but requires
      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]
    

expect -

    [201-created]
    

Returns:

Disk

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 Disk 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 system
      with specified size, space
      will be allocated from the
      storage domain for the disk

      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 lun disk to the
      system, this operation does
      not require size but requires
      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]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

Disk

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.