com.emc.vipr.client.core

Class StoragePools

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<StoragePoolRestRep>

com.emc.vipr.client.core.StoragePools

All Implemented Interfaces:

BulkResources<StoragePoolRestRep>, Resources<StoragePoolRestRep>, TopLevelResources<StoragePoolRestRep>

public class StoragePools
extends AbstractCoreBulkResources<StoragePoolRestRep>
implements TopLevelResources<StoragePoolRestRep>

Storage Pools resources.

Base URL: /vdc/storage-pools

Constructor Summary

Constructors

Constructor and Description
StoragePools(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
StoragePoolRestRep	deregister(java.net.URI id) Deregisters a storage pool.
java.util.List<StoragePoolRestRep>	getAll() Gets all storage pools.
java.util.List<StoragePoolRestRep>	getAll(ResourceFilter<StoragePoolRestRep> filter) Gets all storage pools.
java.util.List<StoragePoolRestRep>	getByStorageSystem(java.net.URI storageSystemId) Gets the list of storage pools for the given storage system by ID.
java.util.List<StoragePoolRestRep>	getByStorageSystem(java.net.URI storageSystemId, ResourceFilter<StoragePoolRestRep> filter) Gets the list of storage pools for the given storage system by ID, optionally filtering the results.
java.util.List<StoragePoolRestRep>	getByVirtualArray(java.net.URI varrayId) Gets the storage pools that are associated with the given virtual array
StoragePoolRestRep	getByVolume(java.net.URI volumeId) Gets the storage pool that contains the given volume by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all storage pools.
java.util.List<NamedRelatedResourceRep>	listByStorageSystem(java.net.URI storageSystemId) Lists the storage pools for the given storage system by ID.
java.util.List<NamedRelatedResourceRep>	listByVirtualArray(java.net.URI varrayId) Lists the storage pools that are associated with the given virtual array.
java.util.List<NamedRelatedVirtualPoolRep>	listMatchedVirtualPools(java.net.URI id) Lists the virtual pools which match the given storage pool by ID.
java.util.List<TypedRelatedResourceRep>	listResources(java.net.URI id) Lists the resources for the given storage pool by ID.
StoragePoolRestRep	register(java.net.URI poolId, java.net.URI storageSystemId) Registers a storage pool with the given storage system.
StoragePoolRestRep	update(java.net.URI id, StoragePoolUpdate input) Updates the given storage pool by ID.
StoragePools	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
StoragePools	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Constructor Detail

StoragePools

public StoragePools(ViPRCoreClient parent,
                    RestClient client)

Method Detail

withInactive

public StoragePools withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<StoragePoolRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public StoragePools withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<StoragePoolRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

public java.util.List<NamedRelatedResourceRep> list()

Lists all storage pools.

API Call: GET /vdc/storage-pools

Specified by:

list in interface TopLevelResources<StoragePoolRestRep>

Returns:

the list of all storage pool references.

getAll

public java.util.List<StoragePoolRestRep> getAll()

Gets all storage pools. This is a convenience method for: getByRefs(list())

Specified by:

getAll in interface TopLevelResources<StoragePoolRestRep>

Returns:

the list of all storage pools.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection)

getAll

public java.util.List<StoragePoolRestRep> getAll(ResourceFilter<StoragePoolRestRep> filter)

Gets all storage pools. This is a convenience method for: getByRefs(list(), filter)

Specified by:

getAll in interface TopLevelResources<StoragePoolRestRep>

Parameters:

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of all storage pools.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection, ResourceFilter)

register

public StoragePoolRestRep register(java.net.URI poolId,
                                   java.net.URI storageSystemId)

Registers a storage pool with the given storage system.

API Call: POST /vdc/storage-systems/{storageSystemId}/storage-pools/{poolId}/register

Parameters:

poolId - the ID of the storage pool.

storageSystemId - the ID of the storage system.

Returns:

the storage pool.

deregister

public StoragePoolRestRep deregister(java.net.URI id)

Deregisters a storage pool.

API Call: POST /vdc/storage-pools/{id}/deregister

Parameters:

id - the ID of the storage pool.

update

public StoragePoolRestRep update(java.net.URI id,
                                 StoragePoolUpdate input)

Updates the given storage pool by ID.

API Call: PUT /vdc/storage-pools/{id}

Parameters:

id - the ID of the storage pool.

input - the update configuration.

Returns:

the updated storage pool.

listByStorageSystem

public java.util.List<NamedRelatedResourceRep> listByStorageSystem(java.net.URI storageSystemId)

Lists the storage pools for the given storage system by ID.

API Call: GET /vdc/storage-systems/{storageSystemId}/storage-pools

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of storage pool references.

getByStorageSystem

public java.util.List<StoragePoolRestRep> getByStorageSystem(java.net.URI storageSystemId)

Gets the list of storage pools for the given storage system by ID.

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of storage pools for the storage system.

getByStorageSystem

public java.util.List<StoragePoolRestRep> getByStorageSystem(java.net.URI storageSystemId,
                                                             ResourceFilter<StoragePoolRestRep> filter)

Gets the list of storage pools for the given storage system by ID, optionally filtering the results.

Parameters:

storageSystemId - the ID of the storage system.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of storage pools for the storage system.

listByVirtualArray

public java.util.List<NamedRelatedResourceRep> listByVirtualArray(java.net.URI varrayId)

Lists the storage pools that are associated with the given virtual array.

API Call: GET /vdc/varrays/{id}/storage-pools

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of storage pool references.

getByVirtualArray

public java.util.List<StoragePoolRestRep> getByVirtualArray(java.net.URI varrayId)

Gets the storage pools that are associated with the given virtual array

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of storage pools.

See Also:

listByVirtualArray(URI), AbstractResources.getByRefs(java.util.Collection)

listResources

public java.util.List<TypedRelatedResourceRep> listResources(java.net.URI id)

Lists the resources for the given storage pool by ID.

API Call: GET /vdc/storage-pools/{id}/resources

Parameters:

id - the ID of the storage pool.

Returns:

the list of resource references.

getByVolume

public StoragePoolRestRep getByVolume(java.net.URI volumeId)

Gets the storage pool that contains the given volume by ID.

API Call: GET /block/volumes/{volumeId}/storage-pool

Parameters:

volumeId - the ID of the volume.

Returns:

the storage pool for the volume.

listMatchedVirtualPools

public java.util.List<NamedRelatedVirtualPoolRep> listMatchedVirtualPools(java.net.URI id)

Lists the virtual pools which match the given storage pool by ID.

API Call: GET /vdc/storage-pools/{id}/matched-vpools

Parameters:

id - the ID of the storage pool.

Returns:

the list of virtual pool references.