org.ovirt.engine.sdk.decorators

Class StorageDomainDisks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.StorageDomainDisks

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

StorageDomainDisks providing relation and functional services

to Disks.

Constructor Summary

Constructors

Constructor and Description
StorageDomainDisks(HttpProxyBroker proxy, StorageDomain parent)

Method Summary

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

StorageDomainDisks

public StorageDomainDisks(HttpProxyBroker proxy,
                          StorageDomain parent)

Parameters:

proxy - HttpProxyBroker

parent - StorageDomain

Method Detail

list

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

Lists StorageDomainDisk objects.

Specified by:

list in class CollectionDecorator<Disk,Disks,StorageDomainDisk>

Returns:

List of StorageDomainDisk

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

Fetches StorageDomainDisk object by id.

Specified by:

get in class CollectionDecorator<Disk,Disks,StorageDomainDisk>

Parameters:

id - entity id

Returns:

StorageDomainDisk

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

Fetches StorageDomainDisk object by id.

Specified by:

getById in class CollectionDecorator<Disk,Disks,StorageDomainDisk>

Parameters:

id - entity id

Returns:

StorageDomainDisk

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

Lists StorageDomainDisk objects.

Parameters:

query -

    [query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

unregistered -

    [true|false]
    

Returns:

List of StorageDomainDisk

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 StorageDomainDisk 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 storage
      domain with the specified size
      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]

    Overload 2:

      add a new lun disk to the storage domain

      disk.interface
      disk.format
      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]
    

Returns:

StorageDomainDisk

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

Adds Disk object.

Parameters:

disk - Disk

    Overload 1:

      add a new disk to the storage
      domain with the specified size
      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]

    Overload 2:

      add a new lun disk to the storage domain

      disk.interface
      disk.format
      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]
    

unregistered -

    [true|false]
    

Returns:

StorageDomainDisk

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

Adds Disk object.

Parameters:

disk - Disk

    Overload 1:

      add a new disk to the storage
      domain with the specified size
      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]

    Overload 2:

      add a new lun disk to the storage domain

      disk.interface
      disk.format
      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]
    

expect -

    [201-created]
    

unregistered -

    [true|false]
    

Returns:

StorageDomainDisk

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 StorageDomainDisk add(Disk disk,
                             Boolean unregistered,
                             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 storage
      domain with the specified size
      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]

    Overload 2:

      add a new lun disk to the storage domain

      disk.interface
      disk.format
      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]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

unregistered -

    [true|false]
    

Returns:

StorageDomainDisk

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.