org.jclouds.openstack.glance.v1_0.features

Interface ImageApi

public interface ImageApi

Image Services

Author:

Adrian Cole, Adam Lowe

See Also:

ImageAsyncApi, api doc

Method Summary

Methods

Modifier and Type	Method and Description
ImageDetails	create(String name, Payload imageData, CreateImageOptions... options) Create a new image
boolean	delete(String id) Delete the image with the specified id
ImageDetails	get(String id) Return metadata about an image with id
InputStream	getAsStream(String id) Return image data for image with id
PagedIterable<? extends Image>	list() List all images (IDs, names, links)
PaginatedCollection<? extends Image>	list(ListImageOptions options)
PagedIterable<? extends ImageDetails>	listInDetail() List all images (all details)
PaginatedCollection<? extends ImageDetails>	listInDetail(ListImageOptions options)
ImageDetails	reserve(String name, CreateImageOptions... options) Reserve a new image to be uploaded later
ImageDetails	update(String id, UpdateImageOptions... options) Adjust the metadata stored for an existing image
ImageDetails	upload(String id, Payload imageData, UpdateImageOptions... options) Upload image data for a previously-reserved image If an image was previously reserved, and thus is in the queued state, then image data can be added using this method.

Method Detail

list

PagedIterable<? extends Image> list()

List all images (IDs, names, links)

Returns:

all images (IDs, names, links)

list

PaginatedCollection<? extends Image> list(ListImageOptions options)

listInDetail

PagedIterable<? extends ImageDetails> listInDetail()

List all images (all details)

Returns:

all images (all details)

listInDetail

PaginatedCollection<? extends ImageDetails> listInDetail(ListImageOptions options)

get

@Nullable
ImageDetails get(String id)

Return metadata about an image with id

getAsStream

@Nullable
InputStream getAsStream(String id)

Return image data for image with id

create

ImageDetails create(String name,
                  Payload imageData,
                  CreateImageOptions... options)

Create a new image

Returns:

detailed metadata about the newly stored image

reserve

ImageDetails reserve(String name,
                   CreateImageOptions... options)

Reserve a new image to be uploaded later

Returns:

detailed metadata about the newly stored image

See Also:

upload(java.lang.String, org.jclouds.io.Payload, org.jclouds.openstack.glance.v1_0.options.UpdateImageOptions...)

update

ImageDetails update(String id,
                  UpdateImageOptions... options)

Adjust the metadata stored for an existing image

Returns:

detailed metadata about the updated image

upload

ImageDetails upload(String id,
                  Payload imageData,
                  UpdateImageOptions... options)

Upload image data for a previously-reserved image

If an image was previously reserved, and thus is in the queued state, then image data can be added using this method. If the image already as data associated with it (e.g. not in the queued state), then you will receive a 409 Conflict exception.

Parameters:

imageData - the new image to upload

options - can be used to adjust the metadata stored for the image in the same call

Returns:

detailed metadata about the updated image

See Also:

reserve(java.lang.String, org.jclouds.openstack.glance.v1_0.options.CreateImageOptions...)

delete

boolean delete(String id)

Delete the image with the specified id

Returns:

true if successful