RegionLoad (Apache HBase - Client 2.4.13 API)

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

All Implemented Interfaces:

RegionMetrics

Deprecated.
As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionMetrics instead.
```
@InterfaceAudience.Public
 @Deprecated
public class RegionLoad
extends Object
implements RegionMetrics
```
Encapsulates per-region load metrics.

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.RegionLoad regionLoadPB
Deprecated.

Fields
Modifier and Type	Field and Description
`protected org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.RegionLoad`	`regionLoadPB` Deprecated.

Constructor Summary

Constructors
Constructor and Description

RegionLoad(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.RegionLoad regionLoadPB)
Deprecated.

Constructors
Constructor and Description
`RegionLoad(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.RegionLoad regionLoadPB)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`getBlocksLocalWeight()` Deprecated.
`long`	`getBlocksLocalWithSsdWeight()` Deprecated. Different from blocksLocalWeight,this metric's numerator only include the data stored on ssd
`long`	`getBlocksTotalWeight()` Deprecated.
`Size`	`getBloomFilterSize()` Deprecated.
`long`	`getCompactedCellCount()` Deprecated.
`long`	`getCompactingCellCount()` Deprecated.
`CompactionState`	`getCompactionState()` Deprecated.
`long`	`getCompletedSequenceId()` Deprecated. This does not really belong inside RegionLoad but its being done in the name of expediency.
`long`	`getCompleteSequenceId()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getCompletedSequenceId()` instead.
`long`	`getCurrentCompactedKVs()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getCompactedCellCount()` instead.
`float`	`getDataLocality()` Deprecated.
`float`	`getDataLocalityForSsd()` Deprecated. Different from dataLocality,this metric's numerator only include the data stored on ssd
`long`	`getFilteredReadRequestCount()` Deprecated.
`long`	`getFilteredReadRequestsCount()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getFilteredReadRequestCount()` instead.
`long`	`getLastMajorCompactionTimestamp()` Deprecated.
`long`	`getLastMajorCompactionTs()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getLastMajorCompactionTimestamp()` instead.
`int`	`getMaxCompactedStoreFileRefCount()` Deprecated.
`Size`	`getMemStoreSize()` Deprecated.
`int`	`getMemStoreSizeMB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getMemStoreSize()` instead.
`byte[]`	`getName()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getRegionName()` instead.
`long`	`getReadRequestCount()` Deprecated.
`long`	`getReadRequestsCount()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getReadRequestCount()` instead.
`byte[]`	`getRegionName()` Deprecated.
`long`	`getRequestsCount()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionMetrics.getRequestCount()` instead.
`int`	`getRootIndexSizeKB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreFileRootLevelIndexSize()` instead.
`List<org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.StoreSequenceId>`	`getStoreCompleteSequenceId()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreSequenceId()` instead.
`int`	`getStoreCount()` Deprecated.
`int`	`getStoreFileCount()` Deprecated.
`Size`	`getStoreFileIndexSize()` Deprecated. TODO: why we pass the same value to different counters? Currently, the value from getStoreFileIndexSize() is same with getStoreFileRootLevelIndexSize() see HRegionServer#createRegionLoad.
`int`	`getStorefileIndexSizeKB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreFileRootLevelIndexSize()` instead.
`int`	`getStorefileIndexSizeMB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 ((HBASE-3935)). Use `getStoreFileRootLevelIndexSize()` instead.
`Size`	`getStoreFileRootLevelIndexSize()` Deprecated.
`int`	`getStorefiles()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreFileCount()` instead.
`Size`	`getStoreFileSize()` Deprecated.
`int`	`getStorefileSizeMB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreFileSize()` instead.
`Size`	`getStoreFileUncompressedDataIndexSize()` Deprecated.
`int`	`getStoreRefCount()` Deprecated.
`int`	`getStores()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreCount()` instead.
`Map<byte[],Long>`	`getStoreSequenceId()` Deprecated.
`int`	`getStoreUncompressedSizeMB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getUncompressedStoreFileSize()` instead.
`long`	`getTotalCompactingKVs()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getCompactingCellCount()` instead.
`int`	`getTotalStaticBloomSizeKB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getBloomFilterSize()` instead.
`int`	`getTotalStaticIndexSizeKB()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getStoreFileUncompressedDataIndexSize()` instead.
`Size`	`getUncompressedStoreFileSize()` Deprecated.
`long`	`getWriteRequestCount()` Deprecated.
`long`	`getWriteRequestsCount()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getWriteRequestCount()` instead.
`String`	`toString()` Deprecated.

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

Methods inherited from interface org.apache.hadoop.hbase.RegionMetrics
getNameAsString, getRequestCount

- Field Detail
  - regionLoadPB
```
protected org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.RegionLoad regionLoadPB
```
    Deprecated.
- Constructor Detail
  - RegionLoad
```
public RegionLoad(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.RegionLoad regionLoadPB)
```
    Deprecated.
- Method Detail
  - getName
```
@Deprecated
public byte[] getName()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getRegionName() instead.
    
    Returns:
    
    the region name
  - getRegionName
```
public byte[] getRegionName()
```
    Deprecated.
    
    Specified by:
    
    getRegionName in interface RegionMetrics
    
    Returns:
    
    the region name
  - getStoreCount
```
public int getStoreCount()
```
    Deprecated.
    
    Specified by:
    
    getStoreCount in interface RegionMetrics
    
    Returns:
    
    the number of stores
  - getStoreFileCount
```
public int getStoreFileCount()
```
    Deprecated.
    
    Specified by:
    
    getStoreFileCount in interface RegionMetrics
    
    Returns:
    
    the number of storefiles
  - getStoreFileSize
```
public Size getStoreFileSize()
```
    Deprecated.
    
    Specified by:
    
    getStoreFileSize in interface RegionMetrics
    
    Returns:
    
    the total size of the storefiles
  - getMemStoreSize
```
public Size getMemStoreSize()
```
    Deprecated.
    
    Specified by:
    
    getMemStoreSize in interface RegionMetrics
    
    Returns:
    
    the memstore size
  - getReadRequestCount
```
public long getReadRequestCount()
```
    Deprecated.
    
    Specified by:
    
    getReadRequestCount in interface RegionMetrics
    
    Returns:
    
    the number of read requests made to region
  - getFilteredReadRequestCount
```
public long getFilteredReadRequestCount()
```
    Deprecated.
    
    Specified by:
    
    getFilteredReadRequestCount in interface RegionMetrics
    
    Returns:
    
    the number of filtered read requests made to region
  - getStoreFileIndexSize
```
public Size getStoreFileIndexSize()
```
    Deprecated.
    
    Description copied from interface: RegionMetrics
    
    TODO: why we pass the same value to different counters? Currently, the value from getStoreFileIndexSize() is same with getStoreFileRootLevelIndexSize() see HRegionServer#createRegionLoad.
    
    Specified by:
    
    getStoreFileIndexSize in interface RegionMetrics
    
    Returns:
    
    The current total size of root-level indexes for the region
  - getWriteRequestCount
```
public long getWriteRequestCount()
```
    Deprecated.
    
    Specified by:
    
    getWriteRequestCount in interface RegionMetrics
    
    Returns:
    
    the number of write requests made to region
  - getStoreFileRootLevelIndexSize
```
public Size getStoreFileRootLevelIndexSize()
```
    Deprecated.
    
    Specified by:
    
    getStoreFileRootLevelIndexSize in interface RegionMetrics
    
    Returns:
    
    The current total size of root-level indexes for the region
  - getStoreFileUncompressedDataIndexSize
```
public Size getStoreFileUncompressedDataIndexSize()
```
    Deprecated.
    
    Specified by:
    
    getStoreFileUncompressedDataIndexSize in interface RegionMetrics
    
    Returns:
    
    The total size of all index blocks, not just the root level
  - getBloomFilterSize
```
public Size getBloomFilterSize()
```
    Deprecated.
    
    Specified by:
    
    getBloomFilterSize in interface RegionMetrics
    
    Returns:
    
    The total size of all Bloom filter blocks, not just loaded into the block cache
  - getCompactingCellCount
```
public long getCompactingCellCount()
```
    Deprecated.
    
    Specified by:
    
    getCompactingCellCount in interface RegionMetrics
    
    Returns:
    
    the total number of cells in current compaction
  - getCompactedCellCount
```
public long getCompactedCellCount()
```
    Deprecated.
    
    Specified by:
    
    getCompactedCellCount in interface RegionMetrics
    
    Returns:
    
    the number of already compacted kvs in current compaction
  - getCompletedSequenceId
```
public long getCompletedSequenceId()
```
    Deprecated.
    
    Description copied from interface: RegionMetrics
    
    This does not really belong inside RegionLoad but its being done in the name of expediency.
    
    Specified by:
    
    getCompletedSequenceId in interface RegionMetrics
    
    Returns:
    
    the completed sequence Id for the region
  - getStoreSequenceId
```
public Map<byte[],Long> getStoreSequenceId()
```
    Deprecated.
    
    Specified by:
    
    getStoreSequenceId in interface RegionMetrics
    
    Returns:
    
    completed sequence id per store.
  - getUncompressedStoreFileSize
```
public Size getUncompressedStoreFileSize()
```
    Deprecated.
    
    Specified by:
    
    getUncompressedStoreFileSize in interface RegionMetrics
    
    Returns:
    
    the uncompressed size of the storefiles
  - getStores
```
@Deprecated
public int getStores()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreCount() instead.
    
    Returns:
    
    the number of stores
  - getStorefiles
```
@Deprecated
public int getStorefiles()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreFileCount() instead.
    
    Returns:
    
    the number of storefiles
  - getStorefileSizeMB
```
@Deprecated
public int getStorefileSizeMB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreFileSize() instead.
    
    Returns:
    
    the total size of the storefiles, in MB
  - getMemStoreSizeMB
```
@Deprecated
public int getMemStoreSizeMB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getMemStoreSize() instead.
    
    Returns:
    
    the memstore size, in MB
  - getStorefileIndexSizeMB
```
@Deprecated
public int getStorefileIndexSizeMB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 ((HBASE-3935)). Use getStoreFileRootLevelIndexSize() instead.
  - getStorefileIndexSizeKB
```
@Deprecated
public int getStorefileIndexSizeKB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreFileRootLevelIndexSize() instead.
  - getRequestsCount
```
@Deprecated
public long getRequestsCount()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionMetrics.getRequestCount() instead.
    
    Returns:
    
    the number of requests made to region
  - getReadRequestsCount
```
@Deprecated
public long getReadRequestsCount()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getReadRequestCount() instead.
    
    Returns:
    
    the number of read requests made to region
  - getFilteredReadRequestsCount
```
@Deprecated
public long getFilteredReadRequestsCount()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getFilteredReadRequestCount() instead.
    
    Returns:
    
    the number of filtered read requests made to region
  - getWriteRequestsCount
```
@Deprecated
public long getWriteRequestsCount()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getWriteRequestCount() instead.
    
    Returns:
    
    the number of write requests made to region
  - getRootIndexSizeKB
```
@Deprecated
public int getRootIndexSizeKB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreFileRootLevelIndexSize() instead.
    
    Returns:
    
    The current total size of root-level indexes for the region, in KB.
  - getTotalStaticIndexSizeKB
```
@Deprecated
public int getTotalStaticIndexSizeKB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreFileUncompressedDataIndexSize() instead.
    
    Returns:
    
    The total size of all index blocks, not just the root level, in KB.
  - getTotalStaticBloomSizeKB
```
@Deprecated
public int getTotalStaticBloomSizeKB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getBloomFilterSize() instead.
    
    Returns:
    
    The total size of all Bloom filter blocks, not just loaded into the block cache, in KB.
  - getTotalCompactingKVs
```
@Deprecated
public long getTotalCompactingKVs()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getCompactingCellCount() instead.
    
    Returns:
    
    the total number of kvs in current compaction
  - getCurrentCompactedKVs
```
@Deprecated
public long getCurrentCompactedKVs()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getCompactedCellCount() instead.
    
    Returns:
    
    the number of already compacted kvs in current compaction
  - getCompleteSequenceId
```
@Deprecated
public long getCompleteSequenceId()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getCompletedSequenceId() instead.
    
    This does not really belong inside RegionLoad but its being done in the name of expediency.
    
    Returns:
    
    the completed sequence Id for the region
  - getStoreCompleteSequenceId
```
@Deprecated
public List<org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.StoreSequenceId> getStoreCompleteSequenceId()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getStoreSequenceId() instead.
    
    Returns:
    
    completed sequence id per store.
  - getStoreUncompressedSizeMB
```
@Deprecated
public int getStoreUncompressedSizeMB()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getUncompressedStoreFileSize() instead.
    
    Returns:
    
    the uncompressed size of the storefiles in MB.
  - getDataLocality
```
public float getDataLocality()
```
    Deprecated.
    
    Specified by:
    
    getDataLocality in interface RegionMetrics
    
    Returns:
    
    the data locality of region in the regionserver.
  - getLastMajorCompactionTimestamp
```
public long getLastMajorCompactionTimestamp()
```
    Deprecated.
    
    Specified by:
    
    getLastMajorCompactionTimestamp in interface RegionMetrics
    
    Returns:
    
    the timestamp of the oldest hfile for any store of this region.
  - getLastMajorCompactionTs
```
@Deprecated
public long getLastMajorCompactionTs()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use getLastMajorCompactionTimestamp() instead.
    
    Returns:
    
    the timestamp of the oldest hfile for any store of this region.
  - getStoreRefCount
```
public int getStoreRefCount()
```
    Deprecated.
    
    Specified by:
    
    getStoreRefCount in interface RegionMetrics
    
    Returns:
    
    the reference count for the stores of this region
  - getMaxCompactedStoreFileRefCount
```
public int getMaxCompactedStoreFileRefCount()
```
    Deprecated.
    
    Specified by:
    
    getMaxCompactedStoreFileRefCount in interface RegionMetrics
    
    Returns:
    
    the max reference count for any store file among all compacted stores files of this region
  - getDataLocalityForSsd
```
public float getDataLocalityForSsd()
```
    Deprecated.
    
    Description copied from interface: RegionMetrics
    
    Different from dataLocality,this metric's numerator only include the data stored on ssd
    
    Specified by:
    
    getDataLocalityForSsd in interface RegionMetrics
    
    Returns:
    
    the data locality for ssd of region in the regionserver
  - getBlocksLocalWeight
```
public long getBlocksLocalWeight()
```
    Deprecated.
    
    Specified by:
    
    getBlocksLocalWeight in interface RegionMetrics
    
    Returns:
    
    the data at local weight of this region in the regionserver
  - getBlocksLocalWithSsdWeight
```
public long getBlocksLocalWithSsdWeight()
```
    Deprecated.
    
    Description copied from interface: RegionMetrics
    
    Different from blocksLocalWeight,this metric's numerator only include the data stored on ssd
    
    Specified by:
    
    getBlocksLocalWithSsdWeight in interface RegionMetrics
    
    Returns:
    
    the data at local with ssd weight of this region in the regionserver
  - getBlocksTotalWeight
```
public long getBlocksTotalWeight()
```
    Deprecated.
    
    Specified by:
    
    getBlocksTotalWeight in interface RegionMetrics
    
    Returns:
    
    the block total weight of this region
  - getCompactionState
```
public CompactionState getCompactionState()
```
    Deprecated.
    
    Specified by:
    
    getCompactionState in interface RegionMetrics
    
    Returns:
    
    the compaction state of this region
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class RegionLoad

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

regionLoadPB

Constructor Detail

RegionLoad

Method Detail

getName

getRegionName

getStoreCount

getStoreFileCount

getStoreFileSize

getMemStoreSize

getReadRequestCount

getFilteredReadRequestCount

getStoreFileIndexSize

getWriteRequestCount

getStoreFileRootLevelIndexSize

getStoreFileUncompressedDataIndexSize

getBloomFilterSize

getCompactingCellCount

getCompactedCellCount

getCompletedSequenceId

getStoreSequenceId

getUncompressedStoreFileSize

getStores

getStorefiles

getStorefileSizeMB

getMemStoreSizeMB

getStorefileIndexSizeMB

getStorefileIndexSizeKB

getRequestsCount

getReadRequestsCount

getFilteredReadRequestsCount

getWriteRequestsCount

getRootIndexSizeKB

getTotalStaticIndexSizeKB

getTotalStaticBloomSizeKB

getTotalCompactingKVs

getCurrentCompactedKVs

getCompleteSequenceId

getStoreCompleteSequenceId

getStoreUncompressedSizeMB

getDataLocality

getLastMajorCompactionTimestamp

getLastMajorCompactionTs

getStoreRefCount

getMaxCompactedStoreFileRefCount

getDataLocalityForSsd

getBlocksLocalWeight

getBlocksLocalWithSsdWeight

getBlocksTotalWeight

getCompactionState

toString