org.jclouds.openstack.nova.v2_0.extensions
Interface VolumeApi

@Beta
public interface VolumeApi

Provides access to the OpenStack Compute (Nova) Volume extension API.

Method Summary

VolumeAttachment	attachVolumeToServerAsDevice(String volumeId, String serverId, String device) Deprecated. To be removed in jclouds 1.7
Volume	create(int sizeGB, CreateVolumeOptions... options) Creates a new Snapshot
VolumeSnapshot	createSnapshot(String volumeId, CreateVolumeSnapshotOptions... options) Creates a new Snapshot.
boolean	delete(String volumeId) Delete a snapshot.
boolean	deleteSnapshot(String snapshotId) Delete a snapshot.
Boolean	detachVolumeFromServer(String volumeId, String serverId) Deprecated. To be removed in jclouds 1.7
Volume	get(String volumeId) Return data about the given volume.
VolumeAttachment	getAttachmentForVolumeOnServer(String volumeId, String serverId) Deprecated. To be removed in jclouds 1.7
VolumeSnapshot	getSnapshot(String snapshotId) Return data about the given snapshot.
com.google.common.collect.FluentIterable<Volume>	list() Returns a summary list of snapshots.
com.google.common.collect.FluentIterable<VolumeAttachment>	listAttachmentsOnServer(String serverId) Deprecated. To be removed in jclouds 1.7
com.google.common.collect.FluentIterable<Volume>	listInDetail() Returns a detailed list of volumes.
com.google.common.collect.FluentIterable<VolumeSnapshot>	listSnapshots() Returns a summary list of snapshots.
com.google.common.collect.FluentIterable<VolumeSnapshot>	listSnapshotsInDetail() Returns a summary list of snapshots.

Method Detail

list

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

Returns a summary list of snapshots.

Returns:

the list of snapshots

listInDetail

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

Returns a detailed list of volumes.

Returns:

the list of volumes.

get

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

Return data about the given volume.

Returns:

details of a specific snapshot.

create

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

Creates a new Snapshot

Returns:

the new Snapshot

delete

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

Delete a snapshot.

Returns:

true if successful

listAttachmentsOnServer

@Deprecated
@Named(value="volume:listAttachments")
com.google.common.collect.FluentIterable<VolumeAttachment> listAttachmentsOnServer(String serverId)

Deprecated. To be removed in jclouds 1.7

List volume attachments for a given instance.

Returns:

all Floating IPs

See Also:

VolumeAttachmentApi.listAttachmentsOnServer(String)

getAttachmentForVolumeOnServer

@Deprecated
@Named(value="volume:getAttachments")
@Nullable
VolumeAttachment getAttachmentForVolumeOnServer(String volumeId,
                                                                          String serverId)

Deprecated. To be removed in jclouds 1.7

Get a specific attached volume.

Returns:

data about the given volume attachment.

See Also:

VolumeAttachmentApi.getAttachmentForVolumeOnServer(String, String)

attachVolumeToServerAsDevice

@Deprecated
@Named(value="volume:attach")
VolumeAttachment attachVolumeToServerAsDevice(String volumeId,
                                                               String serverId,
                                                               String device)

Deprecated. To be removed in jclouds 1.7

Attach a volume to an instance

Returns:

data about the new volume attachment

See Also:

VolumeAttachmentApi.attachVolumeToServerAsDevice(String, String, String)

detachVolumeFromServer

@Deprecated
@Named(value="volume:detach")
Boolean detachVolumeFromServer(String volumeId,
                                                String serverId)

Deprecated. To be removed in jclouds 1.7

Detach a Volume from an instance.

Returns:

true if successful

See Also:

VolumeAttachmentApi.detachVolumeFromServer(String, String)

listSnapshots

@Named(value="volume:listSnapshots")
com.google.common.collect.FluentIterable<VolumeSnapshot> listSnapshots()

Returns a summary list of snapshots.

Returns:

the list of snapshots

listSnapshotsInDetail

@Named(value="volume:listSnapshots")
com.google.common.collect.FluentIterable<VolumeSnapshot> listSnapshotsInDetail()

Returns a summary list of snapshots.

Returns:

the list of snapshots

getSnapshot

@Named(value="volume:getSnapshot")
@Nullable
VolumeSnapshot getSnapshot(String snapshotId)

Return data about the given snapshot.

Returns:

details of a specific snapshot.

createSnapshot

@Named(value="volume:createSnapshot")
VolumeSnapshot createSnapshot(String volumeId,
                                    CreateVolumeSnapshotOptions... options)

Creates a new Snapshot.

Returns:

the new Snapshot

deleteSnapshot

@Named(value="volume:deleteSnapshot")
boolean deleteSnapshot(String snapshotId)

Delete a snapshot.

Returns:

true if successful