com.emc.vipr.client.core

Class FileVirtualPools

java.lang.Object

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

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

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

com.emc.vipr.client.core.FileVirtualPools

All Implemented Interfaces:

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

public class FileVirtualPools
extends AbstractCoreBulkResources<FileVirtualPoolRestRep>
implements TopLevelResources<FileVirtualPoolRestRep>, ACLResources, QuotaResources

File Virtual Pools resources.

Base URL: /file/vpools

Constructor Summary

Constructors

Constructor and Description
FileVirtualPools(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
FileVirtualPoolRestRep	assignStoragePools(java.net.URI id, VirtualPoolPoolUpdateParam input) Manually updates storage pool assignments for a given file virtual pool.
FileVirtualPoolRestRep	create(FileVirtualPoolParam input) Creates a file virtual pool.
void	deactivate(FileVirtualPoolRestRep pool)
void	deactivate(java.net.URI id) Deactivates a file virtual pool.
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<FileVirtualPoolRestRep>	getAll() Gets a list of all file virtual pools.
java.util.List<FileVirtualPoolRestRep>	getAll(ResourceFilter<FileVirtualPoolRestRep> filter) Gets a list of all file virtual pools, optionally filtering the results.
java.util.List<FileVirtualPoolRestRep>	getByTenant(java.net.URI tenantId)
java.util.List<FileVirtualPoolRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<FileVirtualPoolRestRep> filter)
java.util.List<FileVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId) Gets the storage pools that are associated with the given block virtual pool.
java.util.List<FileVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId, ResourceFilter<FileVirtualPoolRestRep> filter) Gets the storage pools that are associated with the given block virtual pool.
java.util.List<FileVirtualPoolRestRep>	getByVirtualArrayAndTenant(java.net.URI varrayId, java.net.URI tenantId, ResourceFilter<FileVirtualPoolRestRep> filter)
CapacityResponse	getCapacityOnVirtualArray(java.net.URI id, java.net.URI virtualArrayId) Get the capacity of the file virtual pool on the given virtual array.
java.util.List<StoragePoolRestRep>	getMatchingStoragePools(FileVirtualPoolParam input) Gets all storage pools that would match the given file virtual pool 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 list of storage pools for the given file virtual pool by ID.
java.util.List<NamedRelatedVirtualPoolRep>	list() Lists all file 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(FileVirtualPoolParam input) Lists all storage pools that would match the given file virtual pool configuration.
java.util.List<NamedRelatedResourceRep>	listStoragePools(java.net.URI id) Lists the storage pools for the given file virtual pool by ID.
java.util.List<NamedRelatedResourceRep>	refreshMatchingStoragePools(java.net.URI id) Refreshes the storage pools that match the given file virtual pool.
FileVirtualPoolRestRep	update(java.net.URI id, FileVirtualPoolUpdateParam input) Updates a file 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.
FileVirtualPools	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
FileVirtualPools	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

FileVirtualPools

public FileVirtualPools(ViPRCoreClient parent,
                        RestClient client)

Method Detail

withInactive

public FileVirtualPools withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<FileVirtualPoolRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public FileVirtualPools withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<FileVirtualPoolRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all file virtual pools.

API Call: GET /file/vpools

Specified by:

list in interface TopLevelResources<FileVirtualPoolRestRep>

Returns:

the list of all file 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 /file/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 /file/vpools

Returns:

the list of virtual pool references of specific tenant

getByTenant

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

getByTenant

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

getAll

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

Gets a list of all file virtual pools.

This is a convenience method for: getByRefs(list())

Specified by:

getAll in interface TopLevelResources<FileVirtualPoolRestRep>

Returns:

the list of file virtual pools.

See Also:

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

getAll

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

Gets a list of all file virtual pools, optionally filtering the results.

This is a convenience method for: getByRefs(list(), filter)

Specified by:

getAll in interface TopLevelResources<FileVirtualPoolRestRep>

Parameters:

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

Returns:

the list of file virtual pools.

See Also:

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

create

public FileVirtualPoolRestRep create(FileVirtualPoolParam input)

Creates a file virtual pool.

API Call: POST /file/vpools

Parameters:

input - the virtual pool configuration.

Returns:

the newly created file virtual pool.

update

public FileVirtualPoolRestRep update(java.net.URI id,
                                     FileVirtualPoolUpdateParam input)

Updates a file virtual pool.

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

Parameters:

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

input -

Returns:

deactivate

public void deactivate(java.net.URI id)

Deactivates a file virtual pool.

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

Parameters:

id - the ID of the file virtual pool.

deactivate

public void deactivate(FileVirtualPoolRestRep 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<FileVirtualPoolRestRep> 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)

getByVirtualArray

public java.util.List<FileVirtualPoolRestRep> getByVirtualArray(java.net.URI varrayId,
                                                                ResourceFilter<FileVirtualPoolRestRep> 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)

getByVirtualArrayAndTenant

public java.util.List<FileVirtualPoolRestRep> getByVirtualArrayAndTenant(java.net.URI varrayId,
                                                                         java.net.URI tenantId,
                                                                         ResourceFilter<FileVirtualPoolRestRep> 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)

Get the capacity of the file virtual pool on the given virtual array.

API Call: GET /file/vpools/{id}/varrays/{virtualArrayId}/capacity

Parameters:

id - the ID of the file virtual pool.

virtualArrayId - the virtual array.

Returns:

the capacity on the virtual array.

listStoragePools

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

Lists the storage pools for the given file virtual pool by ID.

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

Parameters:

id - the ID of the file virtual pool.

Returns:

the list of storage pool references.

getStoragePools

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

Gets the list of storage pools for the given file virtual pool by ID. This is a convenience method for: getByRefs(listStoragePools(id)).

Parameters:

id - the ID of the file virtual pool.

Returns:

the list of storage pools.

listMatchingStoragePools

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

Lists all storage pools that would match the given file virtual pool configuration.

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

Parameters:

input - the file virtual pool configuration.

Returns:

the list of matching storage pool references.

getMatchingStoragePools

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

Gets all storage pools that would match the given file virtual pool configuration.

Parameters:

input - the file virtual pool configuration.

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 file virtual pool.

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

Parameters:

id - the ID of the file virtual pool.

Returns:

the list of currently matching storage pool references.

assignStoragePools

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

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

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

Parameters:

id - the ID of the file virtual pool.

input - the configuration of the storage pool assignments.

Returns:

the updated file virtual pool.