com.solidfire.element.api

Class VolumeStats

java.lang.Object

com.solidfire.element.api.VolumeStats

All Implemented Interfaces:

java.io.Serializable

public class VolumeStats
extends java.lang.Object
implements java.io.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

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

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

VolumeStats

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

VolumeStats

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

Method Detail

getAccountID

public java.lang.Long getAccountID()

AccountID of the volume owner.

setAccountID

public void setAccountID(java.lang.Long accountID)

getActualIOPS

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

Current actual IOPS to the volume in the last 500 milliseconds.

setActualIOPS

public void setActualIOPS(Optional<java.lang.Long> actualIOPS)

getAverageIOPSize

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

Average size in bytes of recent I/O to the volume in the last 500 milliseconds.

setAverageIOPSize

public void setAverageIOPSize(Optional<java.lang.Long> averageIOPSize)

getBurstIOPSCredit

public Optional<java.lang.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(Optional<java.lang.Long> burstIOPSCredit)

getClientQueueDepth

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

The number of outstanding read and write operations to the cluster.

setClientQueueDepth

public void setClientQueueDepth(Optional<java.lang.Long> clientQueueDepth)

getLatencyUSec

public Optional<java.lang.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(Optional<java.lang.Long> latencyUSec)

getAsyncDelay

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

setAsyncDelay

public void setAsyncDelay(Optional<java.lang.String> asyncDelay)

getMetadataHosts

public Optional<MetadataHosts> getMetadataHosts()

The volume services on which the volume metadata resides.

setMetadataHosts

public void setMetadataHosts(Optional<MetadataHosts> metadataHosts)

getDesiredMetadataHosts

public Optional<MetadataHosts> getDesiredMetadataHosts()

setDesiredMetadataHosts

public void setDesiredMetadataHosts(Optional<MetadataHosts> desiredMetadataHosts)

getNonZeroBlocks

public java.lang.Long getNonZeroBlocks()

The number of 4KiB blocks with data after the last garbage collection operation has completed.

setNonZeroBlocks

public void setNonZeroBlocks(java.lang.Long nonZeroBlocks)

getReadBytes

public java.lang.Long getReadBytes()

Total bytes read by clients.

setReadBytes

public void setReadBytes(java.lang.Long readBytes)

getReadLatencyUSec

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

The average time, in microseconds, to complete read operations.

setReadLatencyUSec

public void setReadLatencyUSec(Optional<java.lang.Long> readLatencyUSec)

getReadOps

public java.lang.Long getReadOps()

Total read operations.

setReadOps

public void setReadOps(java.lang.Long readOps)

getThrottle

public Optional<java.lang.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(Optional<java.lang.Double> throttle)

getTimestamp

public java.lang.String getTimestamp()

The current time in UTC.

setTimestamp

public void setTimestamp(java.lang.String timestamp)

getTotalLatencyUSec

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

The average time, in microseconds, to complete read and write operations to a volume.

setTotalLatencyUSec

public void setTotalLatencyUSec(Optional<java.lang.Long> totalLatencyUSec)

getUnalignedReads

public java.lang.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(java.lang.Long unalignedReads)

getUnalignedWrites

public java.lang.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(java.lang.Long unalignedWrites)

getVolumeAccessGroups

public java.lang.Long[] getVolumeAccessGroups()

List of volume access group(s) to which a volume beintegers.

setVolumeAccessGroups

public void setVolumeAccessGroups(java.lang.Long[] volumeAccessGroups)

getVolumeID

public java.lang.Long getVolumeID()

Volume ID of the volume.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getVolumeSize

public java.lang.Long getVolumeSize()

Total provisioned capacity in bytes.

setVolumeSize

public void setVolumeSize(java.lang.Long volumeSize)

getVolumeUtilization

public Optional<java.lang.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(Optional<java.lang.Double> volumeUtilization)

getWriteBytes

public java.lang.Long getWriteBytes()

Total bytes written by clients.

setWriteBytes

public void setWriteBytes(java.lang.Long writeBytes)

getWriteLatencyUSec

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

The average time, in microseconds, to complete write operations.

setWriteLatencyUSec

public void setWriteLatencyUSec(Optional<java.lang.Long> writeLatencyUSec)

getWriteOps

public java.lang.Long getWriteOps()

Total write operations occurring on the volume.

setWriteOps

public void setWriteOps(java.lang.Long writeOps)

getZeroBlocks

public java.lang.Long getZeroBlocks()

Total number of 4KiB blocks without data after the last round of garbage collection operation has completed.

setZeroBlocks

public void setZeroBlocks(java.lang.Long zeroBlocks)

getWriteBytesLastSample

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

The total number of bytes written to the volume during the last sample period.

setWriteBytesLastSample

public void setWriteBytesLastSample(Optional<java.lang.Long> writeBytesLastSample)

getSamplePeriodMSec

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

The length of the sample period in milliseconds.

setSamplePeriodMSec

public void setSamplePeriodMSec(Optional<java.lang.Long> samplePeriodMSec)

getReadBytesLastSample

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

The total number of bytes read from the volume during the last sample period.

setReadBytesLastSample

public void setReadBytesLastSample(Optional<java.lang.Long> readBytesLastSample)

getReadOpsLastSample

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

The total number of read operations durin gth elast sample period.

setReadOpsLastSample

public void setReadOpsLastSample(Optional<java.lang.Long> readOpsLastSample)

getWriteOpsLastSample

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

The total number of write operations during the last sample period.

setWriteOpsLastSample

public void setWriteOpsLastSample(Optional<java.lang.Long> writeOpsLastSample)

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 VolumeStats.Builder builder()

asBuilder

public final VolumeStats.Builder asBuilder()