org.ovirt.engine.sdk.decorators

Class DataCenterStorageDomainDisks

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.DataCenterStorageDomainDisks

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

DataCenterStorageDomainDisks providing relation and functional services

to Disks.

Constructor Summary

Constructors

Constructor and Description
DataCenterStorageDomainDisks(HttpProxyBroker proxy, DataCenterStorageDomain parent)

Method Summary

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

DataCenterStorageDomainDisks

public DataCenterStorageDomainDisks(HttpProxyBroker proxy,
                                    DataCenterStorageDomain parent)

Parameters:

proxy - HttpProxyBroker

parent - DataCenterStorageDomain

Method Detail

list

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

Lists DataCenterStorageDomainDisk objects.

Specified by:

list in class CollectionDecorator<Disk,Disks,DataCenterStorageDomainDisk>

Returns:

List of DataCenterStorageDomainDisk

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

Fetches DataCenterStorageDomainDisk object by id.

Specified by:

get in class CollectionDecorator<Disk,Disks,DataCenterStorageDomainDisk>

Parameters:

id - entity id

Returns:

DataCenterStorageDomainDisk

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

Fetches DataCenterStorageDomainDisk object by id.

Specified by:

getById in class CollectionDecorator<Disk,Disks,DataCenterStorageDomainDisk>

Parameters:

id - entity id

Returns:

DataCenterStorageDomainDisk

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

Lists DataCenterStorageDomainDisk objects.

Parameters:

query -

    [query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

unregistered -

    [true|false]
    

Returns:

List of DataCenterStorageDomainDisk

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

Adds Disk object.

Parameters:

disk - Disk

    Overload 1:

      add a new disk with the
      specified size to the storage
      domain in the data center,
      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 in the data
      center

      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:

DataCenterStorageDomainDisk

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 DataCenterStorageDomainDisk 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 with the
      specified size to the storage
      domain in the data center,
      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 in the data
      center

      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:

DataCenterStorageDomainDisk

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 DataCenterStorageDomainDisk 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 with the
      specified size to the storage
      domain in the data center,
      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 in the data
      center

      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:

DataCenterStorageDomainDisk

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 DataCenterStorageDomainDisk 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 with the
      specified size to the storage
      domain in the data center,
      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 in the data
      center

      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:

DataCenterStorageDomainDisk

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.