Package org.openstack4j.api.sahara

Interface SaharaImageService

All Superinterfaces:

RestService

All Known Implementing Classes:

SaharaImageServiceImpl

public interface SaharaImageService
extends RestService

Sahara Data Processing Operations

Author:

[email protected]

Method Summary

Modifier and Type	Method	Description
Image	get(String imageId)	Get an image by ID
List<? extends Image>	list()	List all images
List<? extends Image>	list(String... tags)	List images with specified tag(s)
Image	register(String imageId, String username, String description)	Register a new image into Sahara image registry
Image	tag(String imageId, String... tags)	Add Tag(s) to image
ActionResponse	unregister(String imageId)	Unregister the specified image from Sahara image registry
Image	untag(String imageId, String... tags)	Remove Tag(s) from image

Method Detail

list

List<? extends Image> list()

List all images

Returns:

list of images or empty

list

List<? extends Image> list(String... tags)

List images with specified tag(s)

Parameters:

tags - one or more tags

Returns:

list of images or empty

get

Image get(String imageId)

Get an image by ID

Parameters:

imageId - the image identifier

Returns:

the image or null if not found

register

Image register(String imageId,
               String username,
               String description)

Register a new image into Sahara image registry

Parameters:

imageId - the image to register

username - the username

description - the description

Returns:

the registered image

unregister

ActionResponse unregister(String imageId)

Unregister the specified image from Sahara image registry

Parameters:

imageId - the image identifier

Returns:

the action response

tag

Image tag(String imageId,
          String... tags)

Add Tag(s) to image

Parameters:

tags - one or more tags to add

Returns:

the image

untag

Image untag(String imageId,
            String... tags)

Remove Tag(s) from image

Parameters:

tags - one or more tags to remove

Returns:

the image