VolumeApi (jclouds 1.5.0 API)

```
@Beta
public interface VolumeApi
```
Provides synchronous access to Volumes.

Author:

Adam Lowe

See Also:
VolumeAsyncApi, VolumeAsyncApi

Method Summary

Methods
Modifier and Type	Method and Description
`VolumeAttachment`	`attachVolumeToServerAsDevice(String volumeId, String serverId, String device)` Attach a volume to an instance
`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 server_id, String volumeId)` Detach a Volume from an instance.
`Volume`	`get(String volumeId)` Return data about the given volume.
`VolumeAttachment`	`getAttachmentForVolumeOnServer(String volumeId, String serverId)` Get a specific attached volume.
`VolumeSnapshot`	`getSnapshot(String snapshotId)` Return data about the given snapshot.
`com.google.common.collect.FluentIterable<? extends Volume>`	`list()` Returns a summary list of snapshots.
`com.google.common.collect.FluentIterable<? extends VolumeAttachment>`	`listAttachmentsOnServer(String serverId)` List volume attachments for a given instance.
`com.google.common.collect.FluentIterable<? extends Volume>`	`listInDetail()` Returns a detailed list of volumes.
`com.google.common.collect.FluentIterable<? extends VolumeSnapshot>`	`listSnapshots()` Returns a summary list of snapshots.
`com.google.common.collect.FluentIterable<? extends VolumeSnapshot>`	`listSnapshotsInDetail()` Returns a summary list of snapshots.

Method Detail

list
```
com.google.common.collect.FluentIterable<? extends Volume> list()
```
Returns a summary list of snapshots.

Returns:
the list of snapshots

listInDetail

com.google.common.collect.FluentIterable<? extends Volume> listInDetail()

Returns a detailed list of volumes.

Returns:: the list of volumes.

get
```
Volume get(String volumeId)
```
Return data about the given volume.

Returns:
details of a specific snapshot.

create

Volume create(int sizeGB,
            CreateVolumeOptions... options)

Creates a new Snapshot

Returns:: the new Snapshot

delete
```
boolean delete(String volumeId)
```
Delete a snapshot.

Returns:
true if successful

listAttachmentsOnServer

com.google.common.collect.FluentIterable<? extends VolumeAttachment> listAttachmentsOnServer(String serverId)

List volume attachments for a given instance.

Returns:: all Floating IPs

getAttachmentForVolumeOnServer

VolumeAttachment getAttachmentForVolumeOnServer(String volumeId,
                                              String serverId)

Get a specific attached volume.

Returns:: data about the given volume attachment.

attachVolumeToServerAsDevice

VolumeAttachment attachVolumeToServerAsDevice(String volumeId,
                                            String serverId,
                                            String device)

Attach a volume to an instance

Returns:: data about the new volume attachment

detachVolumeFromServer

Boolean detachVolumeFromServer(String server_id,
                             String volumeId)

Detach a Volume from an instance.

Returns:: true if successful

listSnapshots

com.google.common.collect.FluentIterable<? extends VolumeSnapshot> listSnapshots()

Returns a summary list of snapshots.

Returns:: the list of snapshots

listSnapshotsInDetail

com.google.common.collect.FluentIterable<? extends VolumeSnapshot> listSnapshotsInDetail()

Returns a summary list of snapshots.

Returns:: the list of snapshots

getSnapshot
```
VolumeSnapshot getSnapshot(String snapshotId)
```
Return data about the given snapshot.

Returns:
details of a specific snapshot.

createSnapshot

VolumeSnapshot createSnapshot(String volumeId,
                            CreateVolumeSnapshotOptions... options)