| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RegionInfo (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RegionInfo (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":17,"i1":18,"i2":6,"i3":6,"i4":17,"i5":17,"i6":17,"i7":17,"i8":17,"i9":17,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":17,"i19":17,"i20":6,"i21":17,"i22":6,"i23":18,"i24":18,"i25":18,"i26":18,"i27":6,"i28":18,"i29":38,"i30":18,"i31":6,"i32":38,"i33":17,"i34":17,"i35":17,"i36":17,"i37":17,"i38":17,"i39":17,"i40":17}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RegionInfo.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/RegionLoadStats.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/RegionInfo.html" target="_top">Frames</a></li> |
| <li><a href="RegionInfo.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.client</div> |
| <h2 title="Interface RegionInfo" class="title">Interface RegionInfo</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.69">RegionInfo</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></pre> |
| <div class="block">Information about a region. A region is a range of keys in the whole keyspace |
| of a table, an identifier (a timestamp) for differentiating between subset |
| ranges (after region split) and a replicaId for differentiating the instance |
| for the same range and some status information about the region. |
| |
| The region has a unique name which consists of the following fields: |
| <ul> |
| <li> tableName : The name of the table </li> |
| <li> startKey : The startKey for the region. </li> |
| <li> regionId : A timestamp when the region is created. </li> |
| <li> replicaId : An id starting from 0 to differentiate replicas of the |
| same region range but hosted in separated servers. The same region range can |
| be hosted in multiple locations.</li> |
| <li> encodedName : An MD5 encoded string for the region name.</li> |
| </ul> |
| |
| <br> Other than the fields in the region name, region info contains: |
| <ul> |
| <li> endKey : the endKey for the region (exclusive) </li> |
| <li> split : Whether the region is split </li> |
| <li> offline : Whether the region is offline </li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#areAdjacent-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.hbase.client.RegionInfo-">areAdjacent</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionA, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionB)</code> |
| <div class="block">Check whether two regions are adjacent; i.e.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#compareTo-org.apache.hadoop.hbase.client.RegionInfo-">compareTo</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#containsRange-byte:A-byte:A-">containsRange</a></span>(byte[] rangeStartKey, |
| byte[] rangeEndKey)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#containsRow-byte:A-">containsRow</a></span>(byte[] row)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#createMobRegionInfo-org.apache.hadoop.hbase.TableName-">createMobRegionInfo</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> |
| <div class="block">Creates a RegionInfo object for MOB data.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#createRegionName-org.apache.hadoop.hbase.TableName-byte:A-byte:A-boolean-">createRegionName</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| boolean newFormat)</code> |
| <div class="block">Make a region name of passed parameters.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#createRegionName-org.apache.hadoop.hbase.TableName-byte:A-byte:A-int-boolean-">createRegionName</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| int replicaId, |
| boolean newFormat)</code> |
| <div class="block">Make a region name of passed parameters.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#createRegionName-org.apache.hadoop.hbase.TableName-byte:A-long-boolean-">createRegionName</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| boolean newFormat)</code> |
| <div class="block">Make a region name of passed parameters.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#createRegionName-org.apache.hadoop.hbase.TableName-byte:A-long-int-boolean-">createRegionName</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| int replicaId, |
| boolean newFormat)</code> |
| <div class="block">Make a region name of passed parameters.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#createRegionName-org.apache.hadoop.hbase.TableName-byte:A-java.lang.String-boolean-">createRegionName</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| boolean newFormat)</code> |
| <div class="block">Make a region name of passed parameters.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getEncodedName--">getEncodedName</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getEncodedNameAsBytes--">getEncodedNameAsBytes</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getEndKey--">getEndKey</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getRegionId--">getRegionId</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getRegionName--">getRegionName</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getRegionNameAsString--">getRegionNameAsString</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getReplicaId--">getReplicaId</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getShortNameToLog--">getShortNameToLog</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getShortNameToLog-java.util.List-">getShortNameToLog</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> ris)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getShortNameToLog-org.apache.hadoop.hbase.client.RegionInfo...-">getShortNameToLog</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... hris)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getStartKey--">getStartKey</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getStartKey-byte:A-">getStartKey</a></span>(byte[] regionName)</code> |
| <div class="block">Gets the start key from the specified region name.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getTable--">getTable</a></span>()</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isAdjacent-org.apache.hadoop.hbase.client.RegionInfo-">isAdjacent</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isDegenerate--">isDegenerate</a></span>()</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isFirst--">isFirst</a></span>()</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isLast--">isLast</a></span>()</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isMetaRegion--">isMetaRegion</a></span>()</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isNext-org.apache.hadoop.hbase.client.RegionInfo-">isNext</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> after)</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isOffline--">isOffline</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 3.0.0 and will be removed in 4.0.0</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isOverlap-org.apache.hadoop.hbase.client.RegionInfo-">isOverlap</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isSplit--">isSplit</a></span>()</code> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isSplitParent--">isSplitParent</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 3.0.0 and will be removed in 4.0.0, Use <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isSplit--"><code>isSplit()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#parseDelimitedFrom-byte:A-int-int-">parseDelimitedFrom</a></span>(byte[] bytes, |
| int offset, |
| int length)</code> |
| <div class="block">Parses all the RegionInfo instances from the passed in stream until EOF.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#parseFrom-java.io.DataInputStream-">parseFrom</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInputStream.html?is-external=true" title="class or interface in java.io">DataInputStream</a> in)</code> |
| <div class="block">Parses an RegionInfo instance from the passed in stream.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>static byte[][]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#parseRegionName-byte:A-">parseRegionName</a></span>(byte[] regionName)</code> |
| <div class="block">Separate elements of a regionName.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>static byte[][]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#parseRegionNameOrReturnNull-byte:A-">parseRegionNameOrReturnNull</a></span>(byte[] regionName)</code> |
| <div class="block">Separate elements of a regionName.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#prettyPrint-java.lang.String-">prettyPrint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encodedRegionName)</code> |
| <div class="block">Use logging.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toByteArray-org.apache.hadoop.hbase.client.RegionInfo-">toByteArray</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</code> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toDelimitedByteArray-org.apache.hadoop.hbase.client.RegionInfo...-">toDelimitedByteArray</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... infos)</code> |
| <div class="block">Serializes given RegionInfo's as a byte array.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toDelimitedByteArray-org.apache.hadoop.hbase.client.RegionInfo-">toDelimitedByteArray</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</code> |
| <div class="block">Use this instead of <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toByteArray-org.apache.hadoop.hbase.client.RegionInfo-"><code>toByteArray(RegionInfo)</code></a> when writing to a stream and you want to use |
| the pb mergeDelimitedFrom (w/o the delimiter, pb reads to EOF which may not be what you want).</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getShortNameToLog--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShortNameToLog</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.167">getShortNameToLog</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Return a short, printable name for this region |
| (usually encoded name) for us logging.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionId</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.172">getRegionId</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the regionId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionName</h4> |
| <pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.178">getRegionName</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the regionName as an array of bytes.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#getRegionNameAsString--"><code>getRegionNameAsString()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionNameAsString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionNameAsString</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.183">getRegionNameAsString</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Region name as a String for use in logging, etc.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncodedName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncodedName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.188">getEncodedName</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the encoded region name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncodedNameAsBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncodedNameAsBytes</h4> |
| <pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.193">getEncodedNameAsBytes</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the encoded region name as an array of bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartKey</h4> |
| <pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.198">getStartKey</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the startKey.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndKey</h4> |
| <pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.203">getEndKey</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the endKey.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTable</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.208">getTable</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current table name of the region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReplicaId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReplicaId</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.213">getReplicaId</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns region replica id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSplit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSplit</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.218">isSplit</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if has been split and has daughters.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isOffline--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOffline</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.226">isOffline</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 3.0.0 and will be removed in 4.0.0</span></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this region is offline.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://issues.apache.org/jira/browse/HBASE-25210">HBASE-25210</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSplitParent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSplitParent</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.234">isSplitParent</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 3.0.0 and will be removed in 4.0.0, Use <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isSplit--"><code>isSplit()</code></a> instead.</span></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this is a split parent region.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://issues.apache.org/jira/browse/HBASE-25210">HBASE-25210</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMetaRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMetaRegion</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.239">isMetaRegion</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this region is a meta region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="containsRange-byte:A-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsRange</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.248">containsRange</a>(byte[] rangeStartKey, |
| byte[] rangeEndKey)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the given inclusive range of rows is fully contained |
| by this region. For example, if the region is foo,a,g and this is |
| passed ["b","c"] or ["a","c"] it will return true, but if this is passed |
| ["b","z"] it will return false.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the range passed is invalid (ie. end < start)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="containsRow-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsRow</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.253">containsRow</a>(byte[] row)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the given row falls in this region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getShortNameToLog-org.apache.hadoop.hbase.client.RegionInfo...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShortNameToLog</h4> |
| <pre>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.314">getShortNameToLog</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... hris)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Return a String of short, printable names for <code>hris</code> |
| (usually encoded name) for us logging.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getShortNameToLog-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShortNameToLog</h4> |
| <pre>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.322">getShortNameToLog</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> ris)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Return a String of short, printable names for <code>hris</code> (usually encoded name) |
| for us logging.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartKey-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartKey</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.355">getStartKey</a>(byte[] regionName) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets the start key from the specified region name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Start key.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="areAdjacent-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areAdjacent</h4> |
| <pre>static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.449">areAdjacent</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionA, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionB)</pre> |
| <div class="block">Check whether two regions are adjacent; i.e. lies just before or just |
| after in a table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if two regions are adjacent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toByteArray-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.470">toByteArray</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This instance serialized as protobuf w/ a magic pb prefix.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#parseFrom-byte:A-"><code>parseFrom(byte[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prettyPrint-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prettyPrint</h4> |
| <pre>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.481">prettyPrint</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encodedRegionName)</pre> |
| <div class="block">Use logging.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedRegionName</code> - The encoded regionname.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>hbase:meta</code> if passed <code>1028785192</code> else returns |
| <code>encodedRegionName</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRegionName-org.apache.hadoop.hbase.TableName-byte:A-long-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRegionName</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.496">createRegionName</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| boolean newFormat)</pre> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>regionid</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format |
| (such that it contains its encoded name?).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Region name made of passed tableName, startKey and id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRegionName-org.apache.hadoop.hbase.TableName-byte:A-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRegionName</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.509">createRegionName</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| boolean newFormat)</pre> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format |
| (such that it contains its encoded name?).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Region name made of passed tableName, startKey and id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRegionName-org.apache.hadoop.hbase.TableName-byte:A-long-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRegionName</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.522">createRegionName</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| int replicaId, |
| boolean newFormat)</pre> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>regionid</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format |
| (such that it contains its encoded name?).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Region name made of passed tableName, startKey, id and replicaId</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRegionName-org.apache.hadoop.hbase.TableName-byte:A-byte:A-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRegionName</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.536">createRegionName</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| boolean newFormat)</pre> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format |
| (such that it contains its encoded name?).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Region name made of passed tableName, startKey and id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRegionName-org.apache.hadoop.hbase.TableName-byte:A-byte:A-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRegionName</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.548">createRegionName</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| int replicaId, |
| boolean newFormat)</pre> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Region name made of passed tableName, startKey, id and replicaId</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMobRegionInfo-org.apache.hadoop.hbase.TableName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMobRegionInfo</h4> |
| <pre>static <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.615">createMobRegionInfo</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</pre> |
| <div class="block">Creates a RegionInfo object for MOB data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableName</code> - the name of the table</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the MOB <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseRegionName-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRegionName</h4> |
| <pre>static byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.627">parseRegionName</a>(byte[] regionName) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Separate elements of a regionName.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of byte[] containing tableName, startKey and id OR null if |
| not parseable as a region name.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if not parseable as regionName.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseRegionNameOrReturnNull-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRegionNameOrReturnNull</h4> |
| <pre>static byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.644">parseRegionNameOrReturnNull</a>(byte[] regionName)</pre> |
| <div class="block">Separate elements of a regionName. |
| Region name is of the format: |
| <code>tablename,startkey,regionIdTimestamp[_replicaId][.encodedName.]</code>. |
| Startkey can contain the delimiter (',') so we parse from the start and then parse from |
| the end.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of byte[] containing tableName, startKey and id OR null if not parseable |
| as a region name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDelimitedByteArray-org.apache.hadoop.hbase.client.RegionInfo...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDelimitedByteArray</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.714">toDelimitedByteArray</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... infos) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Serializes given RegionInfo's as a byte array. Use this instead of |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toByteArray-org.apache.hadoop.hbase.client.RegionInfo-"><code>toByteArray(RegionInfo)</code></a> when |
| writing to a stream and you want to use the pb mergeDelimitedFrom (w/o the delimiter, pb reads |
| to EOF which may not be what you want). <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#parseDelimitedFrom-byte:A-int-int-"><code>parseDelimitedFrom(byte[], int, int)</code></a> can |
| be used to read back the instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>infos</code> - RegionInfo objects to serialize</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This instance serialized as a delimited protobuf w/ a magic pb prefix.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDelimitedByteArray-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDelimitedByteArray</h4> |
| <pre>static byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.736">toDelimitedByteArray</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Use this instead of <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toByteArray-org.apache.hadoop.hbase.client.RegionInfo-"><code>toByteArray(RegionInfo)</code></a> when writing to a stream and you want to use |
| the pb mergeDelimitedFrom (w/o the delimiter, pb reads to EOF which may not be what you want).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This instance serialized as a delimied protobuf w/ a magic pb prefix.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseFrom-java.io.DataInputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseFrom</h4> |
| <pre>static <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.746">parseFrom</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInputStream.html?is-external=true" title="class or interface in java.io">DataInputStream</a> in) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Parses an RegionInfo instance from the passed in stream. |
| Presumes the RegionInfo was serialized to the stream with |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#toDelimitedByteArray-org.apache.hadoop.hbase.client.RegionInfo-"><code>toDelimitedByteArray(RegionInfo)</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An instance of RegionInfo.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseDelimitedFrom-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseDelimitedFrom</h4> |
| <pre>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.772">parseDelimitedFrom</a>(byte[] bytes, |
| int offset, |
| int length) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Parses all the RegionInfo instances from the passed in stream until EOF. Presumes the |
| RegionInfo's were serialized to the stream with oDelimitedByteArray()</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - serialized bytes</dd> |
| <dd><code>offset</code> - the start offset into the byte[] buffer</dd> |
| <dd><code>length</code> - how far we should read into the byte[] buffer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>All the RegionInfos that are in the byte array. Keeps reading till we hit the end.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFirst--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFirst</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.791">isFirst</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this is first Region in Table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLast--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLast</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.798">isLast</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this is last Region in Table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNext-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNext</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.807">isNext</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> after)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if region is next, adjacent but 'after' this one.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isAdjacent-org.apache.hadoop.hbase.client.RegionInfo-"><code>isAdjacent(RegionInfo)</code></a>, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#areAdjacent-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.hbase.client.RegionInfo-"><code>areAdjacent(RegionInfo, RegionInfo)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAdjacent-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAdjacent</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.815">isAdjacent</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if region is adjacent, either just before or just after this one.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isNext-org.apache.hadoop.hbase.client.RegionInfo-"><code>isNext(RegionInfo)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDegenerate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDegenerate</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.822">isDegenerate</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if RegionInfo is degenerate... if startKey > endKey.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isOverlap-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOverlap</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.830">isOverlap</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if an overlap in region range.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html#isDegenerate--"><code>isDegenerate()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareTo-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre>default int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.853">compareTo</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RegionInfo.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/RegionLoadStats.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/RegionInfo.html" target="_top">Frames</a></li> |
| <li><a href="RegionInfo.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |