org.ovirt.engine.sdk.decorators

Class StorageDomains

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<StorageDomain,StorageDomains,StorageDomain>

org.ovirt.engine.sdk.decorators.StorageDomains

public class StorageDomains
extends CollectionDecorator<StorageDomain,StorageDomains,StorageDomain>

StorageDomains providing relation and functional services

to StorageDomains.

Constructor Summary

Constructors

Constructor and Description
StorageDomains(HttpProxyBroker proxy)

Method Summary

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

StorageDomains

public StorageDomains(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists StorageDomain objects.

Specified by:

list in class CollectionDecorator<StorageDomain,StorageDomains,StorageDomain>

Returns:

List of StorageDomain

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

Fetches StorageDomain object by id.

Specified by:

get in class CollectionDecorator<StorageDomain,StorageDomains,StorageDomain>

Parameters:

id - entity id

Returns:

StorageDomain

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

Fetches StorageDomain object by id.

Specified by:

getById in class CollectionDecorator<StorageDomain,StorageDomains,StorageDomain>

Parameters:

id - entity id

Returns:

StorageDomain

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

Lists StorageDomain objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of StorageDomain

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

Adds StorageDomain object.

Parameters:

storagedomain - StorageDomain

    Overload 1:

      add a new storage domain to
      the system using a direct lun

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.logical_unit
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.override_luns]
      [storagedomain.storage_format]

    Overload 2:

      Import an existing block
      storage domain to the system
      using the targets already
      connected to the host

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.import
      [storagedomain.storage.address]
      [storagedomain.format]
      [storagedomain.comment]

    Overload 3:

      add a new storage domain to
      the system using the storage
      on the given host and path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 4:

      add a new storage domain to
      the system using the storage
      on the localhost at the given
      path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 5:

      add a new storage domain to
      the system using the gluster
      or posixfs storage

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      storagedomain.storage.vfs_type
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.address]
      [storagedomain.storage.mount_options]
      [storagedomain.storage_format]
    

Returns:

StorageDomain

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 StorageDomain add(StorageDomain storagedomain,
                         Boolean async)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Adds StorageDomain object.

Parameters:

storagedomain - StorageDomain

    Overload 1:

      add a new storage domain to
      the system using a direct lun

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.logical_unit
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.override_luns]
      [storagedomain.storage_format]

    Overload 2:

      Import an existing block
      storage domain to the system
      using the targets already
      connected to the host

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.import
      [storagedomain.storage.address]
      [storagedomain.format]
      [storagedomain.comment]

    Overload 3:

      add a new storage domain to
      the system using the storage
      on the given host and path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 4:

      add a new storage domain to
      the system using the storage
      on the localhost at the given
      path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 5:

      add a new storage domain to
      the system using the gluster
      or posixfs storage

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      storagedomain.storage.vfs_type
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.address]
      [storagedomain.storage.mount_options]
      [storagedomain.storage_format]
    

async -

    [true|false]
    

Returns:

StorageDomain

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 StorageDomain add(StorageDomain storagedomain,
                         Boolean async,
                         String expect)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Adds StorageDomain object.

Parameters:

storagedomain - StorageDomain

    Overload 1:

      add a new storage domain to
      the system using a direct lun

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.logical_unit
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.override_luns]
      [storagedomain.storage_format]

    Overload 2:

      Import an existing block
      storage domain to the system
      using the targets already
      connected to the host

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.import
      [storagedomain.storage.address]
      [storagedomain.format]
      [storagedomain.comment]

    Overload 3:

      add a new storage domain to
      the system using the storage
      on the given host and path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 4:

      add a new storage domain to
      the system using the storage
      on the localhost at the given
      path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 5:

      add a new storage domain to
      the system using the gluster
      or posixfs storage

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      storagedomain.storage.vfs_type
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.address]
      [storagedomain.storage.mount_options]
      [storagedomain.storage_format]
    

expect -

    [201-created]
    

async -

    [true|false]
    

Returns:

StorageDomain

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 StorageDomain add(StorageDomain storagedomain,
                         Boolean async,
                         String expect,
                         String correlationId)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Adds StorageDomain object.

Parameters:

storagedomain - StorageDomain

    Overload 1:

      add a new storage domain to
      the system using a direct lun

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.logical_unit
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.override_luns]
      [storagedomain.storage_format]

    Overload 2:

      Import an existing block
      storage domain to the system
      using the targets already
      connected to the host

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.import
      [storagedomain.storage.address]
      [storagedomain.format]
      [storagedomain.comment]

    Overload 3:

      add a new storage domain to
      the system using the storage
      on the given host and path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.address
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 4:

      add a new storage domain to
      the system using the storage
      on the localhost at the given
      path

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage_format]

    Overload 5:

      add a new storage domain to
      the system using the gluster
      or posixfs storage

      storagedomain.host.id|name
      storagedomain.type
      storagedomain.storage.type
      storagedomain.format
      storagedomain.storage.path
      storagedomain.storage.vfs_type
      [storagedomain.name]
      [storagedomain.comment]
      [storagedomain.storage.address]
      [storagedomain.storage.mount_options]
      [storagedomain.storage_format]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

StorageDomain

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.