OnlineRegions (Apache HBase 1.2.12 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Abortable, Server, Stoppable

All Known Subinterfaces:

RegionServerServices

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster, HRegionServer
```
@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
@InterfaceStability.Evolving
public interface OnlineRegions
extends Server
```
Interface to Map of online regions. In the Map, the key is the region's encoded name and the value is an Region instance.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToOnlineRegions(Region r)` Add to online regions.
`Region`	`getFromOnlineRegions(String encodedRegionName)` Return `Region` instance.
`List<Region>`	`getOnlineRegions(TableName tableName)` Get all online regions of a table in this RS.
`boolean`	`removeFromOnlineRegions(Region r, ServerName destination)` This method removes Region corresponding to hri from the Map of onlineRegions.

Methods inherited from interface org.apache.hadoop.hbase.Server
getChoreService, getConfiguration, getConnection, getCoordinatedStateManager, getMetaTableLocator, getServerName, getZooKeeper

Methods inherited from interface org.apache.hadoop.hbase.Abortable
abort, isAborted

Methods inherited from interface org.apache.hadoop.hbase.Stoppable
isStopped, stop

- Method Detail
  - addToOnlineRegions
```
void addToOnlineRegions(Region r)
```
    Add to online regions.
    
    Parameters:
    r -
  - removeFromOnlineRegions
```
boolean removeFromOnlineRegions(Region r,
                              ServerName destination)
```
    This method removes Region corresponding to hri from the Map of onlineRegions.
    
    Parameters:
    r - Region to remove.
    destination - Destination, if any, null otherwise.
    
    Returns:
    True if we removed a region from online list.
  - getFromOnlineRegions
```
Region getFromOnlineRegions(String encodedRegionName)
```
    Return Region instance. Only works if caller is in same context, in same JVM. Region is not serializable.
    
    Parameters:
    encodedRegionName -
    
    Returns:
    Region for the passed encoded encodedRegionName or null if named region is not member of the online regions.
  - getOnlineRegions
```
List<Region> getOnlineRegions(TableName tableName)
                              throws IOException
```
    Get all online regions of a table in this RS.
    
    Parameters:
    tableName -
    
    Returns:
    List of Region
    
    Throws:
    
    IOException

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.