org.jclouds.digitalocean.features
Interface ImageApi

All Superinterfaces:

Closeable

public interface ImageApi
extends Closeable

Provides access to the Image management features.

Method Summary

void	delete(int id) Deletes an existing image.
void	delete(String slug) Deletes an existing image.
Image	get(int id) Gets the details of the given image.
Image	get(String slug) Gets the details of the given image.
List<Image>	list() Lists all available images.
int	transfer(int id, int regionId) Transfers the image to the given region.
int	transfer(String slug, int regionId) Transfers the image to the given region.

Methods inherited from interface java.io.Closeable

close

Method Detail

list

List<Image> list()

Lists all available images.

Returns:

The list of all available images.

get

@Nullable
Image get(int id)

Gets the details of the given image.

Note that Image IDs can change. The recommended way to get an image is using the get(String) method.

Parameters:

id - The id of the image to get.

Returns:

The details of the image or null if no image exists with the given id.

See Also:

get(String)

get

@Nullable
Image get(String slug)

Gets the details of the given image.

Parameters:

slug - The slug of the image to get.

Returns:

The details of the image or null if no image exists with the given slug.

See Also:

get(int)

delete

void delete(int id)

Deletes an existing image.

Parameters:

id - The id of the key pair.

delete

void delete(String slug)

Deletes an existing image.

Parameters:

slug - The slug of the key pair.

transfer

int transfer(int id,
             int regionId)

Transfers the image to the given region.

Parameters:

id - The id of the image to transfer.

regionId - The id of the region to which the image will be transferred.

Returns:

The id of the event to track the transfer process.

See Also:

transfer(String, int)

transfer

int transfer(String slug,
             int regionId)

Transfers the image to the given region.

Parameters:

slug - The slug of the image to transfer.

regionId - The id of the region to which the image will be transferred.

Returns:

The id of the event to track the transfer process.

See Also:

transfer(int, int)