DatanodeInfo (Apache Hadoop HDFS Client 3.4.1.100-eep-941 API)

java.lang.Object
- org.apache.hadoop.hdfs.protocol.DatanodeID
- - org.apache.hadoop.hdfs.protocol.DatanodeInfo

All Implemented Interfaces:

java.lang.Comparable<DatanodeID>, org.apache.hadoop.net.Node

Direct Known Subclasses:

DatanodeInfoWithStorage
```
@Private
@Evolving
public class DatanodeInfo
extends DatanodeID
implements org.apache.hadoop.net.Node
```
This class extends the primary identifier of a Datanode with ephemeral state, eg usage information, current administrative state, and the network location that is communicated to clients.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DatanodeInfo.AdminStates

static class DatanodeInfo.DatanodeInfoBuilder
Building the DataNodeInfo.

Nested Classes
Modifier and Type	Class	Description
`static class`	`DatanodeInfo.AdminStates`
`static class`	`DatanodeInfo.DatanodeInfoBuilder`	Building the DataNodeInfo.

Field Summary

Fields
Modifier and Type Field Description

protected DatanodeInfo.AdminStates adminState

static DatanodeInfo[] EMPTY_ARRAY
- Fields inherited from class org.apache.hadoop.hdfs.protocol.DatanodeID
  EMPTY_DATANODE_ID

Fields
Modifier and Type	Field	Description
`protected DatanodeInfo.AdminStates`	`adminState`
`static DatanodeInfo[]`	`EMPTY_ARRAY`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`DatanodeInfo(DatanodeID nodeID)`
`protected`	`DatanodeInfo(DatanodeID nodeID, java.lang.String location)`
`protected`	`DatanodeInfo(DatanodeInfo from)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDependentHostName(java.lang.String hostname)`	Add a hostname to a list of network dependencies
`java.lang.String`	`dumpDatanode()`	A formatted string for printing the status of the DataNode.
`boolean`	`equals(java.lang.Object obj)`
`DatanodeInfo.AdminStates`	`getAdminState()`	Retrieves the admin state of this node.
`long`	`getBlockPoolUsed()`	The used space by the block pool on data node.
`float`	`getBlockPoolUsedPercent()`	Used space by the block pool as percentage of present capacity
`long`	`getCacheCapacity()`
`long`	`getCacheRemaining()`
`float`	`getCacheRemainingPercent()`
`long`	`getCacheUsed()`
`float`	`getCacheUsedPercent()`
`long`	`getCapacity()`	The raw capacity.
`java.lang.String`	`getDatanodeReport()`	A formatted string for reporting the status of the DataNode.
`java.util.List<java.lang.String>`	`getDependentHostNames()`	List of Network dependencies
`long`	`getDfsUsed()`	The used space by the data node.
`float`	`getDfsUsedPercent()`	The used space by the data node as percentage of present capacity
`long`	`getLastBlockReportMonotonic()`	Last block report monotonic time.
`long`	`getLastBlockReportTime()`	Last block report time.
`long`	`getLastUpdate()`	Get the last update timestamp.
`long`	`getLastUpdateMonotonic()`	The time when this information was accurate.
`int`	`getLevel()`	Return this node's level in the tree.
`long`	`getMaintenanceExpireTimeInMS()`
`java.lang.String`	`getName()`	Network location name.
`java.lang.String`	`getNetworkLocation()`	network location
`long`	`getNonDfsUsed()`	The used space by the data node.
`int`	`getNumBlocks()`
`org.apache.hadoop.net.Node`	`getParent()`	Return this node's parent
`long`	`getRemaining()`	The raw free space.
`float`	`getRemainingPercent()`	The remaining space as percentage of configured capacity.
`java.lang.String`	`getSoftwareVersion()`
`java.lang.String`	`getUpgradeDomain()`	upgrade domain
`int`	`getXceiverCount()`	number of active connections
`int`	`hashCode()`
`boolean`	`isDecommissioned()`	Returns true if the node has been decommissioned.
`boolean`	`isDecommissionInProgress()`	Returns true if the node is in the process of being decommissioned
`boolean`	`isEnteringMaintenance()`	Returns true if the node is is entering_maintenance
`boolean`	`isInMaintenance()`	Returns true if the node is in maintenance
`boolean`	`isInService()`
`boolean`	`isMaintenance()`	Returns true if the node is entering or in maintenance
`boolean`	`isStale(long staleInterval)`	Check if the datanode is in stale state.
`boolean`	`maintenanceExpired()`
`static boolean`	`maintenanceNotExpired(long maintenanceExpireTimeInMS)`
`protected void`	`setAdminState(DatanodeInfo.AdminStates newState)`	Sets the admin state of this node.
`void`	`setBlockPoolUsed(long bpUsed)`	Sets block pool used space
`void`	`setCacheCapacity(long cacheCapacity)`	Sets cache capacity.
`void`	`setCacheUsed(long cacheUsed)`	Sets cache used.
`void`	`setCapacity(long capacity)`	Sets raw capacity.
`void`	`setDecommissioned()`	Sets the admin state to indicate that decommission is complete.
`void`	`setDependentHostNames(java.util.List<java.lang.String> dependencyList)`	Sets the network dependencies
`void`	`setDfsUsed(long dfsUsed)`	Sets the used space for the datanode.
`void`	`setInMaintenance()`	Put a node directly to maintenance mode.
`void`	`setLastBlockReportMonotonic(long lastBlockReportMonotonic)`	Sets the last block report monotonic time.
`void`	`setLastBlockReportTime(long lastBlockReportTime)`	Sets the last block report time.
`void`	`setLastUpdate(long lastUpdate)`	Sets time when this information was accurate.
`void`	`setLastUpdateMonotonic(long lastUpdateMonotonic)`	Set lastUpdate monotonic time
`void`	`setLevel(int level)`
`void`	`setMaintenanceExpireTimeInMS(long maintenanceExpireTimeInMS)`
`void`	`setNetworkLocation(java.lang.String location)`	Sets the network location
`void`	`setNonDfsUsed(long nonDfsUsed)`	Sets the nondfs-used space for the datanode.
`void`	`setNumBlocks(int blockCount)`	Sets number of blocks.
`void`	`setParent(org.apache.hadoop.net.Node parent)`
`void`	`setRemaining(long remaining)`	Sets raw free space.
`void`	`setSoftwareVersion(java.lang.String softwareVersion)`
`void`	`setUpgradeDomain(java.lang.String upgradeDomain)`	Sets the upgrade domain
`void`	`setXceiverCount(int xceiverCount)`	Sets number of active connections
`void`	`startDecommission()`	Start decommissioning a node.
`void`	`startMaintenance()`	Start the maintenance operation.
`void`	`stopDecommission()`	Stop decommissioning a node.
`void`	`stopMaintenance()`	Take the node out of maintenance mode.

Methods inherited from class org.apache.hadoop.hdfs.protocol.DatanodeID
compareTo, getDatanodeUuid, getDatanodeUuidBytes, getHostName, getHostNameBytes, getInfoAddr, getInfoPort, getInfoSecureAddr, getInfoSecurePort, getIpAddr, getIpAddrBytes, getIpcAddr, getIpcPort, getPeerHostName, getResolvedAddress, getXferAddr, getXferAddr, getXferAddrWithHostname, getXferPort, setIpAddr, setPeerHostName, toString, updateRegInfo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final DatanodeInfo[] EMPTY_ARRAY
```
  - adminState
```
protected DatanodeInfo.AdminStates adminState
```
- Constructor Detail
  - DatanodeInfo
```
protected DatanodeInfo(DatanodeInfo from)
```
  - DatanodeInfo
```
protected DatanodeInfo(DatanodeID nodeID)
```
  - DatanodeInfo
```
protected DatanodeInfo(DatanodeID nodeID,
                       java.lang.String location)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Network location name.
    
    Specified by:
    
    getName in interface org.apache.hadoop.net.Node
  - getCapacity
```
public long getCapacity()
```
    The raw capacity.
  - getDfsUsed
```
public long getDfsUsed()
```
    The used space by the data node.
  - getBlockPoolUsed
```
public long getBlockPoolUsed()
```
    The used space by the block pool on data node.
  - getNonDfsUsed
```
public long getNonDfsUsed()
```
    The used space by the data node.
  - getDfsUsedPercent
```
public float getDfsUsedPercent()
```
    The used space by the data node as percentage of present capacity
  - getRemaining
```
public long getRemaining()
```
    The raw free space.
  - getBlockPoolUsedPercent
```
public float getBlockPoolUsedPercent()
```
    Used space by the block pool as percentage of present capacity
  - getRemainingPercent
```
public float getRemainingPercent()
```
    The remaining space as percentage of configured capacity.
  - getCacheCapacity
```
public long getCacheCapacity()
```
    Returns:
    
    Amount of cache capacity in bytes
  - getCacheUsed
```
public long getCacheUsed()
```
    Returns:
    
    Amount of cache used in bytes
  - getCacheUsedPercent
```
public float getCacheUsedPercent()
```
    Returns:
    
    Cache used as a percentage of the datanode's total cache capacity
  - getCacheRemaining
```
public long getCacheRemaining()
```
    Returns:
    
    Amount of cache remaining in bytes
  - getCacheRemainingPercent
```
public float getCacheRemainingPercent()
```
    Returns:
    
    Cache remaining as a percentage of the datanode's total cache capacity
  - getLastUpdate
```
public long getLastUpdate()
```
    Get the last update timestamp. Return value is suitable for Date conversion.
  - getLastUpdateMonotonic
```
public long getLastUpdateMonotonic()
```
    The time when this information was accurate.
    Ps: So return value is ideal for calculation of time differences. Should not be used to convert to Date.
  - getNumBlocks
```
public int getNumBlocks()
```
    Returns:
    
    Num of Blocks
  - setLastUpdateMonotonic
```
public void setLastUpdateMonotonic(long lastUpdateMonotonic)
```
    Set lastUpdate monotonic time
  - getXceiverCount
```
public int getXceiverCount()
```
    number of active connections
  - setCapacity
```
public void setCapacity(long capacity)
```
    Sets raw capacity.
  - setDfsUsed
```
public void setDfsUsed(long dfsUsed)
```
    Sets the used space for the datanode.
  - setNonDfsUsed
```
public void setNonDfsUsed(long nonDfsUsed)
```
    Sets the nondfs-used space for the datanode.
  - setRemaining
```
public void setRemaining(long remaining)
```
    Sets raw free space.
  - setBlockPoolUsed
```
public void setBlockPoolUsed(long bpUsed)
```
    Sets block pool used space
  - setCacheCapacity
```
public void setCacheCapacity(long cacheCapacity)
```
    Sets cache capacity.
  - setCacheUsed
```
public void setCacheUsed(long cacheUsed)
```
    Sets cache used.
  - setLastUpdate
```
public void setLastUpdate(long lastUpdate)
```
    Sets time when this information was accurate.
  - setXceiverCount
```
public void setXceiverCount(int xceiverCount)
```
    Sets number of active connections
  - setNumBlocks
```
public void setNumBlocks(int blockCount)
```
    Sets number of blocks.
  - getNetworkLocation
```
public java.lang.String getNetworkLocation()
```
    network location
    
    Specified by:
    
    getNetworkLocation in interface org.apache.hadoop.net.Node
  - setNetworkLocation
```
public void setNetworkLocation(java.lang.String location)
```
    Sets the network location
    
    Specified by:
    
    setNetworkLocation in interface org.apache.hadoop.net.Node
  - setUpgradeDomain
```
public void setUpgradeDomain(java.lang.String upgradeDomain)
```
    Sets the upgrade domain
  - getUpgradeDomain
```
public java.lang.String getUpgradeDomain()
```
    upgrade domain
  - addDependentHostName
```
public void addDependentHostName(java.lang.String hostname)
```
    Add a hostname to a list of network dependencies
  - getDependentHostNames
```
public java.util.List<java.lang.String> getDependentHostNames()
```
    List of Network dependencies
  - setDependentHostNames
```
public void setDependentHostNames(java.util.List<java.lang.String> dependencyList)
```
    Sets the network dependencies
  - getDatanodeReport
```
public java.lang.String getDatanodeReport()
```
    A formatted string for reporting the status of the DataNode.
  - dumpDatanode
```
public java.lang.String dumpDatanode()
```
    A formatted string for printing the status of the DataNode.
  - startDecommission
```
public void startDecommission()
```
    Start decommissioning a node. old state.
  - stopDecommission
```
public void stopDecommission()
```
    Stop decommissioning a node. old state.
  - isDecommissionInProgress
```
public boolean isDecommissionInProgress()
```
    Returns true if the node is in the process of being decommissioned
  - isDecommissioned
```
public boolean isDecommissioned()
```
    Returns true if the node has been decommissioned.
  - setDecommissioned
```
public void setDecommissioned()
```
    Sets the admin state to indicate that decommission is complete.
  - startMaintenance
```
public void startMaintenance()
```
    Start the maintenance operation.
  - setInMaintenance
```
public void setInMaintenance()
```
    Put a node directly to maintenance mode.
  - setMaintenanceExpireTimeInMS
```
public void setMaintenanceExpireTimeInMS(long maintenanceExpireTimeInMS)
```
    Parameters:
    
    maintenanceExpireTimeInMS - the time that the DataNode is in the maintenance mode until in the unit of milliseconds.
  - getMaintenanceExpireTimeInMS
```
public long getMaintenanceExpireTimeInMS()
```
  - setLastBlockReportTime
```
public void setLastBlockReportTime(long lastBlockReportTime)
```
    Sets the last block report time.
  - setLastBlockReportMonotonic
```
public void setLastBlockReportMonotonic(long lastBlockReportMonotonic)
```
    Sets the last block report monotonic time.
  - getLastBlockReportTime
```
public long getLastBlockReportTime()
```
    Last block report time.
  - getLastBlockReportMonotonic
```
public long getLastBlockReportMonotonic()
```
    Last block report monotonic time.
  - stopMaintenance
```
public void stopMaintenance()
```
    Take the node out of maintenance mode.
  - maintenanceNotExpired
```
public static boolean maintenanceNotExpired(long maintenanceExpireTimeInMS)
```
  - isEnteringMaintenance
```
public boolean isEnteringMaintenance()
```
    Returns true if the node is is entering_maintenance
  - isInMaintenance
```
public boolean isInMaintenance()
```
    Returns true if the node is in maintenance
  - isMaintenance
```
public boolean isMaintenance()
```
    Returns true if the node is entering or in maintenance
  - maintenanceExpired
```
public boolean maintenanceExpired()
```
  - isInService
```
public boolean isInService()
```
  - getAdminState
```
public DatanodeInfo.AdminStates getAdminState()
```
    Retrieves the admin state of this node.
  - isStale
```
public boolean isStale(long staleInterval)
```
    Check if the datanode is in stale state. Here if the namenode has not received heartbeat msg from a datanode for more than staleInterval, the datanode will be treated as stale node.
    
    Parameters:
    
    staleInterval - the time interval for marking the node as stale. If the last update time is beyond the given time interval, the node will be marked as stale.
    
    Returns:
    
    true if the node is stale
  - setAdminState
```
protected void setAdminState(DatanodeInfo.AdminStates newState)
```
    Sets the admin state of this node.
  - getParent
```
public org.apache.hadoop.net.Node getParent()
```
    Return this node's parent
    
    Specified by:
    
    getParent in interface org.apache.hadoop.net.Node
  - setParent
```
public void setParent(org.apache.hadoop.net.Node parent)
```
    Specified by:
    
    setParent in interface org.apache.hadoop.net.Node
  - getLevel
```
public int getLevel()
```
    Return this node's level in the tree. E.g. the root of a tree returns 0 and its children return 1
    
    Specified by:
    
    getLevel in interface org.apache.hadoop.net.Node
  - setLevel
```
public void setLevel(int level)
```
    Specified by:
    
    setLevel in interface org.apache.hadoop.net.Node
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class DatanodeID
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class DatanodeID
  - getSoftwareVersion
```
public java.lang.String getSoftwareVersion()
```
  - setSoftwareVersion
```
public void setSoftwareVersion(java.lang.String softwareVersion)
```

Class DatanodeInfo

Nested Class Summary

Field Summary

Fields inherited from class org.apache.hadoop.hdfs.protocol.DatanodeID

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hdfs.protocol.DatanodeID

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

adminState

Constructor Detail

DatanodeInfo

DatanodeInfo

DatanodeInfo

Method Detail

getName

getCapacity

getDfsUsed

getBlockPoolUsed

getNonDfsUsed

getDfsUsedPercent

getRemaining

getBlockPoolUsedPercent

getRemainingPercent

getCacheCapacity

getCacheUsed

getCacheUsedPercent

getCacheRemaining

getCacheRemainingPercent

getLastUpdate

getLastUpdateMonotonic

getNumBlocks

setLastUpdateMonotonic

getXceiverCount

setCapacity

setDfsUsed

setNonDfsUsed

setRemaining

setBlockPoolUsed

setCacheCapacity

setCacheUsed

setLastUpdate

setXceiverCount

setNumBlocks

getNetworkLocation

setNetworkLocation

setUpgradeDomain

getUpgradeDomain

addDependentHostName

getDependentHostNames

setDependentHostNames

getDatanodeReport

dumpDatanode

startDecommission

stopDecommission

isDecommissionInProgress

isDecommissioned

setDecommissioned

startMaintenance

setInMaintenance

setMaintenanceExpireTimeInMS

getMaintenanceExpireTimeInMS

setLastBlockReportTime

setLastBlockReportMonotonic

getLastBlockReportTime

getLastBlockReportMonotonic

stopMaintenance

maintenanceNotExpired

isEnteringMaintenance

isInMaintenance

isMaintenance

maintenanceExpired

isInService

getAdminState

isStale

setAdminState

getParent

setParent

getLevel