com.solidfire.element.api

Class Drive

java.lang.Object

com.solidfire.element.api.Drive

All Implemented Interfaces:

java.io.Serializable

public class Drive
extends java.lang.Object
implements java.io.Serializable

Drive

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Drive.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Drive()
Drive(java.lang.Long driveID, java.lang.Long nodeID, Optional<java.lang.Long> assignedService, java.lang.Long[] asyncResultIDs, java.lang.Long capacity, java.lang.Long usableCapacity, java.lang.Long segmentFileSize, java.lang.String serial, Optional<java.lang.Long> slot, java.lang.String driveStatus, Optional<java.lang.String> driveFailureDetail, Optional<java.lang.String> driveSecurityFaultReason, Optional<java.lang.Long> keyProviderID, Optional<java.util.UUID> keyID, java.lang.String driveType, Optional<java.lang.Long> reservedSliceFileCapacity, Optional<java.lang.Long> customerSliceFileCapacity, Optional<java.lang.Boolean> smartSsdWriteCapable, Attributes attributes)
Drive(java.lang.Long driveID, java.lang.Long nodeID, Optional<java.lang.Long> assignedService, java.lang.Long[] asyncResultIDs, java.lang.Long capacity, java.lang.Long usableCapacity, java.lang.Long segmentFileSize, java.lang.String serial, Optional<java.lang.Long> slot, java.lang.String driveStatus, Optional<java.lang.String> driveFailureDetail, Optional<java.lang.String> driveSecurityFaultReason, Optional<java.lang.Long> keyProviderID, Optional<java.util.UUID> keyID, java.lang.String driveType, Optional<java.lang.Long> reservedSliceFileCapacity, Optional<java.lang.Long> customerSliceFileCapacity, Optional<java.lang.Boolean> smartSsdWriteCapable, Optional<java.lang.Boolean> skipLabel, Attributes attributes)
Drive(java.lang.Long driveID, java.lang.Long nodeID, Optional<java.lang.Long> assignedService, java.lang.Long[] asyncResultIDs, java.lang.Long capacity, java.lang.String serial, Optional<java.lang.Long> slot, java.lang.String driveStatus, Optional<java.lang.String> driveFailureDetail, Optional<java.lang.String> driveSecurityFaultReason, Optional<java.lang.Long> keyProviderID, Optional<java.util.UUID> keyID, java.lang.String driveType, Optional<java.lang.Long> reservedSliceFileCapacity, Optional<java.lang.Long> customerSliceFileCapacity, Optional<java.lang.Boolean> smartSsdWriteCapable, Attributes attributes)

Method Summary

Modifier and Type	Method and Description
Drive.Builder	asBuilder()
static Drive.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.Long>	getAssignedService() If this drive is hosting a service, the identifier for that service.
java.lang.Long[]	getAsyncResultIDs() The list of asynchronous jobs currently running on the drive (for example: a secure erase job).
Attributes	getAttributes() List of Name/Value pairs in JSON object format.
java.lang.Long	getCapacity() Total Raw capacity of the drive, in bytes.
Optional<java.lang.Long>	getCustomerSliceFileCapacity()
Optional<java.lang.String>	getDriveFailureDetail() If a drive's status is 'Failed', this field provides more detail on why the drive was marked failed.
java.lang.Long	getDriveID() A unique identifier for this drive.
Optional<java.lang.String>	getDriveSecurityFaultReason() If enabling or disabling drive security failed, this is the reason why it failed.
java.lang.String	getDriveStatus() The current status of this drive.
java.lang.String	getDriveType() The type of this drive.
Optional<java.util.UUID>	getKeyID() The keyID used by the key provider to acquire the authentication key for unlocking this drive.
Optional<java.lang.Long>	getKeyProviderID() Identifies the provider of the authentication key for unlocking this drive.
java.lang.Long	getNodeID() The node this drive is located.
Optional<java.lang.Long>	getReservedSliceFileCapacity()
java.lang.Long	getSegmentFileSize() Segment File Size of the drive, in bytes.
java.lang.String	getSerial() The manufacturer's serial number for this drive.
Optional<java.lang.Boolean>	getSkipLabel() Whether or not Element software will avoid writing to LBA 0 of this drive.
Optional<java.lang.Long>	getSlot() Slot number in the server chassis where this drive is located.
Optional<java.lang.Boolean>	getSmartSsdWriteCapable()
java.lang.Long	getUsableCapacity() Total Usable capacity of the drive, in bytes.
int	hashCode()
void	setAssignedService(Optional<java.lang.Long> assignedService)
void	setAsyncResultIDs(java.lang.Long[] asyncResultIDs)
void	setAttributes(Attributes attributes)
void	setCapacity(java.lang.Long capacity)
void	setCustomerSliceFileCapacity(Optional<java.lang.Long> customerSliceFileCapacity)
void	setDriveFailureDetail(Optional<java.lang.String> driveFailureDetail)
void	setDriveID(java.lang.Long driveID)
void	setDriveSecurityFaultReason(Optional<java.lang.String> driveSecurityFaultReason)
void	setDriveStatus(java.lang.String driveStatus)
void	setDriveType(java.lang.String driveType)
void	setKeyID(Optional<java.util.UUID> keyID)
void	setKeyProviderID(Optional<java.lang.Long> keyProviderID)
void	setNodeID(java.lang.Long nodeID)
void	setReservedSliceFileCapacity(Optional<java.lang.Long> reservedSliceFileCapacity)
void	setSegmentFileSize(java.lang.Long segmentFileSize)
void	setSerial(java.lang.String serial)
void	setSkipLabel(Optional<java.lang.Boolean> skipLabel)
void	setSlot(Optional<java.lang.Long> slot)
void	setSmartSsdWriteCapable(Optional<java.lang.Boolean> smartSsdWriteCapable)
void	setUsableCapacity(java.lang.Long usableCapacity)
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

Drive

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

Drive

@Since(value="7.0")
public Drive(java.lang.Long driveID,
                                 java.lang.Long nodeID,
                                 Optional<java.lang.Long> assignedService,
                                 java.lang.Long[] asyncResultIDs,
                                 java.lang.Long capacity,
                                 java.lang.String serial,
                                 Optional<java.lang.Long> slot,
                                 java.lang.String driveStatus,
                                 Optional<java.lang.String> driveFailureDetail,
                                 Optional<java.lang.String> driveSecurityFaultReason,
                                 Optional<java.lang.Long> keyProviderID,
                                 Optional<java.util.UUID> keyID,
                                 java.lang.String driveType,
                                 Optional<java.lang.Long> reservedSliceFileCapacity,
                                 Optional<java.lang.Long> customerSliceFileCapacity,
                                 Optional<java.lang.Boolean> smartSsdWriteCapable,
                                 Attributes attributes)

Drive

@Since(value="11.0")
public Drive(java.lang.Long driveID,
                                  java.lang.Long nodeID,
                                  Optional<java.lang.Long> assignedService,
                                  java.lang.Long[] asyncResultIDs,
                                  java.lang.Long capacity,
                                  java.lang.Long usableCapacity,
                                  java.lang.Long segmentFileSize,
                                  java.lang.String serial,
                                  Optional<java.lang.Long> slot,
                                  java.lang.String driveStatus,
                                  Optional<java.lang.String> driveFailureDetail,
                                  Optional<java.lang.String> driveSecurityFaultReason,
                                  Optional<java.lang.Long> keyProviderID,
                                  Optional<java.util.UUID> keyID,
                                  java.lang.String driveType,
                                  Optional<java.lang.Long> reservedSliceFileCapacity,
                                  Optional<java.lang.Long> customerSliceFileCapacity,
                                  Optional<java.lang.Boolean> smartSsdWriteCapable,
                                  Attributes attributes)

Drive

@Since(value="12.0")
public Drive(java.lang.Long driveID,
                                  java.lang.Long nodeID,
                                  Optional<java.lang.Long> assignedService,
                                  java.lang.Long[] asyncResultIDs,
                                  java.lang.Long capacity,
                                  java.lang.Long usableCapacity,
                                  java.lang.Long segmentFileSize,
                                  java.lang.String serial,
                                  Optional<java.lang.Long> slot,
                                  java.lang.String driveStatus,
                                  Optional<java.lang.String> driveFailureDetail,
                                  Optional<java.lang.String> driveSecurityFaultReason,
                                  Optional<java.lang.Long> keyProviderID,
                                  Optional<java.util.UUID> keyID,
                                  java.lang.String driveType,
                                  Optional<java.lang.Long> reservedSliceFileCapacity,
                                  Optional<java.lang.Long> customerSliceFileCapacity,
                                  Optional<java.lang.Boolean> smartSsdWriteCapable,
                                  Optional<java.lang.Boolean> skipLabel,
                                  Attributes attributes)

Method Detail

getDriveID

public java.lang.Long getDriveID()

A unique identifier for this drive.

setDriveID

public void setDriveID(java.lang.Long driveID)

getNodeID

public java.lang.Long getNodeID()

The node this drive is located. If the drive has been physically removed from the node, this is where it was last seen.

setNodeID

public void setNodeID(java.lang.Long nodeID)

getAssignedService

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

If this drive is hosting a service, the identifier for that service.

setAssignedService

public void setAssignedService(Optional<java.lang.Long> assignedService)

getAsyncResultIDs

public java.lang.Long[] getAsyncResultIDs()

The list of asynchronous jobs currently running on the drive (for example: a secure erase job).

setAsyncResultIDs

public void setAsyncResultIDs(java.lang.Long[] asyncResultIDs)

getCapacity

public java.lang.Long getCapacity()

Total Raw capacity of the drive, in bytes.

setCapacity

public void setCapacity(java.lang.Long capacity)

getUsableCapacity

public java.lang.Long getUsableCapacity()

Total Usable capacity of the drive, in bytes.

setUsableCapacity

public void setUsableCapacity(java.lang.Long usableCapacity)

getSegmentFileSize

public java.lang.Long getSegmentFileSize()

Segment File Size of the drive, in bytes.

setSegmentFileSize

public void setSegmentFileSize(java.lang.Long segmentFileSize)

getSerial

public java.lang.String getSerial()

The manufacturer's serial number for this drive.

setSerial

public void setSerial(java.lang.String serial)

getSlot

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

Slot number in the server chassis where this drive is located. If the drive has been physically removed from the node, this will not have a value.

setSlot

public void setSlot(Optional<java.lang.Long> slot)

getDriveStatus

public java.lang.String getDriveStatus()

The current status of this drive.

setDriveStatus

public void setDriveStatus(java.lang.String driveStatus)

getDriveFailureDetail

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

If a drive's status is 'Failed', this field provides more detail on why the drive was marked failed.

setDriveFailureDetail

public void setDriveFailureDetail(Optional<java.lang.String> driveFailureDetail)

getDriveSecurityFaultReason

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

If enabling or disabling drive security failed, this is the reason why it failed. If the value is 'none', there was no failure.

setDriveSecurityFaultReason

public void setDriveSecurityFaultReason(Optional<java.lang.String> driveSecurityFaultReason)

getKeyProviderID

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

Identifies the provider of the authentication key for unlocking this drive.

setKeyProviderID

public void setKeyProviderID(Optional<java.lang.Long> keyProviderID)

getKeyID

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

The keyID used by the key provider to acquire the authentication key for unlocking this drive.

setKeyID

public void setKeyID(Optional<java.util.UUID> keyID)

getDriveType

public java.lang.String getDriveType()

The type of this drive.

setDriveType

public void setDriveType(java.lang.String driveType)

getReservedSliceFileCapacity

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

setReservedSliceFileCapacity

public void setReservedSliceFileCapacity(Optional<java.lang.Long> reservedSliceFileCapacity)

getCustomerSliceFileCapacity

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

setCustomerSliceFileCapacity

public void setCustomerSliceFileCapacity(Optional<java.lang.Long> customerSliceFileCapacity)

getSmartSsdWriteCapable

public Optional<java.lang.Boolean> getSmartSsdWriteCapable()

setSmartSsdWriteCapable

public void setSmartSsdWriteCapable(Optional<java.lang.Boolean> smartSsdWriteCapable)

getSkipLabel

public Optional<java.lang.Boolean> getSkipLabel()

Whether or not Element software will avoid writing to LBA 0 of this drive.

setSkipLabel

public void setSkipLabel(Optional<java.lang.Boolean> skipLabel)

getAttributes

public Attributes getAttributes()

List of Name/Value pairs in JSON object format.

setAttributes

public void setAttributes(Attributes attributes)

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

asBuilder

public final Drive.Builder asBuilder()