org.hbase.async

Class RegionLocation

java.lang.Object

org.hbase.async.RegionLocation

public final class RegionLocation
extends Object

A public class that is used to return region hosting information to users via the API. All objects in this class are copies so modifications will not affect the HBase client.

Since:

1.7

Method Summary

Methods

Modifier and Type	Method and Description
String	getHostname() The name of the host currently serving this region.
int	getPort() The port the hosting region server is listening on for RPCs.
byte[]	getRegionName() Returns the full name or ID of the region as used in HBase and displayed in the HBase GUI.
byte[]	getTable() The name of the table that this region pertains to.
byte[]	startKey() The start key for this region.
byte[]	stopKey() The stop key for this region.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

startKey

public byte[] startKey()

The start key for this region. If this is the first (or only) region for the table then the start key may be empty. The key should never be null but may have a length of 0.

Returns:

The start key for the region

stopKey

public byte[] stopKey()

The stop key for this region. If this is the last (or only) region for the table then the stop key may be empty. The key should never be null but may have a length of 0.

Returns:

The stop key for the region

getHostname

public String getHostname()

The name of the host currently serving this region. NOTE: If the region is not hosted, due to a split, move, offline or server failure, then the result may be null.

Returns:

The name of the region server hosting the region or null if the region is offline.

getPort

public int getPort()

The port the hosting region server is listening on for RPCs. NOTE: If the region is not hosted, due to a split, move, offline or server failure, then the result may be 0. See getHostname

Returns:

The port of the hosting server or 0 if the region is offline

getTable

public byte[] getTable()

The name of the table that this region pertains to.

Returns:

The table name for the region.

getRegionName

public byte[] getRegionName()

Returns the full name or ID of the region as used in HBase and displayed in the HBase GUI. The format is as follows: [<namespace>:]<table>,<start_key>,<creation_timestamp>,<md5>

Returns:

The name of the region

toString

public String toString()

Overrides:

toString in class Object