http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html index 3f2f43a..828c5fe 100644 --- a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html +++ b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface 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> +<li><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface 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/RawScanResultConsumer.ScanResumer.html" target="_top">Frames</a></li> @@ -187,7 +187,7 @@ public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface 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> +<li><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface 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/RawScanResultConsumer.ScanResumer.html" target="_top">Frames</a></li>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html b/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html new file mode 100644 index 0000000..90fd52b --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html @@ -0,0 +1,992 @@ +<!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-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-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":17,"i1":6,"i2":6,"i3":17,"i4":17,"i5":17,"i6":17,"i7":17,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":17,"i17":17,"i18":6,"i19":17,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":17,"i28":17,"i29":17,"i30":17,"i31":17,"i32":17,"i33":17}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/RawScanResultConsumer.ScanResumer.html" title="interface 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 Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</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></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></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</div> +</td> +</tr> +<tr id="i1" 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#containsRange-byte:A-byte:A-">containsRange</a></span>(byte[] rangeStartKey, + byte[] rangeEndKey)</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#containsRow-byte:A-">containsRow</a></span>(byte[] row)</code> </td> +</tr> +<tr id="i3" 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="i4" 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="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-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="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-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="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-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="http://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="i8" class="altColor"> +<td class="colFirst"><code><a href="http://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="i9" 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="i10" 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="i11" 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="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#getRegionName--">getRegionName</a></span>()</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="http://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="i14" 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="i15" class="rowColor"> +<td class="colFirst"><code><a href="http://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="i16" class="altColor"> +<td class="colFirst"><code>static <a href="http://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="http://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="i17" class="rowColor"> +<td class="colFirst"><code>static <a href="http://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="i18" 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="i19" 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="i20" 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="i21" 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="i22" 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#isMetaTable--">isMetaTable</a></span>()</code> </td> +</tr> +<tr id="i23" 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> </td> +</tr> +<tr id="i24" 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#isSplit--">isSplit</a></span>()</code> </td> +</tr> +<tr id="i25" 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#isSplitParent--">isSplitParent</a></span>()</code> </td> +</tr> +<tr id="i26" 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#isSystemTable--">isSystemTable</a></span>()</code> </td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>static <a href="http://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="i28" 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="http://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="i29" 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="i30" class="altColor"> +<td class="colFirst"><code>static <a href="http://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="http://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="i31" 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#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="i32" 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>... infos)</code> +<div class="block">Serializes given RegionInfo's as a byte array.</div> +</td> +</tr> +<tr id="i33" 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> 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="http://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.153">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.158">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.164">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="http://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.169">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="http://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.174">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.179">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.184">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.189">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.194">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.199">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.204">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>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.209">isOffline</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if this region is offline.</dd> +</dl> +</li> +</ul> +<a name="isSplitParent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSplitParent</h4> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.214">isSplitParent</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if this is a split parent region.</dd> +</dl> +</li> +</ul> +<a name="isMetaTable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMetaTable</h4> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.219">isMetaTable</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this region is from hbase:meta.</dd> +</dl> +</li> +</ul> +<a name="isSystemTable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSystemTable</h4> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line.224">isSystemTable</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this region is from a system table.</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.229">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.240">containsRange</a>(byte[] rangeStartKey, + byte[] rangeEndKey)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>rangeStartKey</code> - </dd> +<dd><code>rangeEndKey</code> - </dd> +<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="http://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.246">containsRow</a>(byte[] row)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - </dd> +<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="http://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.287">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="http://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.295">getShortNameToLog</a>(<a href="http://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.328">getStartKey</a>(byte[] regionName) + throws <a href="http://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="paramLabel">Parameters:</span></dt> +<dd><code>regionName</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Start key.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://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.416">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</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>regionA</code> - </dd> +<dd><code>regionB</code> - </dd> +<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.438">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="paramLabel">Parameters:</span></dt> +<dd><code>ri</code> - </dd> +<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="http://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.449">prettyPrint</a>(<a href="http://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.465">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>tableName</code> - </dd> +<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.479">createRegionName</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, + byte[] startKey, + <a href="http://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>tableName</code> - </dd> +<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.494">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>tableName</code> - </dd> +<dd><code>startKey</code> - Can be null</dd> +<dd><code>regionid</code> - Region id (Usually timestamp from when region was created).</dd> +<dd><code>replicaId</code> - </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.509">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>tableName</code> - </dd> +<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.523">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>tableName</code> - </dd> +<dd><code>startKey</code> - Can be null</dd> +<dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> +<dd><code>replicaId</code> - </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="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.590">parseRegionName</a>(byte[] regionName) + throws <a href="http://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="paramLabel">Parameters:</span></dt> +<dd><code>regionName</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Array of byte[] containing tableName, startKey and id</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://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.669">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="http://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="http://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.693">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="http://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="paramLabel">Parameters:</span></dt> +<dd><code>ri</code> - </dd> +<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="http://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.705">parseFrom</a>(<a href="http://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="http://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="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An instance of RegionInfo.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://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="blockListLast"> +<li class="blockList"> +<h4>parseDelimitedFrom</h4> +<pre>static <a href="http://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.733">parseDelimitedFrom</a>(byte[] bytes, + int offset, + int length) + throws <a href="http://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="http://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> +</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/RawScanResultConsumer.ScanResumer.html" title="interface 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–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/RegionLoadStats.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RegionLoadStats.html b/apidocs/org/apache/hadoop/hbase/client/RegionLoadStats.html index d835ad6..a817f26 100644 --- a/apidocs/org/apache/hadoop/hbase/client/RegionLoadStats.html +++ b/apidocs/org/apache/hadoop/hbase/client/RegionLoadStats.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -258,7 +258,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/ResultScanner.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/ResultScanner.html b/apidocs/org/apache/hadoop/hbase/client/ResultScanner.html index 1b3933f..66daf5f 100644 --- a/apidocs/org/apache/hadoop/hbase/client/ResultScanner.html +++ b/apidocs/org/apache/hadoop/hbase/client/ResultScanner.html @@ -103,10 +103,6 @@ var activeTableTab = "activeTableTab"; <dt>All Superinterfaces:</dt> <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></dd> </dl> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd>org.apache.hadoop.hbase.client.AbstractClientScanner, <a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html" title="class in org.apache.hadoop.hbase.client">TableSnapshotScanner</a></dd> -</dl> <hr> <br> <pre>@InterfaceAudience.Public http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/Scan.ReadType.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/Scan.ReadType.html b/apidocs/org/apache/hadoop/hbase/client/Scan.ReadType.html index 0d680b2..61e7c85 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Scan.ReadType.html +++ b/apidocs/org/apache/hadoop/hbase/client/Scan.ReadType.html @@ -249,7 +249,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>values</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.ReadType.html#line.61">values</a>()</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.ReadType.html#line.40">values</a>()</pre> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: @@ -269,7 +269,7 @@ for (Scan.ReadType c : Scan.ReadType.values()) <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.ReadType.html#line.61">valueOf</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.ReadType.html#line.40">valueOf</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/TableDescriptorBuilder.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/TableDescriptorBuilder.html b/apidocs/org/apache/hadoop/hbase/client/TableDescriptorBuilder.html index 153681c..3c36a59 100644 --- a/apidocs/org/apache/hadoop/hbase/client/TableDescriptorBuilder.html +++ b/apidocs/org/apache/hadoop/hbase/client/TableDescriptorBuilder.html @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/WrongRowIOException.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/TableDescriptorBuilder.html" target="_top">Frames</a></li> @@ -833,7 +833,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/TableDescript <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/WrongRowIOException.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/TableDescriptorBuilder.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/82166ec2/apidocs/org/apache/hadoop/hbase/client/TableSnapshotScanner.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/TableSnapshotScanner.html b/apidocs/org/apache/hadoop/hbase/client/TableSnapshotScanner.html deleted file mode 100644 index 85fd065..0000000 --- a/apidocs/org/apache/hadoop/hbase/client/TableSnapshotScanner.html +++ /dev/null @@ -1,449 +0,0 @@ -<!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>TableSnapshotScanner (Apache HBase 3.0.0-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="TableSnapshotScanner (Apache HBase 3.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/TableSnapshotScanner.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/TableDescriptorBuilder.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/WrongRowIOException.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/TableSnapshotScanner.html" target="_top">Frames</a></li> -<li><a href="TableSnapshotScanner.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><a href="#fields.inherited.from.class.org.apache.hadoop.hbase.client.AbstractClientScanner">Field</a> | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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="Class TableSnapshotScanner" class="title">Class TableSnapshotScanner</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.hadoop.hbase.client.AbstractClientScanner</li> -<li> -<ul class="inheritance"> -<li>org.apache.hadoop.hbase.client.TableSnapshotScanner</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>, <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></dd> -</dl> -<hr> -<br> -<pre>@InterfaceAudience.Public -public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableSnapshotScanner.html#line.66">TableSnapshotScanner</a> -extends org.apache.hadoop.hbase.client.AbstractClientScanner</pre> -<div class="block">A Scanner which performs a scan over snapshot files. Using this class requires copying the - snapshot to a temporary empty directory, which will copy the snapshot reference files into that - directory. Actual data files are not copied. - - <p> - This also allows one to run the scan from an - online or offline hbase cluster. The snapshot files can be exported by using the - org.apache.hadoop.hbase.snapshot.ExportSnapshot tool, - to a pure-hdfs cluster, and this scanner can be used to - run the scan directly over the snapshot files. The snapshot should not be deleted while there - are open scanners reading from snapshot files. - - <p> - An internal RegionScanner is used to execute the <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> obtained - from the user for each region in the snapshot. - <p> - HBase owns all the data and snapshot files on the filesystem. Only the HBase user can read from - snapshot files and data files. HBase also enforces security because all the requests are handled - by the server layer, and the user cannot read from the data files directly. To read from snapshot - files directly from the file system, the user who is running the MR job must have sufficient - permissions to access snapshot and reference files. This means that to run mapreduce over - snapshot files, the job has to be run as the HBase user or the user must have group or other - priviledges in the filesystem (See HBASE-8369). Note that, given other users access to read from - snapshot/data files will completely circumvent the access control enforced by HBase. - See org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== FIELD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="field.summary"> -<!-- --> -</a> -<h3>Field Summary</h3> -<ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.client.AbstractClientScanner"> -<!-- --> -</a> -<h3>Fields inherited from class org.apache.hadoop.hbase.client.AbstractClientScanner</h3> -<code>scanMetrics</code></li> -</ul> -</li> -</ul> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html#TableSnapshotScanner-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.String-org.apache.hadoop.hbase.client.Scan-">TableSnapshotScanner</a></span>(org.apache.hadoop.conf.Configuration conf, - org.apache.hadoop.fs.Path rootDir, - org.apache.hadoop.fs.Path restoreDir, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> snapshotName, - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code> -<div class="block">Creates a TableSnapshotScanner.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html#TableSnapshotScanner-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-org.apache.hadoop.hbase.client.Scan-">TableSnapshotScanner</a></span>(org.apache.hadoop.conf.Configuration conf, - org.apache.hadoop.fs.Path restoreDir, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> snapshotName, - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code> -<div class="block">Creates a TableSnapshotScanner.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html#close--">close</a></span>()</code> -<div class="block">Closes the scanner and releases any resources it has allocated</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableSnapshotScanner.html#next--">next</a></span>()</code> -<div class="block">Grab the next row's worth of values.</div> -</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/TableSnapshotScanner.html#renewLease--">renewLease</a></span>()</code> -<div class="block">Allow the client to renew the scanner's lease on the server.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.AbstractClientScanner"> -<!-- --> -</a> -<h3>Methods inherited from class org.apache.hadoop.hbase.client.AbstractClientScanner</h3> -<code>getScanMetrics, initScanMetrics</code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.ResultScanner"> -<!-- --> -</a> -<h3>Methods inherited from interface org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></h3> -<code><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#iterator--">iterator</a>, <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#next-int-">next</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> -<!-- --> -</a> -<h3>Methods inherited from interface java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-"; title="class or interface in java.lang">forEach</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--"; title="class or interface in java.lang">spliterator</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="TableSnapshotScanner-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-org.apache.hadoop.hbase.client.Scan-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>TableSnapshotScanner</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableSnapshotScanner.html#line.92">TableSnapshotScanner</a>(org.apache.hadoop.conf.Configuration conf, - org.apache.hadoop.fs.Path restoreDir, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> snapshotName, - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan) - throws <a href="http://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">Creates a TableSnapshotScanner.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>conf</code> - the configuration</dd> -<dd><code>restoreDir</code> - a temporary directory to copy the snapshot files into. Current user should - have write permissions to this directory, and this should not be a subdirectory of rootdir. - The scanner deletes the contents of the directory once the scanner is closed.</dd> -<dd><code>snapshotName</code> - the name of the snapshot to read from</dd> -<dd><code>scan</code> - a Scan representing scan parameters</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - in case of error</dd> -</dl> -</li> -</ul> -<a name="TableSnapshotScanner-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.String-org.apache.hadoop.hbase.client.Scan-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>TableSnapshotScanner</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableSnapshotScanner.html#line.108">TableSnapshotScanner</a>(org.apache.hadoop.conf.Configuration conf, - org.apache.hadoop.fs.Path rootDir, - org.apache.hadoop.fs.Path restoreDir, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> snapshotName, - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan) - throws <a href="http://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">Creates a TableSnapshotScanner.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>conf</code> - the configuration</dd> -<dd><code>rootDir</code> - root directory for HBase.</dd> -<dd><code>restoreDir</code> - a temporary directory to copy the snapshot files into. Current user should - have write permissions to this directory, and this should not be a subdirectory of rootdir. - The scanner deletes the contents of the directory once the scanner is closed.</dd> -<dd><code>snapshotName</code> - the name of the snapshot to read from</dd> -<dd><code>scan</code> - a Scan representing scan parameters</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - in case of error</dd> -</dl> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="next--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>next</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableSnapshotScanner.html#line.144">next</a>() - throws <a href="http://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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#next--">ResultScanner</a></code></span></div> -<div class="block">Grab the next row's worth of values. The scanner will return a Result.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>Result object if there is another row, null if the scanner is exhausted.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - e</dd> -</dl> -</li> -</ul> -<a name="close--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>close</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableSnapshotScanner.html#line.176">close</a>()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#close--">ResultScanner</a></code></span></div> -<div class="block">Closes the scanner and releases any resources it has allocated</div> -</li> -</ul> -<a name="renewLease--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>renewLease</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableSnapshotScanner.html#line.188">renewLease</a>()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#renewLease--">ResultScanner</a></code></span></div> -<div class="block">Allow the client to renew the scanner's lease on the server.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if the lease was successfully renewed, false otherwise.</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/TableSnapshotScanner.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/TableDescriptorBuilder.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/WrongRowIOException.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/TableSnapshotScanner.html" target="_top">Frames</a></li> -<li><a href="TableSnapshotScanner.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><a href="#fields.inherited.from.class.org.apache.hadoop.hbase.client.AbstractClientScanner">Field</a> | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> -</html>
