com.emc.vipr.client.core

Class ComputeVirtualPools

java.lang.Object

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

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

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

com.emc.vipr.client.core.ComputeVirtualPools

All Implemented Interfaces:

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

public class ComputeVirtualPools
extends AbstractCoreBulkResources<ComputeVirtualPoolRestRep>
implements TopLevelResources<ComputeVirtualPoolRestRep>, ACLResources, QuotaResources

Compute Virtual Pools resource.

Base URL: /compute/vpools

Constructor Summary

Constructors

Constructor and Description
ComputeVirtualPools(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
ComputeVirtualPoolRestRep	assignComputeElements(java.net.URI id, ComputeVirtualPoolElementUpdateParam input) Updates a compute virtual pool.
ComputeVirtualPoolRestRep	create(ComputeVirtualPoolCreateParam input) Creates a new compute virtual pool.
void	deactivate(ComputeVirtualPoolRestRep pool)
void	deactivate(java.net.URI id) Deactivates a compute virtual pool.
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<ComputeVirtualPoolRestRep>	getAll() Gets all compute virtual pools.
java.util.List<ComputeVirtualPoolRestRep>	getAll(ResourceFilter<ComputeVirtualPoolRestRep> filter) Gets all compute virtual pools, optionally filtering the results.
java.util.List<ComputeVirtualPoolRestRep>	getByTenant(java.net.URI tenantId) Get all virtual pools of specific tenant
java.util.List<ComputeVirtualPoolRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<ComputeVirtualPoolRestRep> filter) Gets all compute virtual pools of specific tenant, optionally filtering the results.
java.util.List<ComputeVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId) Gets the compute virtual pools that are associated with the given virtual array.
java.util.List<ComputeVirtualPoolRestRep>	getByVirtualArray(java.net.URI varrayId, java.net.URI tenantId, ResourceFilter<ComputeVirtualPoolRestRep> filter) Gets the compute virtual pools that are associated with the given virtual array and specific tenant.
java.util.List<ComputeVirtualPoolRestRep>	getByVirtualArrayAndTenant(java.net.URI varrayId, java.net.URI tenantId) Gets the compute virtual pools that are associated with the given virtual array and tenant.
ComputeVirtualPoolRestRep	getComputeVirtualPool(java.net.URI id) Get a compute virtual pool.
ComputeElementListRestRep	getMatchedComputeElements(java.net.URI id) Lists elements of a compute virtual pool.
QuotaInfo	getQuota(java.net.URI id) Gets the quota information for a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all compute virtual pools.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists all virtual pools of specific tenant
java.util.List<NamedRelatedResourceRep>	listComputeElements(java.net.URI id)
java.util.List<ComputeElementRestRep>	listMatchingComputeElements(ComputeVirtualPoolCreateParam input) Lists the compute elements that would match a virtual compute pool with the given configuration.
ComputeVirtualPoolRestRep	update(java.net.URI id, ComputeVirtualPoolUpdateParam input) Updates a compute 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.
ComputeVirtualPools	withInactive(boolean inactive) Configures the fetch operations to include inactive 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, withInternal

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

ComputeVirtualPools

public ComputeVirtualPools(ViPRCoreClient parent,
                           RestClient client)

Method Detail

withInactive

public ComputeVirtualPools withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ComputeVirtualPoolRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

list

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

Lists all compute virtual pools.

API Call: GET /compute/vpools

Specified by:

list in interface TopLevelResources<ComputeVirtualPoolRestRep>

Returns:

the list of compute virtual pool references.

listByTenant

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

Lists all virtual pools of specific tenant

API Call: GET /compute/vpools

Returns:

the list of virtual pool references of specific tenant

getByTenant

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

Get all virtual pools of specific tenant

Parameters:

tenantId - the ID of the tenant

Returns:

the list of compute virtual pool of specific tenant

getByTenant

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

Gets all compute virtual pools of specific tenant, optionally filtering the results.

Parameters:

tenantId - the ID of the tenant

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

Returns:

the list of compute virtual pools.

getAll

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

Gets all compute virtual pools.

Specified by:

getAll in interface TopLevelResources<ComputeVirtualPoolRestRep>

Returns:

the list of compute virtual pools.

See Also:

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

getAll

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

Gets all compute virtual pools, optionally filtering the results.

Specified by:

getAll in interface TopLevelResources<ComputeVirtualPoolRestRep>

Parameters:

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

Returns:

the list of compute virtual pools.

See Also:

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

getByVirtualArray

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

Gets the compute virtual pools that are associated with the given virtual array. Convenience method for calling getByRefs(listByVirtualArray(varrayId)).

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of virtual pools.

getByVirtualArrayAndTenant

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

Gets the compute virtual pools that are associated with the given virtual array and tenant.

Parameters:

varrayId - the ID of the virtual array.

tenantId - the ID of tenant

Returns:

the list of virtual pools.

getByVirtualArray

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

Gets the compute virtual pools that are associated with the given virtual array and specific tenant.

Parameters:

varrayId - the ID of the virtual array.

tenantId - the ID of the tenant.

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

Returns:

the list of compute virtual pools.

create

public ComputeVirtualPoolRestRep create(ComputeVirtualPoolCreateParam input)

Creates a new compute virtual pool.

API Call: POST /compute/vpools

Parameters:

input - the create configuration.

Returns:

the newly created compute virtual pool.

update

public ComputeVirtualPoolRestRep update(java.net.URI id,
                                        ComputeVirtualPoolUpdateParam input)

Updates a compute virtual pool.

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

Parameters:

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

input - the update configuration.

Returns:

the updated compute virtual pool.

deactivate

public void deactivate(java.net.URI id)

Deactivates a compute virtual pool.

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

Parameters:

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

deactivate

public void deactivate(ComputeVirtualPoolRestRep pool)

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.

listComputeElements

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

listMatchingComputeElements

public java.util.List<ComputeElementRestRep> listMatchingComputeElements(ComputeVirtualPoolCreateParam input)

Lists the compute elements that would match a virtual compute pool with the given configuration.

API Call: POST /compute/vpools/matching-elements

Parameters:

input - the configuration for a potential virtual compute pool.

Returns:

the list of matching compute element references.

assignComputeElements

public ComputeVirtualPoolRestRep assignComputeElements(java.net.URI id,
                                                       ComputeVirtualPoolElementUpdateParam input)

Updates a compute virtual pool.

API Call: PUT /compute/vpools/{id}/assign-matched-elements

Parameters:

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

input - the update configuration.

Returns:

the updated compute virtual pool.

getMatchedComputeElements

public ComputeElementListRestRep getMatchedComputeElements(java.net.URI id)

Lists elements of a compute virtual pool.

API Call: GET /compute/vpools/{id}/matched-elements

Parameters:

id - the ID of the compute virtual pool .

Returns:

the list of elements from the compute virtual pool.

getComputeVirtualPool

public ComputeVirtualPoolRestRep getComputeVirtualPool(java.net.URI id)

Get a compute virtual pool.

API Call: GET /compute/vpools/{id}

Parameters:

id - the ID of the compute virtual pool .

Returns:

the list of elements from the compute virtual pool.