com.solidfire.element.api

Class Volume

java.lang.Object

com.solidfire.element.api.Volume

All Implemented Interfaces:

java.io.Serializable

public class Volume
extends java.lang.Object
implements java.io.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(java.lang.Long volumeID, java.lang.String name, java.lang.Long accountID, java.lang.String createTime, java.util.UUID volumeConsistencyGroupUUID, java.util.UUID volumeUUID, java.lang.Boolean enableSnapMirrorReplication, java.lang.String status, java.lang.String access, java.lang.Boolean enable512e, Optional<java.lang.String> iqn, java.lang.String scsiEUIDeviceID, java.lang.String scsiNAADeviceID, VolumeQOS qos, Optional<java.lang.Long> qosPolicyID, java.lang.Long[] volumeAccessGroups, VolumePair[] volumePairs, Optional<java.lang.String> deleteTime, Optional<java.lang.String> purgeTime, Optional<java.lang.String> lastAccessTime, Optional<java.lang.String> lastAccessTimeIO, java.lang.Long sliceCount, java.lang.Long totalSize, java.lang.Long blockSize, Optional<java.util.UUID> virtualVolumeID, Attributes attributes, java.lang.String currentProtectionScheme, Optional<java.lang.String> previousProtectionScheme)
Volume(java.lang.Long volumeID, java.lang.String name, java.lang.Long accountID, java.lang.String createTime, java.util.UUID volumeConsistencyGroupUUID, java.util.UUID volumeUUID, java.lang.Boolean enableSnapMirrorReplication, java.lang.String status, java.lang.String access, java.lang.Boolean enable512e, Optional<java.lang.String> iqn, java.lang.String scsiEUIDeviceID, java.lang.String scsiNAADeviceID, VolumeQOS qos, Optional<java.lang.Long> qosPolicyID, java.lang.Long[] volumeAccessGroups, VolumePair[] volumePairs, Optional<java.lang.String> deleteTime, Optional<java.lang.String> purgeTime, Optional<java.lang.String> lastAccessTime, Optional<java.lang.String> lastAccessTimeIO, java.lang.Long sliceCount, java.lang.Long totalSize, java.lang.Long blockSize, Optional<java.util.UUID> virtualVolumeID, Attributes attributes, java.lang.String currentProtectionScheme, Optional<java.lang.String> previousProtectionScheme, Optional<java.lang.Long> fifoSize, Optional<java.lang.Long> minFifoSize)

Method Summary

Modifier and Type	Method and Description
Volume.Builder	asBuilder()
static Volume.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.String	getAccess() Access allowed for the volume
java.lang.Long	getAccountID() Unique AccountID for the account.
Attributes	getAttributes() List of Name/Value pairs in JSON object format.
java.lang.Long	getBlockSize() Size of the blocks on the volume.
java.lang.String	getCreateTime() UTC formatted time the volume was created.
java.lang.String	getCurrentProtectionScheme() Protection scheme that is being used for this volume If a volume is converting from one protection scheme to another, this field will be set to the protection scheme that the volume is converting to.
Optional<java.lang.String>	getDeleteTime() The time this volume was deleted.
java.lang.Boolean	getEnable512e() If "true", the volume provides 512 byte sector emulation.
java.lang.Boolean	getEnableSnapMirrorReplication()
Optional<java.lang.Long>	getFifoSize() Specify the maximum number of snapshots of the volume to be maintained at a time if using first in first out snapshot retention mode.
Optional<java.lang.String>	getIqn() Volume iSCSI Qualified Name.
Optional<java.lang.String>	getLastAccessTime() The last time any access to this volume occurred.
Optional<java.lang.String>	getLastAccessTimeIO() The last time I/O access to this volume occurred.
Optional<java.lang.Long>	getMinFifoSize() Specify the number of snapshots of the volume to be maintained at a time if using first in first out snapshot retention mode.
java.lang.String	getName() Name of the volume as provided at creation time.
Optional<java.lang.String>	getPreviousProtectionScheme() If a volume is converting from one protection scheme to another, this field will be set to the protection scheme the volume is converting from.
Optional<java.lang.String>	getPurgeTime() The time this volume will be purged from the system.
VolumeQOS	getQos() Quality of service settings for this volume.
Optional<java.lang.Long>	getQosPolicyID() The QoS policy ID associated with the volume.
java.lang.String	getScsiEUIDeviceID() Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
java.lang.String	getScsiNAADeviceID() Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
java.lang.Long	getSliceCount() The number of slices backing this volume.
java.lang.String	getStatus() Current status of the volume init: A volume that is being initialized and is not ready for connections.
java.lang.Long	getTotalSize() Total size of this volume in bytes.
Optional<java.util.UUID>	getVirtualVolumeID() Virtual volume ID this volume backs.
java.lang.Long[]	getVolumeAccessGroups() List of volume access groups to which a volume beintegers.
java.util.UUID	getVolumeConsistencyGroupUUID()
java.lang.Long	getVolumeID() Unique VolumeID for the volume.
VolumePair[]	getVolumePairs() Information about a paired volume.
java.util.UUID	getVolumeUUID()
int	hashCode()
void	setAccess(java.lang.String access)
void	setAccountID(java.lang.Long accountID)
void	setAttributes(Attributes attributes)
void	setBlockSize(java.lang.Long blockSize)
void	setCreateTime(java.lang.String createTime)
void	setCurrentProtectionScheme(java.lang.String currentProtectionScheme)
void	setDeleteTime(Optional<java.lang.String> deleteTime)
void	setEnable512e(java.lang.Boolean enable512e)
void	setEnableSnapMirrorReplication(java.lang.Boolean enableSnapMirrorReplication)
void	setFifoSize(Optional<java.lang.Long> fifoSize)
void	setIqn(Optional<java.lang.String> iqn)
void	setLastAccessTime(Optional<java.lang.String> lastAccessTime)
void	setLastAccessTimeIO(Optional<java.lang.String> lastAccessTimeIO)
void	setMinFifoSize(Optional<java.lang.Long> minFifoSize)
void	setName(java.lang.String name)
void	setPreviousProtectionScheme(Optional<java.lang.String> previousProtectionScheme)
void	setPurgeTime(Optional<java.lang.String> purgeTime)
void	setQos(VolumeQOS qos)
void	setQosPolicyID(Optional<java.lang.Long> qosPolicyID)
void	setScsiEUIDeviceID(java.lang.String scsiEUIDeviceID)
void	setScsiNAADeviceID(java.lang.String scsiNAADeviceID)
void	setSliceCount(java.lang.Long sliceCount)
void	setStatus(java.lang.String status)
void	setTotalSize(java.lang.Long totalSize)
void	setVirtualVolumeID(Optional<java.util.UUID> virtualVolumeID)
void	setVolumeAccessGroups(java.lang.Long[] volumeAccessGroups)
void	setVolumeConsistencyGroupUUID(java.util.UUID volumeConsistencyGroupUUID)
void	setVolumeID(java.lang.Long volumeID)
void	setVolumePairs(VolumePair[] volumePairs)
void	setVolumeUUID(java.util.UUID volumeUUID)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.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(java.lang.Long volumeID,
                                  java.lang.String name,
                                  java.lang.Long accountID,
                                  java.lang.String createTime,
                                  java.util.UUID volumeConsistencyGroupUUID,
                                  java.util.UUID volumeUUID,
                                  java.lang.Boolean enableSnapMirrorReplication,
                                  java.lang.String status,
                                  java.lang.String access,
                                  java.lang.Boolean enable512e,
                                  Optional<java.lang.String> iqn,
                                  java.lang.String scsiEUIDeviceID,
                                  java.lang.String scsiNAADeviceID,
                                  VolumeQOS qos,
                                  Optional<java.lang.Long> qosPolicyID,
                                  java.lang.Long[] volumeAccessGroups,
                                  VolumePair[] volumePairs,
                                  Optional<java.lang.String> deleteTime,
                                  Optional<java.lang.String> purgeTime,
                                  Optional<java.lang.String> lastAccessTime,
                                  Optional<java.lang.String> lastAccessTimeIO,
                                  java.lang.Long sliceCount,
                                  java.lang.Long totalSize,
                                  java.lang.Long blockSize,
                                  Optional<java.util.UUID> virtualVolumeID,
                                  Attributes attributes,
                                  java.lang.String currentProtectionScheme,
                                  Optional<java.lang.String> previousProtectionScheme)

Volume

@Since(value="12.0")
public Volume(java.lang.Long volumeID,
                                   java.lang.String name,
                                   java.lang.Long accountID,
                                   java.lang.String createTime,
                                   java.util.UUID volumeConsistencyGroupUUID,
                                   java.util.UUID volumeUUID,
                                   java.lang.Boolean enableSnapMirrorReplication,
                                   java.lang.String status,
                                   java.lang.String access,
                                   java.lang.Boolean enable512e,
                                   Optional<java.lang.String> iqn,
                                   java.lang.String scsiEUIDeviceID,
                                   java.lang.String scsiNAADeviceID,
                                   VolumeQOS qos,
                                   Optional<java.lang.Long> qosPolicyID,
                                   java.lang.Long[] volumeAccessGroups,
                                   VolumePair[] volumePairs,
                                   Optional<java.lang.String> deleteTime,
                                   Optional<java.lang.String> purgeTime,
                                   Optional<java.lang.String> lastAccessTime,
                                   Optional<java.lang.String> lastAccessTimeIO,
                                   java.lang.Long sliceCount,
                                   java.lang.Long totalSize,
                                   java.lang.Long blockSize,
                                   Optional<java.util.UUID> virtualVolumeID,
                                   Attributes attributes,
                                   java.lang.String currentProtectionScheme,
                                   Optional<java.lang.String> previousProtectionScheme,
                                   Optional<java.lang.Long> fifoSize,
                                   Optional<java.lang.Long> minFifoSize)

Method Detail

getVolumeID

public java.lang.Long getVolumeID()

Unique VolumeID for the volume.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getName

public java.lang.String getName()

Name of the volume as provided at creation time.

setName

public void setName(java.lang.String name)

getAccountID

public java.lang.Long getAccountID()

Unique AccountID for the account.

setAccountID

public void setAccountID(java.lang.Long accountID)

getCreateTime

public java.lang.String getCreateTime()

UTC formatted time the volume was created.

setCreateTime

public void setCreateTime(java.lang.String createTime)

getVolumeConsistencyGroupUUID

public java.util.UUID getVolumeConsistencyGroupUUID()

setVolumeConsistencyGroupUUID

public void setVolumeConsistencyGroupUUID(java.util.UUID volumeConsistencyGroupUUID)

getVolumeUUID

public java.util.UUID getVolumeUUID()

setVolumeUUID

public void setVolumeUUID(java.util.UUID volumeUUID)

getEnableSnapMirrorReplication

public java.lang.Boolean getEnableSnapMirrorReplication()

setEnableSnapMirrorReplication

public void setEnableSnapMirrorReplication(java.lang.Boolean enableSnapMirrorReplication)

getStatus

public java.lang.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(java.lang.String status)

getAccess

public java.lang.String getAccess()

Access allowed for the volume

setAccess

public void setAccess(java.lang.String access)

getEnable512e

public java.lang.Boolean getEnable512e()

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

setEnable512e

public void setEnable512e(java.lang.Boolean enable512e)

getIqn

public Optional<java.lang.String> getIqn()

Volume iSCSI Qualified Name.

setIqn

public void setIqn(Optional<java.lang.String> iqn)

getScsiEUIDeviceID

public java.lang.String getScsiEUIDeviceID()

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

setScsiEUIDeviceID

public void setScsiEUIDeviceID(java.lang.String scsiEUIDeviceID)

getScsiNAADeviceID

public java.lang.String getScsiNAADeviceID()

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

setScsiNAADeviceID

public void setScsiNAADeviceID(java.lang.String scsiNAADeviceID)

getQos

public VolumeQOS getQos()

Quality of service settings for this volume.

setQos

public void setQos(VolumeQOS qos)

getQosPolicyID

public Optional<java.lang.Long> getQosPolicyID()

The QoS policy ID associated with the volume. The value is null if the volume is not associated with a policy.

setQosPolicyID

public void setQosPolicyID(Optional<java.lang.Long> qosPolicyID)

getVolumeAccessGroups

public java.lang.Long[] getVolumeAccessGroups()

List of volume access groups to which a volume beintegers.

setVolumeAccessGroups

public void setVolumeAccessGroups(java.lang.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<java.lang.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<java.lang.String> deleteTime)

getPurgeTime

public Optional<java.lang.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<java.lang.String> purgeTime)

getLastAccessTime

public Optional<java.lang.String> getLastAccessTime()

The last time any access to this volume occurred. If this has no value, the last access time is not known.

setLastAccessTime

public void setLastAccessTime(Optional<java.lang.String> lastAccessTime)

getLastAccessTimeIO

public Optional<java.lang.String> getLastAccessTimeIO()

The last time I/O access to this volume occurred. If this has no value, the last I/O access time is not known.

setLastAccessTimeIO

public void setLastAccessTimeIO(Optional<java.lang.String> lastAccessTimeIO)

getSliceCount

public java.lang.Long getSliceCount()

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

setSliceCount

public void setSliceCount(java.lang.Long sliceCount)

getTotalSize

public java.lang.Long getTotalSize()

Total size of this volume in bytes.

setTotalSize

public void setTotalSize(java.lang.Long totalSize)

getBlockSize

public java.lang.Long getBlockSize()

Size of the blocks on the volume.

setBlockSize

public void setBlockSize(java.lang.Long blockSize)

getVirtualVolumeID

public Optional<java.util.UUID> getVirtualVolumeID()

Virtual volume ID this volume backs.

setVirtualVolumeID

public void setVirtualVolumeID(Optional<java.util.UUID> virtualVolumeID)

getAttributes

public Attributes getAttributes()

List of Name/Value pairs in JSON object format.

setAttributes

public void setAttributes(Attributes attributes)

getCurrentProtectionScheme

public java.lang.String getCurrentProtectionScheme()

Protection scheme that is being used for this volume If a volume is converting from one protection scheme to another, this field will be set to the protection scheme that the volume is converting to.

setCurrentProtectionScheme

public void setCurrentProtectionScheme(java.lang.String currentProtectionScheme)

getPreviousProtectionScheme

public Optional<java.lang.String> getPreviousProtectionScheme()

If a volume is converting from one protection scheme to another, this field will be set to the protection scheme the volume is converting from. This field will not change until another conversion is started. If a volume has never been converted, this field will be null.

setPreviousProtectionScheme

public void setPreviousProtectionScheme(Optional<java.lang.String> previousProtectionScheme)

getFifoSize

public Optional<java.lang.Long> getFifoSize()

Specify the maximum number of snapshots of the volume to be maintained at a time if using first in first out snapshot retention mode. If unspecified a default value will be used.

setFifoSize

public void setFifoSize(Optional<java.lang.Long> fifoSize)

getMinFifoSize

public Optional<java.lang.Long> getMinFifoSize()

Specify the number of snapshots of the volume to be maintained at a time if using first in first out snapshot retention mode. If unspecified a default value will be used.

setMinFifoSize

public void setMinFifoSize(Optional<java.lang.Long> minFifoSize)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static Volume.Builder builder()

asBuilder

public final Volume.Builder asBuilder()