com.solidfire.element.api

Class Volume

Object

Volume

All Implemented Interfaces:

Serializable

public class Volume
extends Object
implements Serializable

Volume Volumes Info is an object containing information about a volume. The return objects only include "configured" information about the volume and not runtime or usage information. Information about paired volumes will also be returned.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Volume.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Volume()
Volume(Long volumeID, String name, Long accountID, String createTime, String status, String access, Boolean enable512e, String iqn, String scsiEUIDeviceID, String scsiNAADeviceID, VolumeQOS qos, Long[] volumeAccessGroups, VolumePair[] volumePairs, Optional<String> deleteTime, Optional<String> purgeTime, Long sliceCount, Long totalSize, Long blockSize, UUID virtualVolumeID, Map<String,Object> attributes)
Volume(Long volumeID, String name, Long accountID, String createTime, String status, String access, Boolean enable512e, String iqn, String scsiEUIDeviceID, String scsiNAADeviceID, VolumeQOS qos, Long[] volumeAccessGroups, VolumePair[] volumePairs, Optional<String> deleteTime, Optional<String> purgeTime, Long sliceCount, Long totalSize, UUID virtualVolumeID, Map<String,Object> attributes)

Method Summary

Methods

Modifier and Type	Method and Description
Volume.Builder	asBuilder()
static Volume.Builder	builder()
boolean	equals(Object o)
String	getAccess() Access allowed for the volume readOnly: Only read operations are allowed.
Long	getAccountID() Unique AccountID for the account.
Map<String,Object>	getAttributes() List of Name/Value pairs in JSON object format.
Long	getBlockSize() Size of the blocks on the volume.
String	getCreateTime() UTC formatted time the volume was created.
Optional<String>	getDeleteTime() The time this volume was deleted.
Boolean	getEnable512e() If "true", the volume provides 512 byte sector emulation.
String	getIqn() Volume iSCSI Qualified Name.
String	getName() Name of the volume as provided at creation time.
Optional<String>	getPurgeTime() The time this volume will be purged from the system.
VolumeQOS	getQos() Quality of service settings for this volume.
String	getScsiEUIDeviceID() Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
String	getScsiNAADeviceID() Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
Long	getSliceCount() The number of slices backing this volume.
String	getStatus() Current status of the volume init: A volume that is being initialized and is not ready for connections.
Long	getTotalSize() Total size of this volume in bytes.
UUID	getVirtualVolumeID() Virtual volume ID this volume backs.
Long[]	getVolumeAccessGroups() List of volume access groups to which a volume belongs.
Long	getVolumeID() Unique VolumeID for the volume.
VolumePair[]	getVolumePairs() Information about a paired volume.
int	hashCode()
void	setAccess(String access)
void	setAccountID(Long accountID)
void	setAttributes(Map<String,Object> attributes)
void	setBlockSize(Long blockSize)
void	setCreateTime(String createTime)
void	setDeleteTime(Optional<String> deleteTime)
void	setEnable512e(Boolean enable512e)
void	setIqn(String iqn)
void	setName(String name)
void	setPurgeTime(Optional<String> purgeTime)
void	setQos(VolumeQOS qos)
void	setScsiEUIDeviceID(String scsiEUIDeviceID)
void	setScsiNAADeviceID(String scsiNAADeviceID)
void	setSliceCount(Long sliceCount)
void	setStatus(String status)
void	setTotalSize(Long totalSize)
void	setVirtualVolumeID(UUID virtualVolumeID)
void	setVolumeAccessGroups(Long[] volumeAccessGroups)
void	setVolumeID(Long volumeID)
void	setVolumePairs(VolumePair[] volumePairs)
Map<String,Object>	toMap()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Volume

@Since(value="7.0")
public Volume()

Volume

@Since(value="7.0")
public Volume(Long volumeID,
                 String name,
                 Long accountID,
                 String createTime,
                 String status,
                 String access,
                 Boolean enable512e,
                 String iqn,
                 String scsiEUIDeviceID,
                 String scsiNAADeviceID,
                 VolumeQOS qos,
                 Long[] volumeAccessGroups,
                 VolumePair[] volumePairs,
                 Optional<String> deleteTime,
                 Optional<String> purgeTime,
                 Long sliceCount,
                 Long totalSize,
                 UUID virtualVolumeID,
                 Map<String,Object> attributes)

Volume

@Since(value="8.0")
public Volume(Long volumeID,
                 String name,
                 Long accountID,
                 String createTime,
                 String status,
                 String access,
                 Boolean enable512e,
                 String iqn,
                 String scsiEUIDeviceID,
                 String scsiNAADeviceID,
                 VolumeQOS qos,
                 Long[] volumeAccessGroups,
                 VolumePair[] volumePairs,
                 Optional<String> deleteTime,
                 Optional<String> purgeTime,
                 Long sliceCount,
                 Long totalSize,
                 Long blockSize,
                 UUID virtualVolumeID,
                 Map<String,Object> attributes)

Method Detail

getVolumeID

public Long getVolumeID()

Unique VolumeID for the volume.

setVolumeID

public void setVolumeID(Long volumeID)

getName

public String getName()

Name of the volume as provided at creation time.

setName

public void setName(String name)

getAccountID

public Long getAccountID()

Unique AccountID for the account.

setAccountID

public void setAccountID(Long accountID)

getCreateTime

public String getCreateTime()

UTC formatted time the volume was created.

setCreateTime

public void setCreateTime(String createTime)

getStatus

public String getStatus()

Current status of the volume init: A volume that is being initialized and is not ready for connections. active: An active volume ready for connections.

setStatus

public void setStatus(String status)

getAccess

public String getAccess()

Access allowed for the volume readOnly: Only read operations are allowed. readWrite: Reads and writes are allowed. locked: No reads or writes are allowed. replicationTarget: Designated as a target volume in a replicated volume pair.

setAccess

public void setAccess(String access)

getEnable512e

public Boolean getEnable512e()

If "true", the volume provides 512 byte sector emulation.

setEnable512e

public void setEnable512e(Boolean enable512e)

getIqn

public String getIqn()

Volume iSCSI Qualified Name.

setIqn

public void setIqn(String iqn)

getScsiEUIDeviceID

public String getScsiEUIDeviceID()

Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.

setScsiEUIDeviceID

public void setScsiEUIDeviceID(String scsiEUIDeviceID)

getScsiNAADeviceID

public String getScsiNAADeviceID()

Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.

setScsiNAADeviceID

public void setScsiNAADeviceID(String scsiNAADeviceID)

getQos

public VolumeQOS getQos()

Quality of service settings for this volume.

setQos

public void setQos(VolumeQOS qos)

getVolumeAccessGroups

public Long[] getVolumeAccessGroups()

List of volume access groups to which a volume belongs.

setVolumeAccessGroups

public void setVolumeAccessGroups(Long[] volumeAccessGroups)

getVolumePairs

public VolumePair[] getVolumePairs()

Information about a paired volume. Available only if a volume is paired.

See Also:

for return values.

setVolumePairs

public void setVolumePairs(VolumePair[] volumePairs)

getDeleteTime

public Optional<String> getDeleteTime()

The time this volume was deleted. If this has no value, the volume has not yet been deleted.

setDeleteTime

public void setDeleteTime(Optional<String> deleteTime)

getPurgeTime

public Optional<String> getPurgeTime()

The time this volume will be purged from the system. If this has no value, the volume has not yet been deleted (and is not scheduled for purging).

setPurgeTime

public void setPurgeTime(Optional<String> purgeTime)

getSliceCount

public Long getSliceCount()

The number of slices backing this volume. In the current software, this value will always be 1.

setSliceCount

public void setSliceCount(Long sliceCount)

getTotalSize

public Long getTotalSize()

Total size of this volume in bytes.

setTotalSize

public void setTotalSize(Long totalSize)

getBlockSize

public Long getBlockSize()

Size of the blocks on the volume.

setBlockSize

public void setBlockSize(Long blockSize)

getVirtualVolumeID

public UUID getVirtualVolumeID()

Virtual volume ID this volume backs.

setVirtualVolumeID

public void setVirtualVolumeID(UUID virtualVolumeID)

getAttributes

public Map<String,Object> getAttributes()

List of Name/Value pairs in JSON object format.

setAttributes

public void setAttributes(Map<String,Object> attributes)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toMap

public Map<String,Object> toMap()

toString

public String toString()

Overrides:

toString in class Object

builder

public static Volume.Builder builder()

asBuilder

public final Volume.Builder asBuilder()