Package org.apache.hadoop.hdfs.server.diskbalancer.datamodel

Class DiskBalancerVolume

java.lang.Object

org.apache.hadoop.hdfs.server.diskbalancer.datamodel.DiskBalancerVolume

public class DiskBalancerVolume
extends java.lang.Object

DiskBalancerVolume represents a volume in the DataNode.

Constructor Summary

Constructors

Constructor	Description
DiskBalancerVolume()	Constructs DiskBalancerVolume.

Method Summary

Modifier and Type	Method	Description
long	computeEffectiveCapacity()	Returns effective capacity of a volume.
float	computeUsedPercentage()	Returns the usedPercentage of a disk.
boolean	equals(java.lang.Object o)	Compares two volumes and decides if it is the same volume.
long	getCapacity()	Capacity of this volume.
double	getFreeRatio()	Get ratio between free space and capacity.
long	getFreeSpace()	Get free space of the volume.
java.lang.String	getPath()	Returns the path for this volume.
long	getReserved()	Gets the reserved size for this volume.
java.lang.String	getStorageType()	Gets the StorageType.
long	getUsed()	Gets the dfsUsed Size.
double	getUsedRatio()	Get ratio between used space and capacity.
java.lang.String	getUuid()	Gets the uuid for this volume.
double	getVolumeDataDensity()	Get this volume Data Density Please see DiskBalancerVolumeSet#computeVolumeDataDensity to see how this is computed.
int	hashCode()	Computes hash code for a diskBalancerVolume.
boolean	isFailed()	Indicates if this is a failed volume.
boolean	isReadOnly()	Tells us if this volume is read-only.
boolean	isSkip()	returns if we should skip this volume.
boolean	isTransient()	Indicates if the volume is Transient in nature.
static DiskBalancerVolume	parseJson(java.lang.String json)	Parses a Json string and converts to DiskBalancerVolume.
void	setCapacity(long totalCapacity)	Sets the capacity of this volume.
void	setFailed(boolean fail)	Sets the failed flag for this volume.
void	setIsTransient(boolean transientValue)	Tells us if a volume is transient.
void	setPath(java.lang.String volPath)	Sets the path for this volume.
void	setReadOnly(boolean readOnly)	Sets this volume as read only.
void	setReserved(long reservedSize)	Sets the reserved size.
void	setSkip(boolean skipValue)	Sets the Skip value for this volume.
void	setStorageType(java.lang.String typeOfStorage)	Sets the StorageType.
void	setTransient(boolean aTransient)	Sets volumes transient nature.
void	setUsed(long dfsUsedSpace)	Sets the used Space for Long.
void	setUuid(java.lang.String id)	Sets the uuid for this volume.
void	setVolumeDataDensity(double volDataDensity)	Sets this volume's data density.
java.lang.String	toJson()	returns a Json String.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskBalancerVolume

public DiskBalancerVolume()

Constructs DiskBalancerVolume.

Method Detail

parseJson

public static DiskBalancerVolume parseJson(java.lang.String json)
                                    throws java.io.IOException

Parses a Json string and converts to DiskBalancerVolume.

Parameters:

json - - Json String

Returns:

DiskBalancerCluster

Throws:

java.io.IOException

getVolumeDataDensity

public double getVolumeDataDensity()

Get this volume Data Density Please see DiskBalancerVolumeSet#computeVolumeDataDensity to see how this is computed.

Returns:

float.

setVolumeDataDensity

public void setVolumeDataDensity(double volDataDensity)

Sets this volume's data density.

Parameters:

volDataDensity - - density

isTransient

public boolean isTransient()

Indicates if the volume is Transient in nature.

Returns:

true or false.

setTransient

public void setTransient(boolean aTransient)

Sets volumes transient nature.

Parameters:

aTransient - - bool

equals

public boolean equals(java.lang.Object o)

Compares two volumes and decides if it is the same volume.

Overrides:

equals in class java.lang.Object

Parameters:

o - Volume Object

Returns:

boolean

hashCode

public int hashCode()

Computes hash code for a diskBalancerVolume.

Overrides:

hashCode in class java.lang.Object

Returns:

int

getCapacity

public long getCapacity()

Capacity of this volume.

Returns:

long

getFreeSpace

public long getFreeSpace()

Get free space of the volume.

Returns:

long

getUsedRatio

public double getUsedRatio()

Get ratio between used space and capacity.

Returns:

double

getFreeRatio

public double getFreeRatio()

Get ratio between free space and capacity.

Returns:

double

setCapacity

public void setCapacity(long totalCapacity)

Sets the capacity of this volume.

Parameters:

totalCapacity - long

isFailed

public boolean isFailed()

Indicates if this is a failed volume.

Returns:

boolean

setFailed

public void setFailed(boolean fail)

Sets the failed flag for this volume.

Parameters:

fail - boolean

getPath

public java.lang.String getPath()

Returns the path for this volume.

Returns:

String

setPath

public void setPath(java.lang.String volPath)

Sets the path for this volume.

Parameters:

volPath - Path

getReserved

public long getReserved()

Gets the reserved size for this volume.

Returns:

Long - Reserved size.

setReserved

public void setReserved(long reservedSize)

Sets the reserved size.

Parameters:

reservedSize - -- Sets the reserved.

getStorageType

public java.lang.String getStorageType()

Gets the StorageType.

Returns:

String StorageType.

setStorageType

public void setStorageType(java.lang.String typeOfStorage)

Sets the StorageType.

Parameters:

typeOfStorage - - Storage Type String.

getUsed

public long getUsed()

Gets the dfsUsed Size.

Returns:

- long - used space

setUsed

public void setUsed(long dfsUsedSpace)

Sets the used Space for Long.

Parameters:

dfsUsedSpace - - dfsUsedSpace for this volume.

getUuid

public java.lang.String getUuid()

Gets the uuid for this volume.

Returns:

String - uuid of th volume

setUuid

public void setUuid(java.lang.String id)

Sets the uuid for this volume.

Parameters:

id - - String

computeEffectiveCapacity

public long computeEffectiveCapacity()

Returns effective capacity of a volume.

Returns:

float - fraction that represents used capacity.

toJson

public java.lang.String toJson()
                        throws java.io.IOException

returns a Json String.

Returns:

String

Throws:

java.io.IOException

isSkip

public boolean isSkip()

returns if we should skip this volume.

Returns:

true / false

setSkip

public void setSkip(boolean skipValue)

Sets the Skip value for this volume.

Parameters:

skipValue - bool

computeUsedPercentage

public float computeUsedPercentage()

Returns the usedPercentage of a disk. This is useful in debugging disk usage

Returns:

float

setIsTransient

public void setIsTransient(boolean transientValue)

Tells us if a volume is transient.

Parameters:

transientValue -

isReadOnly

public boolean isReadOnly()

Tells us if this volume is read-only.

Returns:

true / false

setReadOnly

public void setReadOnly(boolean readOnly)

Sets this volume as read only.

Parameters:

readOnly - - boolean