org.jclouds.openstack.nova.v2_0.features

Interface ImageApi

public interface ImageApi

Provides synchronous access to Images.

Author:

Adrian Cole

See Also:

ImageAsyncApi,

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String id) Delete the specified image
void	deleteMetadata(String id, String key) Delete a metadata item from an image.
Image	get(String id) List details of the specified image
Map<String,String>	getMetadata(String id) List all metadata for an image.
String	getMetadata(String id, String key) Update the metadata for an image.
PagedIterable<? extends Resource>	list() List all images (IDs, names, links)
PaginatedCollection<? extends Resource>	list(PaginationOptions options)
PagedIterable<? extends Image>	listInDetail() List all images (all details)
PaginatedCollection<? extends Image>	listInDetail(PaginationOptions options)
Map<String,String>	setMetadata(String id, Map<String,String> metadata) Sets the metadata for an image.
Map<String,String>	updateMetadata(String id, Map<String,String> metadata) Update the metadata for a server.
String	updateMetadata(String id, String key, String value) Set a metadata item for an image.

Method Detail

list

PagedIterable<? extends Resource> list()

List all images (IDs, names, links)

Returns:

all images (IDs, names, links)

list

PaginatedCollection<? extends Resource> list(PaginationOptions options)

listInDetail

PagedIterable<? extends Image> listInDetail()

List all images (all details)

Returns:

all images (all details)

listInDetail

PaginatedCollection<? extends Image> listInDetail(PaginationOptions options)

get

Image get(String id)

List details of the specified image

Parameters:

id - id of the server

Returns:

server or null if not found

delete

void delete(String id)

Delete the specified image

Parameters:

id - id of the image

getMetadata

Map<String,String> getMetadata(String id)

List all metadata for an image.

Parameters:

id - id of the image

Returns:

the metadata as a Map

setMetadata

Map<String,String> setMetadata(String id,
                             Map<String,String> metadata)

Sets the metadata for an image.

Parameters:

id - id of the image

metadata - a Map containing the metadata

Returns:

the metadata as a Map

updateMetadata

Map<String,String> updateMetadata(String id,
                                Map<String,String> metadata)

Update the metadata for a server.

Parameters:

id - id of the image

metadata - a Map containing the metadata

Returns:

the metadata as a Map

getMetadata

@Nullable
String getMetadata(String id,
                          String key)

Update the metadata for an image.

Parameters:

id - id of the image

metadata - a Map containing the metadata

Returns:

the value or null if not present

updateMetadata

String updateMetadata(String id,
                    String key,
                    String value)

Set a metadata item for an image.

Parameters:

id - id of the image

key - the name of the metadata item

value - the value of the metadata item

Returns:

the value you updated

deleteMetadata

void deleteMetadata(String id,
                  String key)

Delete a metadata item from an image.

Parameters:

id - id of the image

key - the name of the metadata item