Package org.jclouds.gogrid.features

Interface GridImageApi

public interface GridImageApi

Manages the server images

See Also:

Method Summary

Modifier and Type	Method	Description
ServerImage	deleteById(long id)	Deletes an existing image
ServerImage	editImageDescription(String idOrName, String newDescription)	Edits an existing image
ServerImage	editImageFriendlyName(String idOrName, String newFriendlyName)	Edits an existing image
Set<Option>	getDatacenters()	Retrieves the list of supported Datacenters to save images in.
Set<ServerImage>	getImageList(GetImageListOptions... options)	Returns all server images.
Set<ServerImage>	getImagesById(Long... ids)	Returns images, found by specified ids
Set<ServerImage>	getImagesByName(String... names)	Returns images, found by specified names
ServerImage	saveImageFromServer(String friendlyName, String idOrName, SaveImageOptions... options)	This call will save a private (visible to only you) server image to your library of available images.

Method Detail

getImageList

@GET
@Path("/grid/image/list")
Set<ServerImage> getImageList(GetImageListOptions... options)

Returns all server images.

Parameters:

options - options to narrow the search down

Returns:

server images found

getImagesById

@GET
@Path("/grid/image/get")
Set<ServerImage> getImagesById(Long... ids)

Returns images, found by specified ids

Parameters:

ids - the ids that match existing images

Returns:

images found

getImagesByName

@GET
@Path("/grid/image/get")
Set<ServerImage> getImagesByName(String... names)

Returns images, found by specified names

Parameters:

names - the names that march existing images

Returns:

images found

editImageDescription

@GET
@Path("/grid/image/edit")
ServerImage editImageDescription(@QueryParam("image")
                                 String idOrName,
                                 @QueryParam("description")
                                 String newDescription)

Edits an existing image

Parameters:

idOrName - id or name of the existing image

newDescription - description to replace the current one

Returns:

edited server image

editImageFriendlyName

@GET
@Path("/grid/image/edit")
ServerImage editImageFriendlyName(@QueryParam("image")
                                  String idOrName,
                                  @QueryParam("friendlyName")
                                  String newFriendlyName)

Edits an existing image

Parameters:

idOrName - id or name of the existing image

newFriendlyName - friendly name to replace the current one

Returns:

edited server image

getDatacenters

@GET
@Path("/common/lookup/list")
Set<Option> getDatacenters()

Retrieves the list of supported Datacenters to save images in. The objects will have datacenter ID, name and description. In most cases, id or name will be used for getImageList(org.jclouds.gogrid.options.GetImageListOptions...).

Returns:

supported datacenters

deleteById

@GET
@Path("/grid/image/delete")
ServerImage deleteById(@QueryParam("id")
                       long id)

Deletes an existing image

Parameters:

id - id of the existing image

saveImageFromServer

@GET
@Path("/grid/image/save")
ServerImage saveImageFromServer(@QueryParam("friendlyName")
                                String friendlyName,
                                @QueryParam("server")
                                String idOrName,
                                SaveImageOptions... options)

This call will save a private (visible to only you) server image to your library of available images. The image will be saved from an existing server.

Parameters:

idOrName - id or name of the existing server

friendlyName - friendly name of the image

Returns:

saved server image