| <!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>ScannerModel (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="ScannerModel (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ScannerModel.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/rest/model/RowModel.html" title="class in org.apache.hadoop.hbase.rest.model"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.FilterModel.html" title="class in org.apache.hadoop.hbase.rest.model"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/rest/model/ScannerModel.html" target="_top">Frames</a></li> |
| <li><a href="ScannerModel.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">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><a href="#field.detail">Field</a> | </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.rest.model</div> |
| <h2 title="Class ScannerModel" class="title">Class ScannerModel</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://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.rest.model.ScannerModel</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html" title="interface in org.apache.hadoop.hbase.rest">ProtobufMessageHandler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public class <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.106">ScannerModel</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html" title="interface in org.apache.hadoop.hbase.rest">ProtobufMessageHandler</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">A representation of Scanner parameters. |
| |
| <pre> |
| <complexType name="Scanner"> |
| <sequence> |
| <element name="column" type="base64Binary" minOccurs="0" maxOccurs="unbounded"/> |
| <element name="filter" type="string" minOccurs="0" maxOccurs="1"></element> |
| </sequence> |
| <attribute name="startRow" type="base64Binary"></attribute> |
| <attribute name="endRow" type="base64Binary"></attribute> |
| <attribute name="batch" type="int"></attribute> |
| <attribute name="caching" type="int"></attribute> |
| <attribute name="startTime" type="int"></attribute> |
| <attribute name="endTime" type="int"></attribute> |
| <attribute name="maxVersions" type="int"></attribute> |
| </complexType> |
| </pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.hadoop.hbase.rest.model.ScannerModel">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>(package private) static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.FilterModel.html" title="class in org.apache.hadoop.hbase.rest.model">ScannerModel.FilterModel</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.JaxbJsonProviderHolder.html" title="class in org.apache.hadoop.hbase.rest.model">ScannerModel.JaxbJsonProviderHolder</a></span></code> |
| <div class="block">Implement lazily-instantiated singleton as per recipe |
| here: http://literatejava.com/jvm/fastest-threadsafe-singleton-jvm/</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#batch">batch</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#cacheBlocks">cacheBlocks</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#caching">caching</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#COLUMN_DIVIDER">COLUMN_DIVIDER</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private <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><byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#columns">columns</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#endRow">endRow</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#endTime">endTime</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private <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/rest/model/ScannerModel.html#filter">filter</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private <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="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/rest/model/ScannerModel.html#labels">labels</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#limit">limit</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#maxVersions">maxVersions</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#serialVersionUID">serialVersionUID</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#startRow">startRow</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#startTime">startTime</a></span></code> </td> |
| </tr> |
| </table> |
| </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/rest/model/ScannerModel.html#ScannerModel--">ScannerModel</a></span>()</code> |
| <div class="block">Default constructor</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#ScannerModel-byte:A-byte:A-java.util.List-int-int-long-int-java.lang.String-">ScannerModel</a></span>(byte[] startRow, |
| byte[] endRow, |
| <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><byte[]> columns, |
| int batch, |
| int caching, |
| long endTime, |
| int maxVersions, |
| <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> filter)</code> |
| <div class="block">Constructor</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#ScannerModel-byte:A-byte:A-java.util.List-int-int-long-long-java.lang.String-">ScannerModel</a></span>(byte[] startRow, |
| byte[] endRow, |
| <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><byte[]> columns, |
| int batch, |
| int caching, |
| long startTime, |
| long endTime, |
| <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> filter)</code> |
| <div class="block">Constructor</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="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="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/rest/model/ScannerModel.html#addColumn-byte:A-">addColumn</a></span>(byte[] column)</code> |
| <div class="block">Add a column to the column set</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#addLabel-java.lang.String-">addLabel</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> label)</code> |
| <div class="block">Add a visibility label to the scan</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#buildFilter-java.lang.String-">buildFilter</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> s)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#createProtobufOutput--">createProtobufOutput</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html" title="class in org.apache.hadoop.hbase.rest.model">ScannerModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#fromScan-org.apache.hadoop.hbase.client.Scan-">fromScan</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getBatch--">getBatch</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getCacheBlocks--">getCacheBlocks</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getCaching--">getCaching</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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><byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getColumns--">getColumns</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/rest/model/ScannerModel.html#getEndRow--">getEndRow</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getEndTime--">getEndTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" 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/rest/model/ScannerModel.html#getFilter--">getFilter</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>private static com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getJasonProvider--">getJasonProvider</a></span>()</code> |
| <div class="block">Get the <code>JacksonJaxbJsonProvider</code> instance;</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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="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/rest/model/ScannerModel.html#getLabels--">getLabels</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/rest/model/ScannerModel.html#getLimit--">getLimit</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getMaxVersions--">getMaxVersions</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html" title="interface in org.apache.hadoop.hbase.rest">ProtobufMessageHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getObjectFromMessage-byte:A-">getObjectFromMessage</a></span>(byte[] message)</code> |
| <div class="block">Initialize the model from a protobuf representation.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getStartRow--">getStartRow</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#getStartTime--">getStartTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#hasEndRow--">hasEndRow</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#hasStartRow--">hasStartRow</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setBatch-int-">setBatch</a></span>(int batch)</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setCacheBlocks-boolean-">setCacheBlocks</a></span>(boolean value)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setCaching-int-">setCaching</a></span>(int caching)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setColumns-java.util.List-">setColumns</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><byte[]> columns)</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setEndRow-byte:A-">setEndRow</a></span>(byte[] endRow)</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setEndTime-long-">setEndTime</a></span>(long endTime)</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setFilter-java.lang.String-">setFilter</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> filter)</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setLimit-int-">setLimit</a></span>(int limit)</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setMaxVersions-int-">setMaxVersions</a></span>(int maxVersions)</code> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setStartRow-byte:A-">setStartRow</a></span>(byte[] startRow)</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html#setStartTime-long-">setStartTime</a></span>(long startTime)</code> </td> |
| </tr> |
| <tr id="i32" 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/rest/model/ScannerModel.html#stringifyFilter-org.apache.hadoop.hbase.filter.Filter-">stringifyFilter</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</code> </td> |
| </tr> |
| </table> |
| <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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="serialVersionUID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialVersionUID</h4> |
| <pre>private static final long <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.108">serialVersionUID</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.rest.model.ScannerModel.serialVersionUID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startRow"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startRow</h4> |
| <pre>private byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.110">startRow</a></pre> |
| </li> |
| </ul> |
| <a name="endRow"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endRow</h4> |
| <pre>private byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.111">endRow</a></pre> |
| </li> |
| </ul> |
| <a name="columns"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columns</h4> |
| <pre>private <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><byte[]> <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.112">columns</a></pre> |
| </li> |
| </ul> |
| <a name="batch"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>batch</h4> |
| <pre>private int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.113">batch</a></pre> |
| </li> |
| </ul> |
| <a name="startTime"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startTime</h4> |
| <pre>private long <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.114">startTime</a></pre> |
| </li> |
| </ul> |
| <a name="endTime"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endTime</h4> |
| <pre>private long <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.115">endTime</a></pre> |
| </li> |
| </ul> |
| <a name="filter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filter</h4> |
| <pre>private <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/rest/model/ScannerModel.html#line.116">filter</a></pre> |
| </li> |
| </ul> |
| <a name="maxVersions"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxVersions</h4> |
| <pre>private int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.117">maxVersions</a></pre> |
| </li> |
| </ul> |
| <a name="caching"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>caching</h4> |
| <pre>private int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.118">caching</a></pre> |
| </li> |
| </ul> |
| <a name="labels"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>labels</h4> |
| <pre>private <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="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/rest/model/ScannerModel.html#line.119">labels</a></pre> |
| </li> |
| </ul> |
| <a name="cacheBlocks"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cacheBlocks</h4> |
| <pre>private boolean <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.120">cacheBlocks</a></pre> |
| </li> |
| </ul> |
| <a name="limit"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>limit</h4> |
| <pre>private int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.121">limit</a></pre> |
| </li> |
| </ul> |
| <a name="COLUMN_DIVIDER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>COLUMN_DIVIDER</h4> |
| <pre>private static final byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.510">COLUMN_DIVIDER</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ScannerModel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ScannerModel</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.567">ScannerModel</a>()</pre> |
| <div class="block">Default constructor</div> |
| </li> |
| </ul> |
| <a name="ScannerModel-byte:A-byte:A-java.util.List-int-int-long-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ScannerModel</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.581">ScannerModel</a>(byte[] startRow, |
| byte[] endRow, |
| <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><byte[]> columns, |
| int batch, |
| int caching, |
| long endTime, |
| int maxVersions, |
| <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> filter)</pre> |
| <div class="block">Constructor</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startRow</code> - the start key of the row-range</dd> |
| <dd><code>endRow</code> - the end key of the row-range</dd> |
| <dd><code>columns</code> - the columns to scan</dd> |
| <dd><code>batch</code> - the number of values to return in batch</dd> |
| <dd><code>caching</code> - the number of rows that the scanner will fetch at once</dd> |
| <dd><code>endTime</code> - the upper bound on timestamps of values of interest</dd> |
| <dd><code>maxVersions</code> - the maximum number of versions to return</dd> |
| <dd><code>filter</code> - a filter specification |
| (values with timestamps later than this are excluded)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ScannerModel-byte:A-byte:A-java.util.List-int-int-long-long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ScannerModel</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.607">ScannerModel</a>(byte[] startRow, |
| byte[] endRow, |
| <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><byte[]> columns, |
| int batch, |
| int caching, |
| long startTime, |
| long endTime, |
| <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> filter)</pre> |
| <div class="block">Constructor</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startRow</code> - the start key of the row-range</dd> |
| <dd><code>endRow</code> - the end key of the row-range</dd> |
| <dd><code>columns</code> - the columns to scan</dd> |
| <dd><code>batch</code> - the number of values to return in batch</dd> |
| <dd><code>caching</code> - the number of rows that the scanner will fetch at once</dd> |
| <dd><code>startTime</code> - the lower bound on timestamps of values of interest |
| (values with timestamps earlier than this are excluded)</dd> |
| <dd><code>endTime</code> - the upper bound on timestamps of values of interest |
| (values with timestamps later than this are excluded)</dd> |
| <dd><code>filter</code> - a filter specification</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="getJasonProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJasonProvider</h4> |
| <pre>private static com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.485">getJasonProvider</a>()</pre> |
| <div class="block">Get the <code>JacksonJaxbJsonProvider</code> instance;</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>JacksonJaxbJsonProvider</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildFilter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildFilter</h4> |
| <pre>public static <a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.494">buildFilter</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> s) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - the JSON representation of the filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stringifyFilter-org.apache.hadoop.hbase.filter.Filter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stringifyFilter</h4> |
| <pre>public 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/rest/model/ScannerModel.html#line.505">stringifyFilter</a>(<a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JSON representation of the filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromScan-org.apache.hadoop.hbase.client.Scan-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromScan</h4> |
| <pre>public static <a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.html" title="class in org.apache.hadoop.hbase.rest.model">ScannerModel</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.516">fromScan</a>(<a href="../../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scan</code> - the scan specification</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addColumn-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumn</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.624">addColumn</a>(byte[] column)</pre> |
| <div class="block">Add a column to the column set</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>column</code> - the column name, as <column>(:<qualifier>)?</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLabel-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLabel</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.631">addLabel</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> label)</pre> |
| <div class="block">Add a visibility label to the scan</div> |
| </li> |
| </ul> |
| <a name="hasStartRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasStartRow</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.637">hasStartRow</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if a start row was specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartRow</h4> |
| <pre>public byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.645">getStartRow</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>start row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasEndRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasEndRow</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.652">hasEndRow</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if an end row was specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndRow</h4> |
| <pre>public byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.660">getEndRow</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>end row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumns--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumns</h4> |
| <pre>public <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><byte[]> <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.668">getColumns</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of columns of interest in column:qualifier format, or empty for all</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLabels--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLabels</h4> |
| <pre>public <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="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/rest/model/ScannerModel.html#line.673">getLabels</a>()</pre> |
| </li> |
| </ul> |
| <a name="getBatch--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatch</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.681">getBatch</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of cells to return in batch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCaching--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCaching</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.689">getCaching</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of rows that the scanner to fetch at once</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLimit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLimit</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.697">getLimit</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the limit specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheBlocks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheBlocks</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.705">getCacheBlocks</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if HFile blocks should be cached on the servers for this scan, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartTime</h4> |
| <pre>public long <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.713">getStartTime</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the lower bound on timestamps of items of interest</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndTime</h4> |
| <pre>public long <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.721">getEndTime</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the upper bound on timestamps of items of interest</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxVersions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxVersions</h4> |
| <pre>public int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.729">getMaxVersions</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum number of versions to return</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilter</h4> |
| <pre>public <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/rest/model/ScannerModel.html#line.737">getFilter</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStartRow-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStartRow</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.744">setStartRow</a>(byte[] startRow)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startRow</code> - start row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEndRow-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEndRow</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.751">setEndRow</a>(byte[] endRow)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endRow</code> - end row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setColumns-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumns</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.758">setColumns</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><byte[]> columns)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columns</code> - list of columns of interest in column:qualifier format, or empty for all</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBatch-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBatch</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.765">setBatch</a>(int batch)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>batch</code> - the number of cells to return in batch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCaching-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCaching</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.772">setCaching</a>(int caching)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>caching</code> - the number of rows to fetch at once</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheBlocks-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheBlocks</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.779">setCacheBlocks</a>(boolean value)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - true if HFile blocks should be cached on the servers for this scan, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLimit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLimit</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.786">setLimit</a>(int limit)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>limit</code> - the number of rows can fetch of each scanner at lifetime</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxVersions-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxVersions</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.793">setMaxVersions</a>(int maxVersions)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxVersions</code> - maximum number of versions to return</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStartTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStartTime</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.800">setStartTime</a>(long startTime)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startTime</code> - the lower bound on timestamps of values of interest</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEndTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEndTime</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.807">setEndTime</a>(long endTime)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endTime</code> - the upper bound on timestamps of values of interest</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFilter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilter</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.814">setFilter</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> filter)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the filter specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createProtobufOutput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createProtobufOutput</h4> |
| <pre>public byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.819">createProtobufOutput</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html#createProtobufOutput--">createProtobufOutput</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html" title="interface in org.apache.hadoop.hbase.rest">ProtobufMessageHandler</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the protobuf represention of the model</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectFromMessage-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getObjectFromMessage</h4> |
| <pre>public <a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html" title="interface in org.apache.hadoop.hbase.rest">ProtobufMessageHandler</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/model/ScannerModel.html#line.856">getObjectFromMessage</a>(byte[] message) |
| 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html#getObjectFromMessage-byte:A-">ProtobufMessageHandler</a></code></span></div> |
| <div class="block">Initialize the model from a protobuf representation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html#getObjectFromMessage-byte:A-">getObjectFromMessage</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/rest/ProtobufMessageHandler.html" title="interface in org.apache.hadoop.hbase.rest">ProtobufMessageHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the raw bytes of the protobuf message</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>reference to self for convenience</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> |
| </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/ScannerModel.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/rest/model/RowModel.html" title="class in org.apache.hadoop.hbase.rest.model"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/rest/model/ScannerModel.FilterModel.html" title="class in org.apache.hadoop.hbase.rest.model"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/rest/model/ScannerModel.html" target="_top">Frames</a></li> |
| <li><a href="ScannerModel.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">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><a href="#field.detail">Field</a> | </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–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |