public class StoragePools extends AbstractCoreBulkResources<StoragePoolRestRep> implements TopLevelResources<StoragePoolRestRep>
Base URL: /vdc/storage-pools
Constructor and Description |
---|
StoragePools(ViPRCoreClient parent,
RestClient client) |
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.
|
getByIds, getByRefs, listBulkIds
addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getByIds, getByRefs
addTags, get, get, getTags, removeTags, search, updateTags
public StoragePools(ViPRCoreClient parent, RestClient client)
public StoragePools withInactive(boolean inactive)
AbstractResources
withInactive
in class AbstractResources<StoragePoolRestRep>
inactive
- whether to include inactive resources.public StoragePools withInternal(boolean internal)
AbstractResources
withInternal
in class AbstractResources<StoragePoolRestRep>
internal
- whether to include internal resources.public java.util.List<NamedRelatedResourceRep> list()
API Call: GET /vdc/storage-pools
list
in interface TopLevelResources<StoragePoolRestRep>
public java.util.List<StoragePoolRestRep> getAll()
getAll
in interface TopLevelResources<StoragePoolRestRep>
TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection)
public java.util.List<StoragePoolRestRep> getAll(ResourceFilter<StoragePoolRestRep> filter)
getAll
in interface TopLevelResources<StoragePoolRestRep>
filter
- the resource filter to apply to the results as they are returned (optional).TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection, ResourceFilter)
public StoragePoolRestRep register(java.net.URI poolId, java.net.URI storageSystemId)
API Call: POST /vdc/storage-systems/{storageSystemId}/storage-pools/{poolId}/register
poolId
- the ID of the storage pool.storageSystemId
- the ID of the storage system.public StoragePoolRestRep deregister(java.net.URI id)
API Call: POST /vdc/storage-pools/{id}/deregister
id
- the ID of the storage pool.public StoragePoolRestRep update(java.net.URI id, StoragePoolUpdate input)
API Call: PUT /vdc/storage-pools/{id}
id
- the ID of the storage pool.input
- the update configuration.public java.util.List<NamedRelatedResourceRep> listByStorageSystem(java.net.URI storageSystemId)
API Call: GET /vdc/storage-systems/{storageSystemId}/storage-pools
storageSystemId
- the ID of the storage system.public java.util.List<StoragePoolRestRep> getByStorageSystem(java.net.URI storageSystemId)
storageSystemId
- the ID of the storage system.public java.util.List<StoragePoolRestRep> getByStorageSystem(java.net.URI storageSystemId, ResourceFilter<StoragePoolRestRep> filter)
storageSystemId
- the ID of the storage system.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<NamedRelatedResourceRep> listByVirtualArray(java.net.URI varrayId)
API Call: GET /vdc/varrays/{id}/storage-pools
varrayId
- the ID of the virtual array.public java.util.List<StoragePoolRestRep> getByVirtualArray(java.net.URI varrayId)
varrayId
- the ID of the virtual array.listByVirtualArray(URI)
,
AbstractResources.getByRefs(java.util.Collection)
public java.util.List<TypedRelatedResourceRep> listResources(java.net.URI id)
API Call: GET /vdc/storage-pools/{id}/resources
id
- the ID of the storage pool.public StoragePoolRestRep getByVolume(java.net.URI volumeId)
API Call: GET /block/volumes/{volumeId}/storage-pool
volumeId
- the ID of the volume.public java.util.List<NamedRelatedVirtualPoolRep> listMatchedVirtualPools(java.net.URI id)
API Call: GET /vdc/storage-pools/{id}/matched-vpools
id
- the ID of the storage pool.