org.jclouds.openstack.cinder.v1.features
Interface VolumeApi

public interface VolumeApi

Provides synchronous access to Volumes. This API strictly handles creating and managing Volumes. To attach a Volume to a Server you need to use the

See Also:

VolumeAttachmentApi, VolumeAsyncApi, API Doc

Method Summary

Volume	create(int sizeGB, CreateVolumeOptions... options) Creates a new Volume
boolean	delete(String volumeId) Delete a Volume.
Volume	get(String volumeId) Return data about the given Volume.
com.google.common.collect.FluentIterable<? extends Volume>	list() Returns a summary list of Volumes.
com.google.common.collect.FluentIterable<? extends Volume>	listInDetail() Returns a detailed list of Volumes.

Method Detail

list

@Named(value="volume:list")
com.google.common.collect.FluentIterable<? extends Volume> list()

Returns a summary list of Volumes.

Returns:

The list of Volumes

listInDetail

@Named(value="volume:list")
com.google.common.collect.FluentIterable<? extends Volume> listInDetail()

Returns a detailed list of Volumes.

Returns:

The list of Volumes

get

@Named(value="volume:get")
Volume get(String volumeId)

Return data about the given Volume.

Parameters:

volumeId - Id of the Volume

Returns:

Details of a specific Volume

create

@Named(value="volume:create")
Volume create(int sizeGB,
                    CreateVolumeOptions... options)

Creates a new Volume

Parameters:

volumeId - Id of the Volume

options - See CreateVolumeOptions

Returns:

The new Volume

delete

@Named(value="volume:delete")
boolean delete(String volumeId)

Delete a Volume. The Volume status must be Available or Error.

Parameters:

volumeId - Id of the Volume

Returns:

true if successful, false otherwise