com.emc.vipr.client.core

Class ComputeElements

java.lang.Object

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

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

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

com.emc.vipr.client.core.ComputeElements

All Implemented Interfaces:

BulkResources<ComputeElementRestRep>, Resources<ComputeElementRestRep>, TopLevelResources<ComputeElementRestRep>

public class ComputeElements
extends AbstractCoreBulkResources<ComputeElementRestRep>
implements TopLevelResources<ComputeElementRestRep>

Compute Elements resources.

Base URL: /vdc/compute-elements

Constructor Summary

Constructors

Constructor and Description
ComputeElements(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
ComputeElementRestRep	deregister(java.net.URI id) Deregisters a compute element.
java.util.List<ComputeElementRestRep>	getAll() Gets all compute elements.
java.util.List<ComputeElementRestRep>	getAll(ResourceFilter<ComputeElementRestRep> filter) Gets all compute elements.
java.util.List<NamedRelatedResourceRep>	list() Lists all compute elements.
ComputeElementRestRep	rediscover(java.net.URI id) Rediscover a compute element.
ComputeElementRestRep	register(java.net.URI computeElementId) Registers a compute element with the given compute system.
ComputeElements	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

ComputeElements

public ComputeElements(ViPRCoreClient parent,
                       RestClient client)

Method Detail

withInactive

public ComputeElements withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ComputeElementRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

list

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

Lists all compute elements.

API Call: GET /vdc/compute-elements

Specified by:

list in interface TopLevelResources<ComputeElementRestRep>

Returns:

the list of all compute element references.

getAll

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

Gets all compute elements. This is a convenience method for: getByRefs(list())

Specified by:

getAll in interface TopLevelResources<ComputeElementRestRep>

Returns:

the list of all compute elements.

See Also:

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

getAll

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

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

Specified by:

getAll in interface TopLevelResources<ComputeElementRestRep>

Parameters:

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

Returns:

the list of all compute elements.

See Also:

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

rediscover

public ComputeElementRestRep rediscover(java.net.URI id)

Rediscover a compute element.

API Call: POST /vdc/compute-elements/{id}/discover

Parameters:

id - the ID of the compute element.

register

public ComputeElementRestRep register(java.net.URI computeElementId)

Registers a compute element with the given compute system.

API Call: POST /vdc/compute-systems/{computeSystemId}/compute-elements/{computeElementId}/register

Parameters:

computeElementId - the ID of the compute element.

Returns:

the compute element.

deregister

public ComputeElementRestRep deregister(java.net.URI id)

Deregisters a compute element.

API Call: POST /vdc/compute-elements/{id}/deregister

Parameters:

id - the ID of the compute element.