DatanodeInfo (Hadoop 1.2.2-SNAPSHOT API)

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

所有已实现的接口:

Comparable<DatanodeID>, Writable, WritableComparable<DatanodeID>, Node

直接已知子类:

DatanodeDescriptor
```
public class DatanodeInfo
extends DatanodeID
implements Node
```
DatanodeInfo represents the status of a DataNode. This object is used for communication in the Datanode Protocol and the Client Protocol.

嵌套类概要

嵌套类
限定符和类型类和说明

static class DatanodeInfo.AdminStates

嵌套类
限定符和类型	类和说明
`static class`	`DatanodeInfo.AdminStates`

字段概要

字段
限定符和类型	字段和说明
`protected DatanodeInfo.AdminStates`	`adminState`
`protected long`	`capacity`
`protected long`	`dfsUsed`
`protected String`	`hostName` HostName as suplied by the datanode during registration as its name.
`protected long`	`lastUpdate`
`protected String`	`location`
`protected long`	`remaining`
`protected int`	`xceiverCount`

从类继承的字段 org.apache.hadoop.hdfs.protocol.DatanodeID
EMPTY_ARRAY, infoPort, ipcPort, name, storageID

构造器概要

构造器
限定符	构造器和说明
	`DatanodeInfo()`
	`DatanodeInfo(DatanodeID nodeID)`
`protected`	`DatanodeInfo(DatanodeID nodeID, String location, String hostName)`
	`DatanodeInfo(DatanodeInfo from)`
	`DatanodeInfo(String name, String storageID, int infoPort, int ipcPort, long capacity, long dfsUsed, long remaining, long lastUpdate, int xceiverCount, String networkLocation, String hostName, DatanodeInfo.AdminStates adminState)` Constructor

方法概要

方法
限定符和类型	方法和说明
`String`	`dumpDatanode()` A formatted string for printing the status of the DataNode.
`DatanodeInfo.AdminStates`	`getAdminState()` Retrieves the admin state of this node.
`long`	`getCapacity()` The raw capacity.
`String`	`getDatanodeReport()` A formatted string for reporting the status of the DataNode.
`long`	`getDfsUsed()` The used space by the data node.
`float`	`getDfsUsedPercent()` The used space by the data node as percentage of present capacity
`String`	`getHostName()`
`long`	`getLastUpdate()` The time when this information was accurate.
`int`	`getLevel()` Return this node's level in the tree.
`String`	`getName(boolean useHostname)` Return hostname:port if requested, ip:port otherwise
`String`	`getNameWithIpcPort(boolean useHostname)` Return hostname:ipcPort if requested, ip:ipcPort otherwise
`String`	`getNetworkLocation()` network location
`long`	`getNonDfsUsed()` The used space by the data node.
`Node`	`getParent()` Return this node's parent
`long`	`getRemaining()` The raw free space.
`float`	`getRemainingPercent()` The remaining space as percentage of configured capacity.
`int`	`getXceiverCount()` number of active connections
`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`	`isStale(long staleInterval)` Check if the datanode is in stale state.
`void`	`readFields(DataInput in)` Deserialize the fields of this object from `in`.
`protected void`	`setAdminState(DatanodeInfo.AdminStates newState)` Sets the admin state of this node.
`void`	`setCapacity(long capacity)` Sets raw capacity.
`void`	`setDecommissioned()` Sets the admin state to indicate that decommision is complete.
`void`	`setHostName(String host)`
`void`	`setLastUpdate(long lastUpdate)` Sets time when this information was accurate.
`void`	`setLevel(int level)` Set this node's level in the tree.
`void`	`setNetworkLocation(String location)` Sets the network location
`void`	`setParent(Node parent)` Set this node's parent
`void`	`setRemaining(long remaining)` Sets raw free space.
`void`	`setXceiverCount(int xceiverCount)` Sets number of active connections
`void`	`startDecommission()` Start decommissioning a node.
`void`	`stopDecommission()` Stop decommissioning a node.
`void`	`write(DataOutput out)` Serialize the fields of this object to `out`.

从类继承的方法 org.apache.hadoop.hdfs.protocol.DatanodeID
compareTo, equals, getHost, getInfoPort, getIpcPort, getName, getPort, getStorageID, hashCode, setStorageID, toString, updateRegInfo

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.hadoop.net.Node
getName

- 字段详细资料
  - capacity
```
protected long capacity
```
  - dfsUsed
```
protected long dfsUsed
```
  - remaining
```
protected long remaining
```
  - lastUpdate
```
protected long lastUpdate
```
  - xceiverCount
```
protected int xceiverCount
```
  - location
```
protected String location
```
  - hostName
```
protected String hostName
```
    HostName as suplied by the datanode during registration as its name. Namenode uses datanode IP address as the name.
  - adminState
```
protected DatanodeInfo.AdminStates adminState
```
- 构造器详细资料
  - DatanodeInfo
```
public DatanodeInfo()
```
  - DatanodeInfo
```
public DatanodeInfo(DatanodeInfo from)
```
  - DatanodeInfo
```
public DatanodeInfo(DatanodeID nodeID)
```
  - DatanodeInfo
```
protected DatanodeInfo(DatanodeID nodeID,
            String location,
            String hostName)
```
  - DatanodeInfo
```
public DatanodeInfo(String name,
            String storageID,
            int infoPort,
            int ipcPort,
            long capacity,
            long dfsUsed,
            long remaining,
            long lastUpdate,
            int xceiverCount,
            String networkLocation,
            String hostName,
            DatanodeInfo.AdminStates adminState)
```
    Constructor
- 方法详细资料
  - getCapacity
```
public long getCapacity()
```
    The raw capacity.
  - getDfsUsed
```
public long getDfsUsed()
```
    The used space by the 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.
  - getRemainingPercent
```
public float getRemainingPercent()
```
    The remaining space as percentage of configured capacity.
  - getLastUpdate
```
public long getLastUpdate()
```
    The time when this information was accurate.
  - getXceiverCount
```
public int getXceiverCount()
```
    number of active connections
  - setCapacity
```
public void setCapacity(long capacity)
```
    Sets raw capacity.
  - setRemaining
```
public void setRemaining(long remaining)
```
    Sets raw free space.
  - setLastUpdate
```
public void setLastUpdate(long lastUpdate)
```
    Sets time when this information was accurate.
  - setXceiverCount
```
public void setXceiverCount(int xceiverCount)
```
    Sets number of active connections
  - getNetworkLocation
```
public String getNetworkLocation()
```
    network location
    
    指定者:
    
    getNetworkLocation 在接口中 Node
  - setNetworkLocation
```
public void setNetworkLocation(String location)
```
    Sets the network location
    
    指定者:
    
    setNetworkLocation 在接口中 Node
  - getHostName
```
public String getHostName()
```
  - setHostName
```
public void setHostName(String host)
```
  - getName
```
public String getName(boolean useHostname)
```
    Return hostname:port if requested, ip:port otherwise
  - getNameWithIpcPort
```
public String getNameWithIpcPort(boolean useHostname)
```
    Return hostname:ipcPort if requested, ip:ipcPort otherwise
  - getDatanodeReport
```
public String getDatanodeReport()
```
    A formatted string for reporting the status of the DataNode.
  - dumpDatanode
```
public 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 decommision is complete.
  - 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 (default value is DFSConfigKeys#DFS_NAMENODE_STALE_DATANODE_INTERVAL_MILLI_DEFAULT), the datanode will be treated as stale node.
    
    参数:
    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.
    
    返回:
    true if the node is stale
  - getAdminState
```
public DatanodeInfo.AdminStates getAdminState()
```
    Retrieves the admin state of this node.
  - setAdminState
```
protected void setAdminState(DatanodeInfo.AdminStates newState)
```
    Sets the admin state of this node.
  - getParent
```
public Node getParent()
```
    Return this node's parent
    
    指定者:
    
    getParent 在接口中 Node
  - setParent
```
public void setParent(Node parent)
```
    从接口复制的说明: Node
    
    Set this node's parent
    
    指定者:
    
    setParent 在接口中 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
    
    指定者:
    
    getLevel 在接口中 Node
  - setLevel
```
public void setLevel(int level)
```
    从接口复制的说明: Node
    
    Set this node's level in the tree.
    
    指定者:
    
    setLevel 在接口中 Node
  - write
```
public void write(DataOutput out)
           throws IOException
```
    Serialize the fields of this object to out.
    
    指定者:
    
    write 在接口中 Writable
    
    覆盖:
    
    write 在类中 DatanodeID
    
    参数:
    out - DataOuput to serialize this object into.
    
    抛出:
    
    IOException
  - readFields
```
public void readFields(DataInput in)
                throws IOException
```
    Deserialize the fields of this object from in.
    For efficiency, implementations should attempt to re-use storage in the existing object where possible.
    
    指定者:
    
    readFields 在接口中 Writable
    
    覆盖:
    
    readFields 在类中 DatanodeID
    
    参数:
    in - DataInput to deseriablize this object from.
    
    抛出:
    
    IOException

类 DatanodeInfo

嵌套类概要

字段概要

从类继承的字段 org.apache.hadoop.hdfs.protocol.DatanodeID

构造器概要

方法概要

从类继承的方法 org.apache.hadoop.hdfs.protocol.DatanodeID

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.hadoop.net.Node

字段详细资料

capacity

dfsUsed

remaining

lastUpdate

xceiverCount

location

hostName

adminState

构造器详细资料

DatanodeInfo

DatanodeInfo

DatanodeInfo

DatanodeInfo

DatanodeInfo

方法详细资料

getCapacity

getDfsUsed

getNonDfsUsed

getDfsUsedPercent

getRemaining

getRemainingPercent

getLastUpdate

getXceiverCount

setCapacity

setRemaining

setLastUpdate

setXceiverCount

getNetworkLocation

setNetworkLocation

getHostName

setHostName

getName

getNameWithIpcPort

getDatanodeReport

dumpDatanode

startDecommission

stopDecommission

isDecommissionInProgress

isDecommissioned

setDecommissioned

isStale

getAdminState

setAdminState

getParent

setParent

getLevel

setLevel

write

readFields