com.emc.vipr.client.core

Class ComputeImageServers

java.lang.Object

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

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

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

com.emc.vipr.client.core.ComputeImageServers

All Implemented Interfaces:

BulkResources<ComputeImageServerRestRep>, Resources<ComputeImageServerRestRep>, TaskResources<ComputeImageServerRestRep>, TopLevelResources<ComputeImageServerRestRep>

public class ComputeImageServers
extends AbstractCoreBulkResources<ComputeImageServerRestRep>
implements TopLevelResources<ComputeImageServerRestRep>, TaskResources<ComputeImageServerRestRep>

Storage Systems resources.

Base URL: /compute/compute-imageservers

Constructor Summary

Constructors

Constructor and Description
ComputeImageServers(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<ComputeImageServerRestRep>	create(ComputeImageServerCreate input) Begins creating a compute image server.
void	deactivate(java.net.URI id) Deletes the given compute image server by ID.
java.util.List<ComputeImageServerRestRep>	getAll() Gets the list of all compute image servers.
java.util.List<ComputeImageServerRestRep>	getAll(ResourceFilter<ComputeImageServerRestRep> filter) Gets the list of all compute image servers, optionally filtering the results.
Task<ComputeImageServerRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<ComputeImageServerRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all compute image servers.
ComputeImageServerRestRep	update(java.net.URI id, ComputeImageServerUpdate input) Begins updating the given compute image servers by ID.
ComputeImageServers	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

ComputeImageServers

public ComputeImageServers(ViPRCoreClient parent,
                           RestClient client)

Method Detail

withInactive

public ComputeImageServers withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ComputeImageServerRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

getTasks

public Tasks<ComputeImageServerRestRep> 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<ComputeImageServerRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<ComputeImageServerRestRep> 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<ComputeImageServerRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

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

Lists all compute image servers.

API Call: GET /compute/compute-imageservers

Specified by:

list in interface TopLevelResources<ComputeImageServerRestRep>

Returns:

the list of compute image server references.

getAll

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

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

Specified by:

getAll in interface TopLevelResources<ComputeImageServerRestRep>

Returns:

the list of all compute image servers.

See Also:

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

getAll

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

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

Specified by:

getAll in interface TopLevelResources<ComputeImageServerRestRep>

Parameters:

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

Returns:

the list of all compute image servers.

See Also:

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

create

public Task<ComputeImageServerRestRep> create(ComputeImageServerCreate input)

Begins creating a compute image server.

API Call: POST /compute/computeimageservers

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public ComputeImageServerRestRep update(java.net.URI id,
                                        ComputeImageServerUpdate input)

Begins updating the given compute image servers by ID.

API Call: PUT /compute/compute-imageservers/{id}

Parameters:

id - the ID of the compute image server.

input - the update configuration.

Returns:

ComputeImageServerRestRep.

deactivate

public void deactivate(java.net.URI id)

Deletes the given compute image server by ID. API Call: POST /compute-imageservers/{id}/deactivate

Parameters:

id - the ID of the compute image server to delete.