com.emc.vipr.client.core

Class ComputeImages

java.lang.Object

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

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

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

com.emc.vipr.client.core.ComputeImages

All Implemented Interfaces:

BulkResources<ComputeImageRestRep>, Resources<ComputeImageRestRep>, TaskResources<ComputeImageRestRep>, TopLevelResources<ComputeImageRestRep>

public class ComputeImages
extends AbstractCoreBulkResources<ComputeImageRestRep>
implements TopLevelResources<ComputeImageRestRep>, TaskResources<ComputeImageRestRep>

Compute Image resource.

Base URL: /compute/images

Constructor Summary

Constructors

Constructor and Description
ComputeImages(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<ComputeImageRestRep>	cloneImage(ComputeImageCreate input) Begins creating a compute image as a clone.
Task<ComputeImageRestRep>	create(ComputeImageCreate input) Begins creating a compute image.
void	deactivate(java.net.URI id) Begins deactivating a compute image by ID.
java.util.List<ComputeImageRestRep>	getAll() Gets the list of all compute images.
java.util.List<ComputeImageRestRep>	getAll(ResourceFilter<ComputeImageRestRep> filter) Gets the list of all compute images, optionally filtering the results.
Task<ComputeImageRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<ComputeImageRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all compute images.
java.util.List<NamedRelatedResourceRep>	listByImageType(java.lang.String imageType) Filter to show only ESX/i compute images.
Task<ComputeImageRestRep>	update(java.net.URI id, ComputeImageUpdate input) Begins updating a compute image by ID.
ComputeImages	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
ComputeImages	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

ComputeImages

public ComputeImages(ViPRCoreClient parent,
                     RestClient client)

Method Detail

withInactive

public ComputeImages withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ComputeImageRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public ComputeImages withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<ComputeImageRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

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

Lists all compute images.

API Call: GET /compute/images

Specified by:

list in interface TopLevelResources<ComputeImageRestRep>

Returns:

the list of compute image references.

getAll

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

Gets the list of all compute images. This is a convenience for getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<ComputeImageRestRep>

Returns:

the list of compute images.

See Also:

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

getAll

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

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

Specified by:

getAll in interface TopLevelResources<ComputeImageRestRep>

Parameters:

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

Returns:

the list of compute images.

See Also:

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

create

public Task<ComputeImageRestRep> create(ComputeImageCreate input)

Begins creating a compute image.

API Call: POST /compute/images

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<ComputeImageRestRep> update(java.net.URI id,
                                        ComputeImageUpdate input)

Begins updating a compute image by ID.

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

Parameters:

id - the ID of the compute image to update.

input - the update configuration.

Returns:

the compute image reference.

deactivate

public void deactivate(java.net.URI id)

Begins deactivating a compute image by ID.

API Call: POST /compute/images/{id}

Parameters:

id - the ID of the compute image to deactivate.

listByImageType

public java.util.List<NamedRelatedResourceRep> listByImageType(java.lang.String imageType)

Filter to show only ESX/i compute images.

Parameters:

imageType - the type of the image (e.g. esx, linux)

Returns:

List of ESX/i compute images.

cloneImage

public Task<ComputeImageRestRep> cloneImage(ComputeImageCreate input)

Begins creating a compute image as a clone.

API Call: POST /compute/images

Parameters:

input - the clone configuration.

Returns:

a task for monitoring the progress of the operation.