VolumeStats

Object
- VolumeStats

All Implemented Interfaces:

Serializable
```
public class VolumeStats
extends Object
implements Serializable
```
VolumeStats Contains statistical data for an individual volume.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VolumeStats.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`VolumeStats.Builder`

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`VolumeStats()`
VolumeStats(Long accountID, Long actualIOPS, Optional<String> asyncDelay, Long averageIOPSize, Long burstIOPSCredit, Long clientQueueDepth, MetadataHosts desiredMetadataHosts, Long latencyUSec, MetadataHosts metadataHosts, Long nonZeroBlocks, Long readBytes, Long readLatencyUSec, Long readOps, Double throttle, String timestamp, Long totalLatencyUSec, Long unalignedReads, Long unalignedWrites, Long[] volumeAccessGroups, Long volumeID, Long volumeSize, Double volumeUtilization, Long writeBytes, Long writeLatencyUSec, Long writeOps, Long zeroBlocks, Long writeBytesLastSample, Long samplePeriodMSec, Long readBytesLastSample, Long readOpsLastSample, Long writeOpsLastSample, UUID virtualVolumeID)

Method Summary

Methods
Modifier and Type	Method and Description
`VolumeStats.Builder`	`asBuilder()`
`static VolumeStats.Builder`	`builder()`
`boolean`	`equals(Object o)`
`Long`	`getAccountID()` AccountID of the volume owner.
`Long`	`getActualIOPS()` Current actual IOPS to the volume in the last 500 milliseconds.
`Optional<String>`	`getAsyncDelay()` The length of time since the volume was last synced with the remote cluster.
`Long`	`getAverageIOPSize()` Average size in bytes of recent I/O to the volume in the last 500 milliseconds.
`Long`	`getBurstIOPSCredit()` The total number of IOP credits available to the user.
`Long`	`getClientQueueDepth()` The number of outstanding read and write operations to the cluster.
`MetadataHosts`	`getDesiredMetadataHosts()` The volume services being migrated to if the volume metadata is getting migrated between volume services.
`Long`	`getLatencyUSec()` The observed latency time, in microseconds, to complete operations to a volume.
`MetadataHosts`	`getMetadataHosts()` The volume services on which the volume metadata resides.
`Long`	`getNonZeroBlocks()` The number of 4KiB blocks with data after the last garbage collection operation has completed.
`Long`	`getReadBytes()` Total bytes read by clients.
`Long`	`getReadBytesLastSample()` The total number of bytes read from the volume during the last sample period.
`Long`	`getReadLatencyUSec()` The average time, in microseconds, to complete read operations.
`Long`	`getReadOps()` Total read operations.
`Long`	`getReadOpsLastSample()` The total number of read operations durin gth elast sample period.
`Long`	`getSamplePeriodMSec()` The length of the sample period in milliseconds.
`Double`	`getThrottle()` A floating value between 0 and 1 that represents how much the system is throttling clients below their max IOPS because of re-replication of data, transient errors and snapshots taken.
`String`	`getTimestamp()` The current time in UTC.
`Long`	`getTotalLatencyUSec()` The average time, in microseconds, to complete read and write operations to a volume.
`Long`	`getUnalignedReads()` For 512e volumes, the number of read operations that were not on a 4k sector boundary.
`Long`	`getUnalignedWrites()` For 512e volumes, the number of write operations that were not on a 4k sector boundary.
`UUID`	`getVirtualVolumeID()` If the volume of interest is associated with a virtual volume, this is the virtual volume ID.
`Long[]`	`getVolumeAccessGroups()` List of volume access group(s) to which a volume belongs.
`Long`	`getVolumeID()` Volume ID of the volume.
`Long`	`getVolumeSize()` Total provisioned capacity in bytes.
`Double`	`getVolumeUtilization()` A floating value that describes how much the client is using the volume.
`Long`	`getWriteBytes()` Total bytes written by clients.
`Long`	`getWriteBytesLastSample()` The total number of bytes written to the volume during the last sample period.
`Long`	`getWriteLatencyUSec()` The average time, in microseconds, to complete write operations.
`Long`	`getWriteOps()` Total write operations occurring on the volume.
`Long`	`getWriteOpsLastSample()` The total number of write operations during the last sample period.
`Long`	`getZeroBlocks()` Total number of 4KiB blocks without data after the last round of garbage collection operation has completed.
`int`	`hashCode()`
`void`	`setAccountID(Long accountID)`
`void`	`setActualIOPS(Long actualIOPS)`
`void`	`setAsyncDelay(Optional<String> asyncDelay)`
`void`	`setAverageIOPSize(Long averageIOPSize)`
`void`	`setBurstIOPSCredit(Long burstIOPSCredit)`
`void`	`setClientQueueDepth(Long clientQueueDepth)`
`void`	`setDesiredMetadataHosts(MetadataHosts desiredMetadataHosts)`
`void`	`setLatencyUSec(Long latencyUSec)`
`void`	`setMetadataHosts(MetadataHosts metadataHosts)`
`void`	`setNonZeroBlocks(Long nonZeroBlocks)`
`void`	`setReadBytes(Long readBytes)`
`void`	`setReadBytesLastSample(Long readBytesLastSample)`
`void`	`setReadLatencyUSec(Long readLatencyUSec)`
`void`	`setReadOps(Long readOps)`
`void`	`setReadOpsLastSample(Long readOpsLastSample)`
`void`	`setSamplePeriodMSec(Long samplePeriodMSec)`
`void`	`setThrottle(Double throttle)`
`void`	`setTimestamp(String timestamp)`
`void`	`setTotalLatencyUSec(Long totalLatencyUSec)`
`void`	`setUnalignedReads(Long unalignedReads)`
`void`	`setUnalignedWrites(Long unalignedWrites)`
`void`	`setVirtualVolumeID(UUID virtualVolumeID)`
`void`	`setVolumeAccessGroups(Long[] volumeAccessGroups)`
`void`	`setVolumeID(Long volumeID)`
`void`	`setVolumeSize(Long volumeSize)`
`void`	`setVolumeUtilization(Double volumeUtilization)`
`void`	`setWriteBytes(Long writeBytes)`
`void`	`setWriteBytesLastSample(Long writeBytesLastSample)`
`void`	`setWriteLatencyUSec(Long writeLatencyUSec)`
`void`	`setWriteOps(Long writeOps)`
`void`	`setWriteOpsLastSample(Long writeOpsLastSample)`
`void`	`setZeroBlocks(Long zeroBlocks)`
`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

VolumeStats

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

VolumeStats

@Since(value="7.0")
public VolumeStats(Long accountID,
                      Long actualIOPS,
                      Optional<String> asyncDelay,
                      Long averageIOPSize,
                      Long burstIOPSCredit,
                      Long clientQueueDepth,
                      MetadataHosts desiredMetadataHosts,
                      Long latencyUSec,
                      MetadataHosts metadataHosts,
                      Long nonZeroBlocks,
                      Long readBytes,
                      Long readLatencyUSec,
                      Long readOps,
                      Double throttle,
                      String timestamp,
                      Long totalLatencyUSec,
                      Long unalignedReads,
                      Long unalignedWrites,
                      Long[] volumeAccessGroups,
                      Long volumeID,
                      Long volumeSize,
                      Double volumeUtilization,
                      Long writeBytes,
                      Long writeLatencyUSec,
                      Long writeOps,
                      Long zeroBlocks,
                      Long writeBytesLastSample,
                      Long samplePeriodMSec,
                      Long readBytesLastSample,
                      Long readOpsLastSample,
                      Long writeOpsLastSample,
                      UUID virtualVolumeID)

Method Detail
- getAccountID
```
public Long getAccountID()
```
  AccountID of the volume owner.
- setAccountID
```
public void setAccountID(Long accountID)
```
- getActualIOPS
```
public Long getActualIOPS()
```
  Current actual IOPS to the volume in the last 500 milliseconds.
- setActualIOPS
```
public void setActualIOPS(Long actualIOPS)
```
- getAsyncDelay
```
public Optional<String> getAsyncDelay()
```
  The length of time since the volume was last synced with the remote cluster. If the volume is not paired, this is null. Note: A target volume in an active replication state always has an async delay of 0 (zero). Target volumes are system-aware during replication and assume async delay is accurate at all times.
- setAsyncDelay
```
public void setAsyncDelay(Optional<String> asyncDelay)
```
- getAverageIOPSize
```
public Long getAverageIOPSize()
```
  Average size in bytes of recent I/O to the volume in the last 500 milliseconds.
- setAverageIOPSize
```
public void setAverageIOPSize(Long averageIOPSize)
```
- getBurstIOPSCredit
```
public Long getBurstIOPSCredit()
```
  The total number of IOP credits available to the user. When users are not using up to the max IOPS, credits are accrued.
- setBurstIOPSCredit
```
public void setBurstIOPSCredit(Long burstIOPSCredit)
```
- getClientQueueDepth
```
public Long getClientQueueDepth()
```
  The number of outstanding read and write operations to the cluster.
- setClientQueueDepth
```
public void setClientQueueDepth(Long clientQueueDepth)
```
- getDesiredMetadataHosts
```
public MetadataHosts getDesiredMetadataHosts()
```
  The volume services being migrated to if the volume metadata is getting migrated between volume services. A "null" value means the volume is not migrating.
- setDesiredMetadataHosts
```
public void setDesiredMetadataHosts(MetadataHosts desiredMetadataHosts)
```
- getLatencyUSec
```
public Long getLatencyUSec()
```
  The observed latency time, in microseconds, to complete operations to a volume. A "0" (zero) value means there is no I/O to the volume.
- setLatencyUSec
```
public void setLatencyUSec(Long latencyUSec)
```
- getMetadataHosts
```
public MetadataHosts getMetadataHosts()
```
  The volume services on which the volume metadata resides.
- setMetadataHosts
```
public void setMetadataHosts(MetadataHosts metadataHosts)
```
- getNonZeroBlocks
```
public Long getNonZeroBlocks()
```
  The number of 4KiB blocks with data after the last garbage collection operation has completed.
- setNonZeroBlocks
```
public void setNonZeroBlocks(Long nonZeroBlocks)
```
- getReadBytes
```
public Long getReadBytes()
```
  Total bytes read by clients.
- setReadBytes
```
public void setReadBytes(Long readBytes)
```
- getReadLatencyUSec
```
public Long getReadLatencyUSec()
```
  The average time, in microseconds, to complete read operations.
- setReadLatencyUSec
```
public void setReadLatencyUSec(Long readLatencyUSec)
```
- getReadOps
```
public Long getReadOps()
```
  Total read operations.
- setReadOps
```
public void setReadOps(Long readOps)
```
- getThrottle
```
public Double getThrottle()
```
  A floating value between 0 and 1 that represents how much the system is throttling clients below their max IOPS because of re-replication of data, transient errors and snapshots taken.
- setThrottle
```
public void setThrottle(Double throttle)
```
- getTimestamp
```
public String getTimestamp()
```
  The current time in UTC.
- setTimestamp
```
public void setTimestamp(String timestamp)
```
- getTotalLatencyUSec
```
public Long getTotalLatencyUSec()
```
  The average time, in microseconds, to complete read and write operations to a volume.
- setTotalLatencyUSec
```
public void setTotalLatencyUSec(Long totalLatencyUSec)
```
- getUnalignedReads
```
public Long getUnalignedReads()
```
  For 512e volumes, the number of read operations that were not on a 4k sector boundary. High numbers of unaligned reads may indicate improper partition alignment.
- setUnalignedReads
```
public void setUnalignedReads(Long unalignedReads)
```
- getUnalignedWrites
```
public Long getUnalignedWrites()
```
  For 512e volumes, the number of write operations that were not on a 4k sector boundary. High numbers of unaligned writes may indicate improper partition alignment.
- setUnalignedWrites
```
public void setUnalignedWrites(Long unalignedWrites)
```
- getVolumeAccessGroups
```
public Long[] getVolumeAccessGroups()
```
  List of volume access group(s) to which a volume belongs.
- setVolumeAccessGroups
```
public void setVolumeAccessGroups(Long[] volumeAccessGroups)
```
- getVolumeID
```
public Long getVolumeID()
```
  Volume ID of the volume.
- setVolumeID
```
public void setVolumeID(Long volumeID)
```
- getVolumeSize
```
public Long getVolumeSize()
```
  Total provisioned capacity in bytes.
- setVolumeSize
```
public void setVolumeSize(Long volumeSize)
```
- getVolumeUtilization
```
public Double getVolumeUtilization()
```
  A floating value that describes how much the client is using the volume. Values: 0 = Client is not using the volume 1 = Client is using their max >1 = Client is using their burst
- setVolumeUtilization
```
public void setVolumeUtilization(Double volumeUtilization)
```
- getWriteBytes
```
public Long getWriteBytes()
```
  Total bytes written by clients.
- setWriteBytes
```
public void setWriteBytes(Long writeBytes)
```
- getWriteLatencyUSec
```
public Long getWriteLatencyUSec()
```
  The average time, in microseconds, to complete write operations.
- setWriteLatencyUSec
```
public void setWriteLatencyUSec(Long writeLatencyUSec)
```
- getWriteOps
```
public Long getWriteOps()
```
  Total write operations occurring on the volume.
- setWriteOps
```
public void setWriteOps(Long writeOps)
```
- getZeroBlocks
```
public Long getZeroBlocks()
```
  Total number of 4KiB blocks without data after the last round of garbage collection operation has completed.
- setZeroBlocks
```
public void setZeroBlocks(Long zeroBlocks)
```
- getWriteBytesLastSample
```
public Long getWriteBytesLastSample()
```
  The total number of bytes written to the volume during the last sample period.
- setWriteBytesLastSample
```
public void setWriteBytesLastSample(Long writeBytesLastSample)
```
- getSamplePeriodMSec
```
public Long getSamplePeriodMSec()
```
  The length of the sample period in milliseconds.
- setSamplePeriodMSec
```
public void setSamplePeriodMSec(Long samplePeriodMSec)
```
- getReadBytesLastSample
```
public Long getReadBytesLastSample()
```
  The total number of bytes read from the volume during the last sample period.
- setReadBytesLastSample
```
public void setReadBytesLastSample(Long readBytesLastSample)
```
- getReadOpsLastSample
```
public Long getReadOpsLastSample()
```
  The total number of read operations durin gth elast sample period.
- setReadOpsLastSample
```
public void setReadOpsLastSample(Long readOpsLastSample)
```
- getWriteOpsLastSample
```
public Long getWriteOpsLastSample()
```
  The total number of write operations during the last sample period.
- setWriteOpsLastSample
```
public void setWriteOpsLastSample(Long writeOpsLastSample)
```
- getVirtualVolumeID
```
public UUID getVirtualVolumeID()
```
  If the volume of interest is associated with a virtual volume, this is the virtual volume ID.
- setVirtualVolumeID
```
public void setVirtualVolumeID(UUID virtualVolumeID)
```
- 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 VolumeStats.Builder builder()
```
- asBuilder
```
public final VolumeStats.Builder asBuilder()
```

Class VolumeStats

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

serialVersionUID

Constructor Detail

VolumeStats

VolumeStats

Method Detail

getAccountID

setAccountID

getActualIOPS

setActualIOPS

getAsyncDelay

setAsyncDelay

getAverageIOPSize

setAverageIOPSize

getBurstIOPSCredit

setBurstIOPSCredit

getClientQueueDepth

setClientQueueDepth

getDesiredMetadataHosts

setDesiredMetadataHosts

getLatencyUSec

setLatencyUSec

getMetadataHosts

setMetadataHosts

getNonZeroBlocks

setNonZeroBlocks

getReadBytes

setReadBytes

getReadLatencyUSec

setReadLatencyUSec

getReadOps

setReadOps

getThrottle

setThrottle

getTimestamp

setTimestamp

getTotalLatencyUSec

setTotalLatencyUSec

getUnalignedReads

setUnalignedReads

getUnalignedWrites

setUnalignedWrites

getVolumeAccessGroups

setVolumeAccessGroups

getVolumeID

setVolumeID

getVolumeSize

setVolumeSize

getVolumeUtilization

setVolumeUtilization

getWriteBytes

setWriteBytes

getWriteLatencyUSec

setWriteLatencyUSec

getWriteOps

setWriteOps

getZeroBlocks

setZeroBlocks

getWriteBytesLastSample

setWriteBytesLastSample

getSamplePeriodMSec

setSamplePeriodMSec

getReadBytesLastSample

setReadBytesLastSample

getReadOpsLastSample

setReadOpsLastSample

getWriteOpsLastSample

setWriteOpsLastSample

getVirtualVolumeID

setVirtualVolumeID

equals

hashCode

toMap

toString