ClusterStatus (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.ClusterStatus

All Implemented Interfaces:

ClusterMetrics

Deprecated.
As of release 2.0.0, this will be removed in HBase 3.0.0 Use ClusterMetrics instead.
```
@InterfaceAudience.Public
 @Deprecated
public class ClusterStatus
extends Object
implements ClusterMetrics
```
Status information on the HBase cluster.
ClusterStatus provides clients with information such as:
- The count and names of region servers in the cluster.
- The count and names of dead region servers in the cluster.
- The name of the active master for the cluster.
- The name(s) of the backup master(s) for the cluster, if they exist.
- The average cluster load.
- The number of regions deployed on the cluster.
- The number of requests since last report.
- Detailed region server loading and resource usage information, per server and per region.
- Regions in transition at master
- The unique cluster ID
ClusterMetrics.Option provides a way to get desired ClusterStatus information. The following codes will get all the cluster information.
```
 {
   @code
   // Original version still works
   Admin admin = connection.getAdmin();
   ClusterStatus status = admin.getClusterStatus();
   // or below, a new version which has the same effects
   ClusterStatus status = admin.getClusterStatus(EnumSet.allOf(Option.class));
 }
 
```
If information about live servers is the only wanted. then codes in the following way:
```
 {
   @code
   Admin admin = connection.getAdmin();
   ClusterStatus status = admin.getClusterStatus(EnumSet.of(Option.LIVE_SERVERS));
 }
 
```

Constructor Summary

Constructors
Constructor and Description
`ClusterStatus(ClusterMetrics metrics)` Deprecated.
`ClusterStatus(String hbaseVersion, String clusterid, Map<ServerName,ServerLoad> servers, Collection<ServerName> deadServers, ServerName master, Collection<ServerName> backupMasters, List<org.apache.hadoop.hbase.master.RegionState> rit, String[] masterCoprocessors, Boolean balancerOn, int masterInfoPort)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Deprecated.
`List<ServerName>`	`getBackupMasterNames()` Deprecated. Returns the names of backup masters
`List<ServerName>`	`getBackupMasters()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getBackupMasterNames()` instead.
`int`	`getBackupMastersSize()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getBackupMasterNames()` instead.
`Boolean`	`getBalancerOn()` Deprecated.
`String`	`getClusterId()` Deprecated.
`List<ServerName>`	`getDeadServerNames()` Deprecated. Returns the names of region servers on the dead list
`int`	`getDeadServers()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13656). Use `getDeadServerNames()`.
`int`	`getDeadServersSize()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getDeadServerNames()`.
`String`	`getHBaseVersion()` Deprecated. Returns the HBase version string as reported by the HMaster
`long`	`getLastMajorCompactionTsForRegion(byte[] region)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `ClusterMetrics.getLastMajorCompactionTimestamp(byte[])` instead.
`long`	`getLastMajorCompactionTsForTable(TableName table)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `ClusterMetrics.getLastMajorCompactionTimestamp(TableName)` instead.
`Map<ServerName,ServerMetrics>`	`getLiveServerMetrics()` Deprecated. Returns the names of region servers on the live list
`ServerLoad`	`getLoad(ServerName sn)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getLiveServerMetrics()` instead.
`ServerName`	`getMaster()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getMasterName()` instead.
`List<String>`	`getMasterCoprocessorNames()` Deprecated.
`String[]`	`getMasterCoprocessors()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getMasterCoprocessorNames()` instead.
`int`	`getMasterInfoPort()` Deprecated.
`ServerName`	`getMasterName()` Deprecated. Returns detailed information about the current master `ServerName`.
`List<ServerTask>`	`getMasterTasks()` Deprecated. Provide the list of master tasks
`int`	`getRegionsCount()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `ClusterMetrics.getRegionCount()`.
`List<org.apache.hadoop.hbase.master.RegionState>`	`getRegionStatesInTransition()` Deprecated.
`int`	`getRequestsCount()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `ClusterMetrics.getRequestCount()` instead.
`Collection<ServerName>`	`getServers()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getLiveServerMetrics()` instead.
`List<ServerName>`	`getServersName()` Deprecated.
`int`	`getServersSize()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getLiveServerMetrics()`.
`Map<TableName,org.apache.hadoop.hbase.client.RegionStatesCount>`	`getTableRegionStatesCount()` Deprecated. Provide region states count for given table.
`List<ServerName>`	`getUnknownServerNames()` Deprecated. Returns the names of region servers on the unknown list
`byte`	`getVersion()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0
`int`	`hashCode()` Deprecated.
`boolean`	`isBalancerOn()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 No flag in 2.0
`String`	`toString()` Deprecated.

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

Methods inherited from interface org.apache.hadoop.hbase.ClusterMetrics
getAverageLoad, getLastMajorCompactionTimestamp, getLastMajorCompactionTimestamp, getRegionCount, getRequestCount

- Constructor Detail
  - ClusterStatus
```
@Deprecated
public ClusterStatus(String hbaseVersion,
                                 String clusterid,
                                 Map<ServerName,ServerLoad> servers,
                                 Collection<ServerName> deadServers,
                                 ServerName master,
                                 Collection<ServerName> backupMasters,
                                 List<org.apache.hadoop.hbase.master.RegionState> rit,
                                 String[] masterCoprocessors,
                                 Boolean balancerOn,
                                 int masterInfoPort)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0
  - ClusterStatus
```
@InterfaceAudience.Private
public ClusterStatus(ClusterMetrics metrics)
```
    Deprecated.
- Method Detail
  - getDeadServerNames
```
public List<ServerName> getDeadServerNames()
```
    Deprecated.
    
    Returns the names of region servers on the dead list
    
    Specified by:
    
    getDeadServerNames in interface ClusterMetrics
  - getUnknownServerNames
```
public List<ServerName> getUnknownServerNames()
```
    Deprecated.
    
    Description copied from interface: ClusterMetrics
    
    Returns the names of region servers on the unknown list
    
    Specified by:
    
    getUnknownServerNames in interface ClusterMetrics
  - getLiveServerMetrics
```
public Map<ServerName,ServerMetrics> getLiveServerMetrics()
```
    Deprecated.
    
    Description copied from interface: ClusterMetrics
    
    Returns the names of region servers on the live list
    
    Specified by:
    
    getLiveServerMetrics in interface ClusterMetrics
  - getServersSize
```
@Deprecated
public int getServersSize()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getLiveServerMetrics().
    
    Returns:
    
    the number of region servers in the cluster
  - getDeadServers
```
@Deprecated
public int getDeadServers()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13656). Use getDeadServerNames().
    
    Returns:
    
    the number of dead region servers in the cluster
  - getDeadServersSize
```
@Deprecated
public int getDeadServersSize()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getDeadServerNames().
    
    Returns:
    
    the number of dead region servers in the cluster
  - getRegionsCount
```
@Deprecated
public int getRegionsCount()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use ClusterMetrics.getRegionCount().
    
    Returns:
    
    the number of regions deployed on the cluster
  - getRequestsCount
```
@Deprecated
public int getRequestsCount()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use ClusterMetrics.getRequestCount() instead.
    
    Returns:
    
    the number of requests since last report
  - getMasterName
```
@Nullable
public ServerName getMasterName()
```
    Deprecated.
    
    Description copied from interface: ClusterMetrics
    
    Returns detailed information about the current master ServerName.
    
    Specified by:
    
    getMasterName in interface ClusterMetrics
    
    Returns:
    
    current master information if it exists
  - getBackupMasterNames
```
public List<ServerName> getBackupMasterNames()
```
    Deprecated.
    
    Description copied from interface: ClusterMetrics
    
    Returns the names of backup masters
    
    Specified by:
    
    getBackupMasterNames in interface ClusterMetrics
  - getRegionStatesInTransition
```
public List<org.apache.hadoop.hbase.master.RegionState> getRegionStatesInTransition()
```
    Deprecated.
    
    Specified by:
    
    getRegionStatesInTransition in interface ClusterMetrics
  - getHBaseVersion
```
public String getHBaseVersion()
```
    Deprecated.
    
    Returns the HBase version string as reported by the HMaster
    
    Specified by:
    
    getHBaseVersion in interface ClusterMetrics
  - equals
```
public boolean equals(Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
  - getVersion
```
@Deprecated
public byte getVersion()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0
    
    Returns:
    
    the object version number
  - getServers
```
@Deprecated
public Collection<ServerName> getServers()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getLiveServerMetrics() instead.
  - getMaster
```
@Deprecated
public ServerName getMaster()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getMasterName() instead.
    
    Returns detailed information about the current master ServerName.
    
    Returns:
    
    current master information if it exists
  - getBackupMastersSize
```
@Deprecated
public int getBackupMastersSize()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getBackupMasterNames() instead.
    
    Returns:
    
    the number of backup masters in the cluster
  - getBackupMasters
```
@Deprecated
public List<ServerName> getBackupMasters()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getBackupMasterNames() instead.
    
    Returns:
    
    the names of backup masters
  - getLoad
```
@Deprecated
public ServerLoad getLoad(ServerName sn)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getLiveServerMetrics() instead.
    
    n * @return Server's load or null if not found.
  - getClusterId
```
public String getClusterId()
```
    Deprecated.
    
    Specified by:
    
    getClusterId in interface ClusterMetrics
  - getMasterCoprocessorNames
```
public List<String> getMasterCoprocessorNames()
```
    Deprecated.
    
    Specified by:
    
    getMasterCoprocessorNames in interface ClusterMetrics
  - getMasterCoprocessors
```
@Deprecated
public String[] getMasterCoprocessors()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getMasterCoprocessorNames() instead.
    
    Get the list of master coprocessor names.
  - getLastMajorCompactionTsForTable
```
@Deprecated
public long getLastMajorCompactionTsForTable(TableName table)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use ClusterMetrics.getLastMajorCompactionTimestamp(TableName) instead.
    
    Get the last major compaction time for a given table.
  - getLastMajorCompactionTsForRegion
```
@Deprecated
public long getLastMajorCompactionTsForRegion(byte[] region)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use ClusterMetrics.getLastMajorCompactionTimestamp(byte[]) instead.
    
    Get the last major compaction time for a given region.
  - isBalancerOn
```
@Deprecated
public boolean isBalancerOn()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 No flag in 2.0
    
    Returns true if the balancer is enabled.
  - getBalancerOn
```
public Boolean getBalancerOn()
```
    Deprecated.
    
    Specified by:
    
    getBalancerOn in interface ClusterMetrics
  - getMasterInfoPort
```
public int getMasterInfoPort()
```
    Deprecated.
    
    Specified by:
    
    getMasterInfoPort in interface ClusterMetrics
  - getServersName
```
public List<ServerName> getServersName()
```
    Deprecated.
    
    Specified by:
    
    getServersName in interface ClusterMetrics
  - getTableRegionStatesCount
```
public Map<TableName,org.apache.hadoop.hbase.client.RegionStatesCount> getTableRegionStatesCount()
```
    Deprecated.
    
    Description copied from interface: ClusterMetrics
    
    Provide region states count for given table. e.g howmany regions of give table are opened/closed/rit etc
    
    Specified by:
    
    getTableRegionStatesCount in interface ClusterMetrics
    
    Returns:
    
    map of table to region states count
  - getMasterTasks
```
public List<ServerTask> getMasterTasks()
```
    Deprecated.
    
    Description copied from interface: ClusterMetrics
    
    Provide the list of master tasks
    
    Specified by:
    
    getMasterTasks in interface ClusterMetrics
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object

Class ClusterStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.ClusterMetrics

Constructor Detail

ClusterStatus

ClusterStatus

Method Detail

getDeadServerNames

getUnknownServerNames

getLiveServerMetrics

getServersSize

getDeadServers

getDeadServersSize

getRegionsCount

getRequestsCount

getMasterName

getBackupMasterNames

getRegionStatesInTransition

getHBaseVersion

equals

hashCode

getVersion

getServers

getMaster

getBackupMastersSize

getBackupMasters

getLoad

getClusterId

getMasterCoprocessorNames

getMasterCoprocessors

getLastMajorCompactionTsForTable

getLastMajorCompactionTsForRegion

isBalancerOn

getBalancerOn

getMasterInfoPort

getServersName

getTableRegionStatesCount

getMasterTasks

toString