org.openstack4j.model.storage.block

Interface Volume

All Superinterfaces:

Buildable<VolumeBuilder>, ModelEntity, Serializable

All Known Implementing Classes:

CinderVolume

public interface Volume
extends ModelEntity, Buildable<VolumeBuilder>

An OpenStack Volume

Author:

Jeremy Unruh

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Volume.MigrationStatus
static class	Volume.Status The current Volume Status

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Method Summary

Modifier and Type	Method and Description
boolean	bootable()
boolean	encrypted()
List<? extends VolumeAttachment>	getAttachments()
Date	getCreated()
String	getDescription()
String	getDisplayDescription() Deprecated.
String	getDisplayName() Deprecated.
String	getId()
String	getImageRef()
Map<String,String>	getMetaData()
Volume.MigrationStatus	getMigrateStatus()
String	getName()
int	getSize()
String	getSnapshotId()
String	getSourceVolid()
Volume.Status	getStatus()
String	getTenantId()
String	getVolumeType()
String	getZone()
String	host()
Boolean	multiattach()

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getId

String getId()

Returns:

the identifier for the volume

getName

String getName()

Returns:

the name of the volume

getDisplayName

@Deprecated
String getDisplayName()

Deprecated.

Returns:

the display name of the volume

getDescription

String getDescription()

Returns:

the description of the volume

getDisplayDescription

@Deprecated
String getDisplayDescription()

Deprecated.

Returns:

the display description of the volume

getStatus

Volume.Status getStatus()

Returns:

the status of the volume

getSize

int getSize()

Returns:

the size in GB of the volume

getZone

String getZone()

Returns:

the zone of availability to use

getCreated

Date getCreated()

Returns:

the created date of the volume

getVolumeType

String getVolumeType()

Returns:

the type of volume

getSnapshotId

String getSnapshotId()

Returns:

the snapshot identifier

getImageRef

String getImageRef()

Returns:

the image reference identifier (if an image was associated) otherwise null

multiattach

Boolean multiattach()

Returns:

To enable this volume to attach

getSourceVolid

String getSourceVolid()

Returns:

ID of source volume to clone from

getMetaData

Map<String,String> getMetaData()

Returns:

extended meta data information. key value pair of String key, String value

getAttachments

List<? extends VolumeAttachment> getAttachments()

Returns:

volume attachment data information.

getMigrateStatus

Volume.MigrationStatus getMigrateStatus()

Returns:

the status of volume migrate status, default null

getTenantId

String getTenantId()

Returns:

the tenant id

bootable

boolean bootable()

Returns:

whether the volume is bootable

encrypted

boolean encrypted()

Returns:

whether this volume is encrypted.

host

String host()

Returns:

current back-end of the volume.