com.emc.vipr.client.core

Class BlockVirtualPools

java.lang.Object

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

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

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

com.emc.vipr.client.core.BlockVirtualPools

All Implemented Interfaces:

ACLResources, BulkResources<BlockVirtualPoolRestRep>, QuotaResources, Resources<BlockVirtualPoolRestRep>, TopLevelResources<BlockVirtualPoolRestRep>

public class BlockVirtualPools
extends AbstractCoreBulkResources<BlockVirtualPoolRestRep>
implements TopLevelResources<BlockVirtualPoolRestRep>, ACLResources, QuotaResources

Block Virtual Pools resource.

Base URL: /block/vpools

Constructor Summary

Constructors

Constructor and Description
BlockVirtualPools(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
BlockVirtualPoolRestRep	assignStoragePools(java.net.URI id, VirtualPoolPoolUpdateParam input) Manually updates storage pool assignments for a given block virtual pool.
BlockVirtualPoolRestRep	create(BlockVirtualPoolParam input) Creates a new block virtual pool.
void	deactivate(BlockVirtualPoolRestRep pool)
void	deactivate(java.net.URI id) Deactivates a block virtual pool.
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<BlockVirtualPoolRestRep>	getAll() Gets all block virtual pools.
java.util.List<BlockVirtualPoolRestRep>	getAll(ResourceFilter<BlockVirtualPoolRestRep> filter) Gets all block virtual pools, optionally filtering the results.
java.util.List<BlockVirtualPoolRestRep>	getByTenant(java.net.URI tenantId)
java.util.List<BlockVirtualPoolRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<BlockVirtualPoolRestRep> filter)
java.util.List<BlockVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId) Gets the storage pools that are associated with the given block virtual pool.
java.util.List<BlockVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId, ResourceFilter<BlockVirtualPoolRestRep> filter) Gets the storage pools that are associated with the given block virtual pool.
java.util.List<BlockVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId, java.net.URI tenantId, ResourceFilter<BlockVirtualPoolRestRep> filter)
java.util.List<BlockVirtualPoolRestRep>	getByVirtualArrayAndTenant(java.net.URI varrayId, java.net.URI tenantId) Gets the storage pools that are associated with the given block virtual pool and tenant.
CapacityResponse	getCapacityOnVirtualArray(java.net.URI id, java.net.URI virtualArrayId) Gets the virtual pool capacity on a given virtual array.
java.util.List<StoragePoolRestRep>	getMatchingStoragePools(BlockVirtualPoolParam input) Get the storage pools that would match a block virtual pool with the given configuration.
QuotaInfo	getQuota(java.net.URI id) Gets the quota information for a given resource by ID.
java.util.List<StoragePoolRestRep>	getStoragePools(java.net.URI id) Gets the storage pools that are associated with the given block virtual pool
java.util.List<NamedRelatedVirtualPoolRep>	list() Lists all block virtual pools.
java.util.List<NamedRelatedVirtualPoolRep>	listByTenant(java.net.URI tenantId) Lists all virtual pools of specific tenant
java.util.List<NamedRelatedVirtualPoolRep>	listByVDC(java.lang.String shortVdcId) Lists all virtual pools in a virtual data center
java.util.List<NamedRelatedVirtualPoolRep>	listByVirtualArray(java.net.URI varrayId) Lists the virtual pools that are associated with the given virtual array.
java.util.List<NamedRelatedVirtualPoolRep>	listByVirtualArrayAndTenant(java.net.URI varrayId, java.net.URI tenantId)
java.util.List<NamedRelatedResourceRep>	listMatchingStoragePools(BlockVirtualPoolParam input) Lists the storage pools that would match a block virtual pool with the given configuration.
java.util.List<NamedRelatedResourceRep>	listStoragePools(java.net.URI id) Lists the storage pools that are associated with the given block virtual pool.
java.util.List<VirtualPoolChangeRep>	listVirtualPoolChangeCandidates(java.net.URI id, BulkIdParam input) Lists virtual pool change candidates for the given block virtual pool.
java.util.List<NamedRelatedResourceRep>	refreshMatchingStoragePools(java.net.URI id) Refreshes the storage pools that match the given block virtual pool.
BlockVirtualPoolRestRep	update(java.net.URI id, BlockVirtualPoolUpdateParam input) Updates a block virtual pool.
java.util.List<ACLEntry>	updateACLs(java.net.URI id, ACLAssignmentChanges aclChanges) Updates the ACL entries for a given resource by ID.
QuotaInfo	updateQuota(java.net.URI id, QuotaUpdateParam quota) Updates the quota information for a given resource by ID.
BlockVirtualPools	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockVirtualPools	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

BlockVirtualPools

public BlockVirtualPools(ViPRCoreClient parent,
                         RestClient client)

Method Detail

withInactive

public BlockVirtualPools withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<BlockVirtualPoolRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockVirtualPools withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<BlockVirtualPoolRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all block virtual pools.

API Call: GET /block/vpools

Specified by:

list in interface TopLevelResources<BlockVirtualPoolRestRep>

Returns:

the list of block virtual pool references.

listByVDC

public java.util.List<NamedRelatedVirtualPoolRep> listByVDC(java.lang.String shortVdcId)

Lists all virtual pools in a virtual data center

API Call: GET /block/vpools

Returns:

the list of virtual pool references in a virtual data center

listByTenant

public java.util.List<NamedRelatedVirtualPoolRep> listByTenant(java.net.URI tenantId)

Lists all virtual pools of specific tenant

API Call: GET /block/vpools

Returns:

the list of virtual pool references of specific tenant

getByTenant

public java.util.List<BlockVirtualPoolRestRep> getByTenant(java.net.URI tenantId)

getByTenant

public java.util.List<BlockVirtualPoolRestRep> getByTenant(java.net.URI tenantId,
                                                           ResourceFilter<BlockVirtualPoolRestRep> filter)

getAll

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

Gets all block virtual pools.

Specified by:

getAll in interface TopLevelResources<BlockVirtualPoolRestRep>

Returns:

the list of block virtual pools.

See Also:

list(), AbstractResources.getByRefs(java.util.Collection)

getAll

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

Gets all block virtual pools, optionally filtering the results.

Specified by:

getAll in interface TopLevelResources<BlockVirtualPoolRestRep>

Parameters:

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

Returns:

the list of block virtual pools.

See Also:

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

create

public BlockVirtualPoolRestRep create(BlockVirtualPoolParam input)

Creates a new block virtual pool.

API Call: POST /block/vpools

Parameters:

input - the create configuration.

Returns:

the newly created block virtual pool.

update

public BlockVirtualPoolRestRep update(java.net.URI id,
                                      BlockVirtualPoolUpdateParam input)

Updates a block virtual pool.

API Call: PUT /block/vpools/{id}

Parameters:

id - the ID of the block virtual pool to update.

input - the update configuration.

Returns:

the updated block virtual pool.

deactivate

public void deactivate(java.net.URI id)

Deactivates a block virtual pool.

API Call: POST /block/vpools/{id}/deactivate

Parameters:

id - the ID of the block virtual pool to deactivate.

deactivate

public void deactivate(BlockVirtualPoolRestRep pool)

listByVirtualArray

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

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

API Call: GET /vdc/varrays/{id}/vpools

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of virtual pool references.

listByVirtualArrayAndTenant

public java.util.List<NamedRelatedVirtualPoolRep> listByVirtualArrayAndTenant(java.net.URI varrayId,
                                                                              java.net.URI tenantId)

getByVirtualArray

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

Gets the storage pools that are associated with the given block virtual pool. Convenience method for calling getByRefs(listByVirtualArray(varrayId)).

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of virtual pools.

See Also:

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

getByVirtualArrayAndTenant

public java.util.List<BlockVirtualPoolRestRep> getByVirtualArrayAndTenant(java.net.URI varrayId,
                                                                          java.net.URI tenantId)

Gets the storage pools that are associated with the given block virtual pool and tenant.

Parameters:

varrayId - the ID of the virtual array.

tenantId - the ID of tenant

Returns:

the list of virtual pools.

See Also:

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

getByVirtualArray

public java.util.List<BlockVirtualPoolRestRep> getByVirtualArray(java.net.URI varrayId,
                                                                 ResourceFilter<BlockVirtualPoolRestRep> filter)

Gets the storage pools that are associated with the given block virtual pool. Convenience method for calling getByRefs(listByVirtualArray(varrayId)).

Parameters:

varrayId - the ID of the virtual array.

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

Returns:

the list of virtual pools.

See Also:

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

getByVirtualArray

public java.util.List<BlockVirtualPoolRestRep> getByVirtualArray(java.net.URI varrayId,
                                                                 java.net.URI tenantId,
                                                                 ResourceFilter<BlockVirtualPoolRestRep> filter)

getACLs

public java.util.List<ACLEntry> getACLs(java.net.URI id)

Description copied from interface: ACLResources

Gets the ACL entries for a given resource by ID.

API Call: GET baseUrl/{id}/acl

Specified by:

getACLs in interface ACLResources

Parameters:

id - the resource ID.

Returns:

the list of ACL entries.

updateACLs

public java.util.List<ACLEntry> updateACLs(java.net.URI id,
                                           ACLAssignmentChanges aclChanges)

Description copied from interface: ACLResources

Updates the ACL entries for a given resource by ID.

API Call: PUT baseUrl/{id}/acl

Specified by:

updateACLs in interface ACLResources

Parameters:

id - the resource ID.

aclChanges - the ACL changes to perform (ACL entries to add/remove).

Returns:

the resulting list of ACL entries after performing the update.

getQuota

public QuotaInfo getQuota(java.net.URI id)

Description copied from interface: QuotaResources

Gets the quota information for a given resource by ID.

API Call: GET baseUrl/{id}/quota

Specified by:

getQuota in interface QuotaResources

Parameters:

id - the resource ID.

Returns:

the quota information.

updateQuota

public QuotaInfo updateQuota(java.net.URI id,
                             QuotaUpdateParam quota)

Description copied from interface: QuotaResources

Updates the quota information for a given resource by ID.

API Call: PUT baseUrl/{id}/quota

Specified by:

updateQuota in interface QuotaResources

Parameters:

id - the resource ID.

quota - the update to the quota.

Returns:

the updated quota information after applying the update.

getCapacityOnVirtualArray

public CapacityResponse getCapacityOnVirtualArray(java.net.URI id,
                                                  java.net.URI virtualArrayId)

Gets the virtual pool capacity on a given virtual array.

API Call: GET /block/vpools/{id}/varrays/{varrayId}/capacity

Parameters:

id - the ID of the block virtual pool.

virtualArrayId - the ID of the virtual array.

Returns:

the capacity information.

listStoragePools

public java.util.List<NamedRelatedResourceRep> listStoragePools(java.net.URI id)

Lists the storage pools that are associated with the given block virtual pool.

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

Parameters:

id - the ID of the block virtual pool.

Returns:

the list of storage pool references.

getStoragePools

public java.util.List<StoragePoolRestRep> getStoragePools(java.net.URI id)

Gets the storage pools that are associated with the given block virtual pool

Parameters:

id - the ID of the block virtual pool.

Returns:

the list of storage pools.

See Also:

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

listMatchingStoragePools

public java.util.List<NamedRelatedResourceRep> listMatchingStoragePools(BlockVirtualPoolParam input)

Lists the storage pools that would match a block virtual pool with the given configuration.

API Call: POST /block/vpools/matching-pools

Parameters:

input - the configuration for a potential block virtual pool.

Returns:

the list of matching storage pool references.

getMatchingStoragePools

public java.util.List<StoragePoolRestRep> getMatchingStoragePools(BlockVirtualPoolParam input)

Get the storage pools that would match a block virtual pool with the given configuration.

Parameters:

input - the configuration for potential block virtual pool.

Returns:

the list of matching storage pools.

refreshMatchingStoragePools

public java.util.List<NamedRelatedResourceRep> refreshMatchingStoragePools(java.net.URI id)

Refreshes the storage pools that match the given block virtual pool.

API Call: GET /block/vpools/{id}/refresh-matched-pools

Parameters:

id - the ID of the block virtual pool.

Returns:

the list of currently matching storage pool references.

assignStoragePools

public BlockVirtualPoolRestRep assignStoragePools(java.net.URI id,
                                                  VirtualPoolPoolUpdateParam input)

Manually updates storage pool assignments for a given block virtual pool.

API Call: PUT /block/vpools/{id}/assign-matched-pools

Parameters:

id - the ID of the block virtual pool.

input - the configuration of the storage pool assignments.

Returns:

the updated block virtual pool.

listVirtualPoolChangeCandidates

public java.util.List<VirtualPoolChangeRep> listVirtualPoolChangeCandidates(java.net.URI id,
                                                                            BulkIdParam input)

Lists virtual pool change candidates for the given block virtual pool.

API Call: GET /block/vpools/{id}/vpool-change/vpool

Parameters:

id - the ID of the block virtual pool.

Returns:

the list of virtual pool candidates.