org.openstack4j.api.compute

Interface ComputeImageService

All Superinterfaces:

RestService

All Known Implementing Classes:

ComputeImageServiceImpl

public interface ComputeImageService
extends RestService

Provides access to Compute Images

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
ActionResponse	delete(String imageId) Deletes an Image based on it's identifiers.
ActionResponse	deleteMetaData(String imageId, String... keys) Delete a metadata item from an image
Image	get(String imageId) Finds an Image by the given imageId.
Map<String,String>	getMetaData(String imageId) Gets the metadata for an image
List<? extends Image>	list() Lists Images on an OpenStack Compute EndPoint.
List<? extends Image>	list(boolean detailed) Lists Images on an OpenStack Compute EndPoint.
Map<String,String>	setMetaData(String imageId, Map<String,String> metadata) Sets the metadata for an image

Method Detail

list

List<? extends Image> list()

Lists Images on an OpenStack Compute EndPoint. By default this method lists in "Detail" which means all major fields are populated for each image. This is equivalent to calling list(boolean) with {code}true{code}

Returns:

List of Image

list

List<? extends Image> list(boolean detailed)

Lists Images on an OpenStack Compute EndPoint. If detailed is false then only Image.getId(), Image.getName() and

Parameters:

detailed - true to populate all properties within each Image, false to include Id, Name and Links only (all other properties will be null)

Returns:

List of Image Image.getLinks() will be populated. True will populate all fields

get

Image get(String imageId)

Finds an Image by the given imageId.

Parameters:

imageId - the image identifier

Returns:

the specified Image

delete

ActionResponse delete(String imageId)

Deletes an Image based on it's identifiers. Images created by another user typically cannot be deleted

Parameters:

imageId - the image identifier

Returns:

the action response

getMetaData

Map<String,String> getMetaData(String imageId)

Gets the metadata for an image

Parameters:

imageId - the image identifier

Returns:

the metadata as Map

setMetaData

Map<String,String> setMetaData(String imageId,
                               Map<String,String> metadata)

Sets the metadata for an image

Parameters:

imageId - the image identifier

metadata - a Map containing the metadata

Returns:

the metadata as Map

deleteMetaData

ActionResponse deleteMetaData(String imageId,
                              String... keys)

Delete a metadata item from an image

Parameters:

imageId - the image identifier

keys - one or more keys/metadata names to remove

Returns:

the action response