org.jclouds.cloudstack.features

Interface VolumeClient

public interface VolumeClient

Provides synchronous access to CloudStack Event features.

Author:

Vijay Kiran

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
AsyncCreateResponse	attachVolume(String volumeId, String virtualMachineId) Attaches a disk volume to a virtual machine.
AsyncCreateResponse	createVolumeFromCustomDiskOfferingInZone(String name, String diskOfferingId, String zoneId, int size) Create a volume with given name, size and diskOfferingId
AsyncCreateResponse	createVolumeFromDiskOfferingInZone(String name, String diskOfferingId, String zoneId) Create a volume with given name and diskOfferingId
AsyncCreateResponse	createVolumeFromSnapshotInZone(String name, String snapshotId, String zoneId) Create a volume with given name and snapshotId
void	deleteVolume(String id) Deletes a attached disk volume
AsyncCreateResponse	detachVolume(String volumeId) Detaches a disk volume to a virtual machine.
Volume	getVolume(String id) Get volume by id
Set<Volume>	listVolumes(ListVolumesOptions... options) List volumes

Method Detail

createVolumeFromDiskOfferingInZone

AsyncCreateResponse createVolumeFromDiskOfferingInZone(String name,
                                                     String diskOfferingId,
                                                     String zoneId)

Create a volume with given name and diskOfferingId

Parameters:

name - name of the volume

diskOfferingId - the ID of the disk offering.

zoneId - the ID of the availability zone

Returns:

AsyncCreateResponse job response used to track creation

createVolumeFromCustomDiskOfferingInZone

AsyncCreateResponse createVolumeFromCustomDiskOfferingInZone(String name,
                                                           String diskOfferingId,
                                                           String zoneId,
                                                           int size)

Create a volume with given name, size and diskOfferingId

Parameters:

name - name of the volume

diskOfferingId - the ID of the disk offering (the offering should have the custom disk size flag set)

zoneId - the ID of the availability zone

size - the size of volume required (in GB)

Returns:

AsyncCreateResponse job response used to track creation

createVolumeFromSnapshotInZone

AsyncCreateResponse createVolumeFromSnapshotInZone(String name,
                                                 String snapshotId,
                                                 String zoneId)

Create a volume with given name and snapshotId

Parameters:

name - name of the volume

snapshotId - Snapshot id to be used while creating the volume

zoneId - the ID of the availability zone

Returns:

AsyncCreateResponse job response used to track creation

listVolumes

Set<Volume> listVolumes(ListVolumesOptions... options)

List volumes

Returns:

volume list, empty if not found

getVolume

Volume getVolume(String id)

Get volume by id

Parameters:

id - the volume id to retrieve

Returns:

volume or null if not found

deleteVolume

void deleteVolume(String id)

Deletes a attached disk volume

Parameters:

id - id of the volume

attachVolume

AsyncCreateResponse attachVolume(String volumeId,
                               String virtualMachineId)

Attaches a disk volume to a virtual machine.

Parameters:

volumeId - the ID of the disk volume

virtualMachineId - the ID of the virtual machine

Returns:

AsyncCreateResponse job response used to track creation

detachVolume

AsyncCreateResponse detachVolume(String volumeId)

Detaches a disk volume to a virtual machine.

Parameters:

volumeId - the ID of the disk volume

Returns:

AsyncCreateResponse job response used to track creation