org.jclouds.openstack.nova.v2_0.features
Interface ImageApi

public interface ImageApi

Provides access to the OpenStack Compute (Nova) Image API.

Method Summary

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.
org.jclouds.collect.PagedIterable<org.jclouds.openstack.v2_0.domain.Resource>	list() List all images (IDs, names, links)
org.jclouds.openstack.v2_0.domain.PaginatedCollection<org.jclouds.openstack.v2_0.domain.Resource>	list(org.jclouds.openstack.v2_0.options.PaginationOptions options)
org.jclouds.collect.PagedIterable<Image>	listInDetail() List all images (all details)
org.jclouds.openstack.v2_0.domain.PaginatedCollection<Image>	listInDetail(org.jclouds.openstack.v2_0.options.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

@Named(value="image:list")
org.jclouds.collect.PagedIterable<org.jclouds.openstack.v2_0.domain.Resource> list()

List all images (IDs, names, links)

Returns:

all images (IDs, names, links)

list

@Named(value="image:list")
org.jclouds.openstack.v2_0.domain.PaginatedCollection<org.jclouds.openstack.v2_0.domain.Resource> list(org.jclouds.openstack.v2_0.options.PaginationOptions options)

listInDetail

@Named(value="image:list")
org.jclouds.collect.PagedIterable<Image> listInDetail()

List all images (all details)

Returns:

all images (all details)

listInDetail

@Named(value="image:list")
org.jclouds.openstack.v2_0.domain.PaginatedCollection<Image> listInDetail(org.jclouds.openstack.v2_0.options.PaginationOptions options)

get

@Named(value="image:get")
@Nullable
Image get(String id)

List details of the specified image

Parameters:

id - id of the server

Returns:

server or null if not found

delete

@Named(value="image:delete")
void delete(String id)

Delete the specified image

Parameters:

id - id of the image

getMetadata

@Named(value="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

@Named(value="image: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

@Named(value="image: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

@Named(value="image: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

@Named(value="image:updateMetadata")
@Nullable
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

@Named(value="image: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