com.emc.vipr.client.core

Class ComputeSystems

java.lang.Object

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

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

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

com.emc.vipr.client.core.ComputeSystems

All Implemented Interfaces:

BulkResources<ComputeSystemRestRep>, Resources<ComputeSystemRestRep>, TaskResources<ComputeSystemRestRep>, TopLevelResources<ComputeSystemRestRep>

public class ComputeSystems
extends AbstractCoreBulkResources<ComputeSystemRestRep>
implements TopLevelResources<ComputeSystemRestRep>, TaskResources<ComputeSystemRestRep>

Storage Systems resources.

Base URL: /vdc/compute-systems

Constructor Summary

Constructors

Constructor and Description
ComputeSystems(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<ComputeSystemRestRep>	create(ComputeSystemCreate input) Begins creating a compute system.
Task<ComputeSystemRestRep>	deactivate(java.net.URI id) Begins deactivating the given compute system by ID.
ComputeSystemRestRep	deregister(java.net.URI id) De-registers the given storage system by ID.
Task<ComputeSystemRestRep>	discover(java.net.URI id) Begins discovery on the given compute system.
Tasks<ComputeSystemRestRep>	discoverAll() Begins discovery on all compute systems.
java.util.List<ComputeSystemRestRep>	getAll() Gets the list of all compute systems.
java.util.List<ComputeSystemRestRep>	getAll(ResourceFilter<ComputeSystemRestRep> filter) Gets the list of all compute systems, optionally filtering the results.
java.util.List<ComputeElementRestRep>	getComputeElements(java.net.URI id) Gets the list of Compute Elements in the given Compute System.
Task<ComputeSystemRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<ComputeSystemRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all compute systems.
ComputeSystemRestRep	register(java.net.URI id) Registers the given storage system by ID.
Task<ComputeSystemRestRep>	update(java.net.URI id, ComputeSystemUpdate input) Begins updating the given compute system by ID.
ComputeSystems	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

ComputeSystems

public ComputeSystems(ViPRCoreClient parent,
                      RestClient client)

Method Detail

withInactive

public ComputeSystems withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ComputeSystemRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

getTasks

public Tasks<ComputeSystemRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<ComputeSystemRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<ComputeSystemRestRep> getTask(java.net.URI id,
                                          java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<ComputeSystemRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

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

Lists all compute systems.

API Call: GET /vdc/compute-systems

Specified by:

list in interface TopLevelResources<ComputeSystemRestRep>

Returns:

the list of compute system references.

getAll

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

Gets the list of all compute systems. This is a convenience method for: getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<ComputeSystemRestRep>

Returns:

the list of all compute systems.

See Also:

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

getAll

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

Gets the list of all compute systems, optionally filtering the results. This is a convenience method for: getByRefs(list(), filter).

Specified by:

getAll in interface TopLevelResources<ComputeSystemRestRep>

Parameters:

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

Returns:

the list of all compute systems.

See Also:

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

create

public Task<ComputeSystemRestRep> create(ComputeSystemCreate input)

Begins creating a compute system.

API Call: POST /vdc/compute-systems

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<ComputeSystemRestRep> update(java.net.URI id,
                                         ComputeSystemUpdate input)

Begins updating the given compute system by ID.

API Call: PUT /vdc/compute-systems/{id}

Parameters:

id - the ID of the compute system.

input - the update configuration.

Returns:

a task for monitoring the progress of the operation.

deactivate

public Task<ComputeSystemRestRep> deactivate(java.net.URI id)

Begins deactivating the given compute system by ID.

API Call: POST /vdc/compute-systems/{id}/deactivate

Parameters:

id - the ID of the compute system.

Returns:

a task for monitoring the progress of the operation.

discoverAll

public Tasks<ComputeSystemRestRep> discoverAll()

Begins discovery on all compute systems.

API Call: POST /vdc/compute-systems/discover

Returns:

Tasks for monitoring the progress of the operation(s).

discover

public Task<ComputeSystemRestRep> discover(java.net.URI id)

Begins discovery on the given compute system.

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

Parameters:

id - the ID of the compute system.

Returns:

a task for monitoring the progress of the operation.

register

public ComputeSystemRestRep register(java.net.URI id)

Registers the given storage system by ID.

API Call: POST /vdc/storage-systems/{id}/register

Parameters:

id - the ID of the storage system.

Returns:

the updated storage system.

deregister

public ComputeSystemRestRep deregister(java.net.URI id)

De-registers the given storage system by ID.

API Call: POST /vdc/storage-systems/{id}/deregister

Parameters:

id - the ID of the storage system.

Returns:

the updated storage system.

getComputeElements

public java.util.List<ComputeElementRestRep> getComputeElements(java.net.URI id)

Gets the list of Compute Elements in the given Compute System.

API Call: GET /vdc/compute-systems/{id}/compute-elements

Parameters:

id - the ID of the compute system.

Returns:

the list of Compute Elements.