Package org.openstack4j.openstack.storage.block.domain

Class CinderVolume

java.lang.Object

org.openstack4j.openstack.storage.block.domain.CinderVolume

All Implemented Interfaces:

Serializable, Buildable<VolumeBuilder>, ModelEntity, Volume

public class CinderVolume
extends Object
implements Volume

An OpenStack Volume

Author:

Jeremy Unruh

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CinderVolume.ConcreteVolumeBuilder
static class	CinderVolume.Volumes

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

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

Nested classes/interfaces inherited from interface org.openstack4j.model.storage.block.Volume

Volume.MigrationStatus, Volume.Status

Constructor Summary

Constructors

Constructor	Description
CinderVolume()

Method Summary

Modifier and Type	Method	Description
boolean	bootable()
static VolumeBuilder	builder()
boolean	encrypted()
List<? extends VolumeAttachment>	getAttachments()
Date	getCreated()
String	getDescription()
String	getDisplayDescription()
String	getDisplayName()
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()
VolumeBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CinderVolume

public CinderVolume()

Method Detail

builder

public static VolumeBuilder builder()

Returns:

the Volume Builder

toBuilder

public VolumeBuilder toBuilder()

Specified by:

toBuilder in interface Buildable<VolumeBuilder>

getId

public String getId()

Specified by:

getId in interface Volume

Returns:

the identifier for the volume

getName

public String getName()

Specified by:

getName in interface Volume

Returns:

the name of the volume

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Volume

Returns:

the display name of the volume

getDescription

public String getDescription()

Specified by:

getDescription in interface Volume

Returns:

the description of the volume

getDisplayDescription

public String getDisplayDescription()

Specified by:

getDisplayDescription in interface Volume

Returns:

the display description of the volume

getStatus

public Volume.Status getStatus()

Specified by:

getStatus in interface Volume

Returns:

the status of the volume

getSize

public int getSize()

Specified by:

getSize in interface Volume

Returns:

the size in GB of the volume

getZone

public String getZone()

Specified by:

getZone in interface Volume

Returns:

the zone of availability to use

getCreated

public Date getCreated()

Specified by:

getCreated in interface Volume

Returns:

the created date of the volume

getVolumeType

public String getVolumeType()

Specified by:

getVolumeType in interface Volume

Returns:

the type of volume

getSnapshotId

public String getSnapshotId()

Specified by:

getSnapshotId in interface Volume

Returns:

the snapshot identifier

getMigrateStatus

public Volume.MigrationStatus getMigrateStatus()

Specified by:

getMigrateStatus in interface Volume

Returns:

the status of volume migrate status, default null

getImageRef

public String getImageRef()

Specified by:

getImageRef in interface Volume

Returns:

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

multiattach

public Boolean multiattach()

Specified by:

multiattach in interface Volume

Returns:

To enable this volume to attach

getSourceVolid

public String getSourceVolid()

Specified by:

getSourceVolid in interface Volume

Returns:

ID of source volume to clone from

getMetaData

public Map<String,String> getMetaData()

Specified by:

getMetaData in interface Volume

Returns:

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

getAttachments

public List<? extends VolumeAttachment> getAttachments()

Specified by:

getAttachments in interface Volume

Returns:

volume attachment data information.

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface Volume

Returns:

the tenant id

bootable

public boolean bootable()

Specified by:

bootable in interface Volume

Returns:

whether the volume is bootable

encrypted

public boolean encrypted()

Specified by:

encrypted in interface Volume

Returns:

whether this volume is encrypted.

host

public String host()

Specified by:

host in interface Volume

Returns:

current back-end of the volume.

toString

public String toString()

Overrides:

toString in class Object