http://git-wip-us.apache.org/repos/asf/kudu/blob/76a99b4c/apidocs/org/apache/kudu/client/KuduScanner.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/KuduScanner.html b/apidocs/org/apache/kudu/client/KuduScanner.html index b02a4e0..5a2c8ba 100644 --- a/apidocs/org/apache/kudu/client/KuduScanner.html +++ b/apidocs/org/apache/kudu/client/KuduScanner.html @@ -2,38 +2,24 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>KuduScanner (Kudu 1.0.0 API)</title> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>KuduScanner (Kudu 1.0.1 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="KuduScanner (Kudu 1.0.0 API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KuduScanner (Kudu 1.0.1 API)"; } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -49,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/KuduPredicate.ComparisonOp.html" title="enum in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduPredicate.ComparisonOp.html" title="enum in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduScanner.html" target="_top">Frames</a></li> -<li><a href="KuduScanner.html" target="_top">No Frames</a></li> +<li><a href="KuduScanner.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -74,19 +60,19 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -110,8 +96,8 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public - @InterfaceStability.Evolving -public class <span class="typeNameLabel">KuduScanner</span> [email protected] +public class <span class="strong">KuduScanner</span> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Synchronous version of <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner</code></a>. Offers the same API but with blocking methods.</div> </li> @@ -122,11 +108,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> +<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"> +<table class="overviewSummary" 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> @@ -134,7 +120,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client">KuduScanner.KuduScannerBuilder</a></span></code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client">KuduScanner.KuduScannerBuilder</a></strong></code> <div class="block">A Builder class to build <a href="../../../../org/apache/kudu/client/KuduScanner.html" title="class in org.apache.kudu.client"><code>KuduScanner</code></a>.</div> </td> </tr> @@ -143,71 +129,71 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/RowResultIterator.html" title="class in org.apache.kudu.client">RowResultIterator</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#close--">close</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#close()">close</a></strong>()</code> <div class="block">Closes this scanner (don't forget to call this when you're done with it!).</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#getBatchSizeBytes--">getBatchSizeBytes</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#getBatchSizeBytes()">getBatchSizeBytes</a></strong>()</code> <div class="block">Returns the maximum number of bytes returned by the scanner, on each batch.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#getCacheBlocks--">getCacheBlocks</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#getCacheBlocks()">getCacheBlocks</a></strong>()</code> <div class="block">Returns if this scanner was configured to cache data blocks or not.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#getLimit--">getLimit</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#getLimit()">getLimit</a></strong>()</code> <div class="block">Returns the maximum number of rows that this scanner was configured to return.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu">Schema</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#getProjectionSchema--">getProjectionSchema</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#getProjectionSchema()">getProjectionSchema</a></strong>()</code> <div class="block">Returns the projection schema of this scanner.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#getReadMode--">getReadMode</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#getReadMode()">getReadMode</a></strong>()</code> <div class="block">Returns the ReadMode for this scanner.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#hasMoreRows--">hasMoreRows</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#hasMoreRows()">hasMoreRows</a></strong>()</code> <div class="block">Tells if the last rpc returned that there might be more rows to scan.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/RowResultIterator.html" title="class in org.apache.kudu.client">RowResultIterator</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduScanner.html#nextRows--">nextRows</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduScanner.html#nextRows()">nextRows</a></strong>()</code> <div class="block">Scans a number of rows.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -219,11 +205,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="hasMoreRows--"> +<a name="hasMoreRows()"> <!-- --> </a> <ul class="blockList"> @@ -231,13 +217,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>hasMoreRows</h4> <pre>public boolean hasMoreRows()</pre> <div class="block">Tells if the last rpc returned that there might be more rows to scan.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if there might be more data to scan, else false</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if there might be more data to scan, else false</dd></dl> </li> </ul> -<a name="nextRows--"> +<a name="nextRows()"> <!-- --> </a> <ul class="blockList"> @@ -250,15 +233,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? Once this method returns <code>null</code> once (which indicates that this <code>Scanner</code> is done scanning), calling it again leads to an undefined behavior.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a list of rows.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a list of rows.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="close--"> +<a name="close()"> <!-- --> </a> <ul class="blockList"> @@ -269,15 +249,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="block">Closes this scanner (don't forget to call this when you're done with it!). <p> Closing a scanner already closed has no effect.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a deferred object that indicates the completion of the request</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a deferred object that indicates the completion of the request</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="getLimit--"> +<a name="getLimit()"> <!-- --> </a> <ul class="blockList"> @@ -285,13 +262,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getLimit</h4> <pre>public long getLimit()</pre> <div class="block">Returns the maximum number of rows that this scanner was configured to return.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a long representing the maximum number of rows that can be returned</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a long representing the maximum number of rows that can be returned</dd></dl> </li> </ul> -<a name="getCacheBlocks--"> +<a name="getCacheBlocks()"> <!-- --> </a> <ul class="blockList"> @@ -299,13 +273,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getCacheBlocks</h4> <pre>public boolean getCacheBlocks()</pre> <div class="block">Returns if this scanner was configured to cache data blocks or not.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if this scanner will cache blocks, else else.</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if this scanner will cache blocks, else else.</dd></dl> </li> </ul> -<a name="getBatchSizeBytes--"> +<a name="getBatchSizeBytes()"> <!-- --> </a> <ul class="blockList"> @@ -313,14 +284,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getBatchSizeBytes</h4> <pre>public long getBatchSizeBytes()</pre> <div class="block">Returns the maximum number of bytes returned by the scanner, on each batch.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a long representing the maximum number of bytes that a scanner can receive at once - from a tablet server</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a long representing the maximum number of bytes that a scanner can receive at once + from a tablet server</dd></dl> </li> </ul> -<a name="getReadMode--"> +<a name="getReadMode()"> <!-- --> </a> <ul class="blockList"> @@ -328,13 +296,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getReadMode</h4> <pre>public <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a> getReadMode()</pre> <div class="block">Returns the ReadMode for this scanner.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the configured read mode for this scanner</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the configured read mode for this scanner</dd></dl> </li> </ul> -<a name="getProjectionSchema--"> +<a name="getProjectionSchema()"> <!-- --> </a> <ul class="blockListLast"> @@ -343,10 +308,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <pre>public <a href="../../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu">Schema</a> getProjectionSchema()</pre> <div class="block">Returns the projection schema of this scanner. If specific columns were not specified during scanner creation, the table schema is returned.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the projection schema for this scanner</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the projection schema for this scanner</dd></dl> </li> </ul> </li> @@ -357,11 +319,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -377,15 +337,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/KuduPredicate.ComparisonOp.html" title="enum in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduPredicate.ComparisonOp.html" title="enum in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduScanner.html" target="_top">Frames</a></li> -<li><a href="KuduScanner.html" target="_top">No Frames</a></li> +<li><a href="KuduScanner.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -402,19 +362,19 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</a></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> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
http://git-wip-us.apache.org/repos/asf/kudu/blob/76a99b4c/apidocs/org/apache/kudu/client/KuduSession.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/KuduSession.html b/apidocs/org/apache/kudu/client/KuduSession.html index a1947bf..2bcf488 100644 --- a/apidocs/org/apache/kudu/client/KuduSession.html +++ b/apidocs/org/apache/kudu/client/KuduSession.html @@ -2,38 +2,24 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>KuduSession (Kudu 1.0.0 API)</title> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>KuduSession (Kudu 1.0.1 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="KuduSession (Kudu 1.0.0 API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KuduSession (Kudu 1.0.1 API)"; } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":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"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -49,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduSession.html" target="_top">Frames</a></li> -<li><a href="KuduSession.html" target="_top">No Frames</a></li> +<li><a href="KuduSession.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -75,18 +61,18 @@ var activeTableTab = "activeTableTab"; <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#field.summary">Field</a> | </li> +<li><a href="#field_summary">Field</a> | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</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="#field_detail">Field</a> | </li> <li>Constr | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -114,8 +100,8 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public - @InterfaceStability.Evolving -public class <span class="typeNameLabel">KuduSession</span> [email protected] +public class <span class="strong">KuduSession</span> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></pre> <div class="block">Synchronous version of <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client"><code>AsyncKuduSession</code></a>. @@ -124,8 +110,8 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html This class is <b>not</b> thread-safe.<p> A major difference with <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client"><code>AsyncKuduSession</code></a> is that the time spent waiting on operations is - defined by <a href="../../../../org/apache/kudu/client/KuduSession.html#setTimeoutMillis-long-"><code>setTimeoutMillis(long)</code></a> which defaults to getting it from - <a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultOperationTimeoutMs--"><code>KuduClient.getDefaultOperationTimeoutMs()</code></a>.</div> + defined by <a href="../../../../org/apache/kudu/client/KuduSession.html#setTimeoutMillis(long)"><code>setTimeoutMillis(long)</code></a> which defaults to getting it from + <a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultOperationTimeoutMs()"><code>KuduClient.getDefaultOperationTimeoutMs()</code></a>.</div> </li> </ul> </div> @@ -134,12 +120,12 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> +<li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <ul class="blockList"> -<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.kudu.client.SessionConfiguration"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.kudu.client.SessionConfiguration"> <!-- --> </a> <h3>Nested classes/interfaces inherited from interface org.apache.kudu.client.<a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></h3> @@ -149,11 +135,11 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.summary"> +<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"> +<table class="overviewSummary" 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> @@ -161,133 +147,133 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html </tr> <tr class="altColor"> <td class="colFirst"><code>static org.slf4j.Logger</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#LOG">LOG</a></span></code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#LOG">LOG</a></strong></code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/OperationResponse.html" title="class in org.apache.kudu.client">OperationResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#apply-org.apache.kudu.client.Operation-">apply</a></span>(<a href="../../../../org/apache/kudu/client/Operation.html" title="class in org.apache.kudu.client">Operation</a> operation)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#apply(org.apache.kudu.client.Operation)">apply</a></strong>(<a href="../../../../org/apache/kudu/client/Operation.html" title="class in org.apache.kudu.client">Operation</a> operation)</code> <div class="block">Blocking call with a different behavior based on the flush mode.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/kudu/client/OperationResponse.html" title="class in org.apache.kudu.client">OperationResponse</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#close--">close</a></span>()</code> -<div class="block">Blocking call that flushes the buffers (see <a href="../../../../org/apache/kudu/client/KuduSession.html#flush--"><code>flush()</code></a> and closes the sessions.</div> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#close()">close</a></strong>()</code> +<div class="block">Blocking call that flushes the buffers (see <a href="../../../../org/apache/kudu/client/KuduSession.html#flush()"><code>flush()</code></a> and closes the sessions.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#countPendingErrors--">countPendingErrors</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#countPendingErrors()">countPendingErrors</a></strong>()</code> <div class="block">Return the number of errors which are pending.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/kudu/client/OperationResponse.html" title="class in org.apache.kudu.client">OperationResponse</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#flush--">flush</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#flush()">flush</a></strong>()</code> <div class="block">Blocking call that force flushes this session's buffers.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.FlushMode.html" title="enum in org.apache.kudu.client">SessionConfiguration.FlushMode</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#getFlushMode--">getFlushMode</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#getFlushMode()">getFlushMode</a></strong>()</code> <div class="block">Get the current flush mode.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/RowErrorsAndOverflowStatus.html" title="class in org.apache.kudu.client">RowErrorsAndOverflowStatus</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#getPendingErrors--">getPendingErrors</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#getPendingErrors()">getPendingErrors</a></strong>()</code> <div class="block">Return any errors from previous calls.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#getTimeoutMillis--">getTimeoutMillis</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#getTimeoutMillis()">getTimeoutMillis</a></strong>()</code> <div class="block">Get the current timeout.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#hasPendingOperations--">hasPendingOperations</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#hasPendingOperations()">hasPendingOperations</a></strong>()</code> <div class="block">Check if there are operations that haven't been completely applied.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#isClosed--">isClosed</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#isClosed()">isClosed</a></strong>()</code> <div class="block">Returns true if this session has already been closed.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#isIgnoreAllDuplicateRows--">isIgnoreAllDuplicateRows</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#isIgnoreAllDuplicateRows()">isIgnoreAllDuplicateRows</a></strong>()</code> <div class="block">Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the AlreadyPresent type.</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setExternalConsistencyMode-org.apache.kudu.client.ExternalConsistencyMode-">setExternalConsistencyMode</a></span>(<a href="../../../../org/apache/kudu/client/ExternalConsistencyMode.html" title="enum in org.apache.kudu.client">ExternalConsistencyMode</a> consistencyMode)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setExternalConsistencyMode(org.apache.kudu.client.ExternalConsistencyMode)">setExternalConsistencyMode</a></strong>(<a href="../../../../org/apache/kudu/client/ExternalConsistencyMode.html" title="enum in org.apache.kudu.client">ExternalConsistencyMode</a> consistencyMode)</code> <div class="block">Set the new external consistency mode for this session.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setFlushInterval-int-">setFlushInterval</a></span>(int interval)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setFlushInterval(int)">setFlushInterval</a></strong>(int interval)</code> <div class="block">Set the flush interval, which will be used for the next scheduling decision.</div> </td> </tr> -<tr id="i12" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setFlushMode-org.apache.kudu.client.SessionConfiguration.FlushMode-">setFlushMode</a></span>(<a href="../../../../org/apache/kudu/client/SessionConfiguration.FlushMode.html" title="enum in org.apache.kudu.client">SessionConfiguration.FlushMode</a> flushMode)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setFlushMode(org.apache.kudu.client.SessionConfiguration.FlushMode)">setFlushMode</a></strong>(<a href="../../../../org/apache/kudu/client/SessionConfiguration.FlushMode.html" title="enum in org.apache.kudu.client">SessionConfiguration.FlushMode</a> flushMode)</code> <div class="block">Set the new flush mode for this session.</div> </td> </tr> -<tr id="i13" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setIgnoreAllDuplicateRows-boolean-">setIgnoreAllDuplicateRows</a></span>(boolean ignoreAllDuplicateRows)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setIgnoreAllDuplicateRows(boolean)">setIgnoreAllDuplicateRows</a></strong>(boolean ignoreAllDuplicateRows)</code> <div class="block">Configures the option to ignore all the row errors if they are all of the AlreadyPresent type.</div> </td> </tr> -<tr id="i14" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setMutationBufferLowWatermark-float-">setMutationBufferLowWatermark</a></span>(float mutationBufferLowWatermarkPercentage)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setMutationBufferLowWatermark(float)">setMutationBufferLowWatermark</a></strong>(float mutationBufferLowWatermarkPercentage)</code> <div class="block">Set the low watermark for this session.</div> </td> </tr> -<tr id="i15" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setMutationBufferSpace-int-">setMutationBufferSpace</a></span>(int size)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setMutationBufferSpace(int)">setMutationBufferSpace</a></strong>(int size)</code> <div class="block">Set the number of operations that can be buffered.</div> </td> </tr> -<tr id="i16" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduSession.html#setTimeoutMillis-long-">setTimeoutMillis</a></span>(long timeout)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduSession.html#setTimeoutMillis(long)">setTimeoutMillis</a></strong>(long timeout)</code> <div class="block">Sets the timeout for the next applied operations.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -299,7 +285,7 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.detail"> +<li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> @@ -316,11 +302,11 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="apply-org.apache.kudu.client.Operation-"> +<a name="apply(org.apache.kudu.client.Operation)"> <!-- --> </a> <ul class="blockList"> @@ -329,7 +315,7 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html <pre>public <a href="../../../../org/apache/kudu/client/OperationResponse.html" title="class in org.apache.kudu.client">OperationResponse</a> apply(<a href="../../../../org/apache/kudu/client/Operation.html" title="class in org.apache.kudu.client">Operation</a> operation) throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Blocking call with a different behavior based on the flush mode. PleaseThrottleException is - managed by this method and will not be thrown, unlike <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html#apply-org.apache.kudu.client.Operation-"><code>AsyncKuduSession.apply(org.apache.kudu.client.Operation)</code></a>. + managed by this method and will not be thrown, unlike <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html#apply(org.apache.kudu.client.Operation)"><code>AsyncKuduSession.apply(org.apache.kudu.client.Operation)</code></a>. <p> <ul> <li>AUTO_FLUSH_SYNC: the call returns when the operation is persisted, @@ -337,22 +323,18 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html <li>AUTO_FLUSH_BACKGROUND: the call returns when the operation has been added to the buffer. This call should normally perform only fast in-memory operations but it may have to wait when the buffer is full and there's another buffer being flushed. Row - errors can be checked by calling <a href="../../../../org/apache/kudu/client/KuduSession.html#countPendingErrors--"><code>countPendingErrors()</code></a> and can be retrieved by calling - <a href="../../../../org/apache/kudu/client/KuduSession.html#getPendingErrors--"><code>getPendingErrors()</code></a>. + errors can be checked by calling <a href="../../../../org/apache/kudu/client/KuduSession.html#countPendingErrors()"><code>countPendingErrors()</code></a> and can be retrieved by calling + <a href="../../../../org/apache/kudu/client/KuduSession.html#getPendingErrors()"><code>getPendingErrors()</code></a>. <li>MANUAL_FLUSH: the call returns when the operation has been added to the buffer, else it throws a KuduException if the buffer is full. </ul></div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>operation</code> - operation to apply</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an OperationResponse for the applied Operation</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>operation</code> - operation to apply</dd> +<dt><span class="strong">Returns:</span></dt><dd>an OperationResponse for the applied Operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="flush--"> +<a name="flush()"> <!-- --> </a> <ul class="blockList"> @@ -362,15 +344,12 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Blocking call that force flushes this session's buffers. Data is persisted when this call returns, else it will throw an exception.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a list of OperationResponse, one per operation that was flushed</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a list of OperationResponse, one per operation that was flushed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="close--"> +<a name="close()"> <!-- --> </a> <ul class="blockList"> @@ -378,263 +357,234 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html <h4>close</h4> <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/kudu/client/OperationResponse.html" title="class in org.apache.kudu.client">OperationResponse</a>> close() throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> -<div class="block">Blocking call that flushes the buffers (see <a href="../../../../org/apache/kudu/client/KuduSession.html#flush--"><code>flush()</code></a> and closes the sessions.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>List of OperationResponse, one per operation that was flushed</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<div class="block">Blocking call that flushes the buffers (see <a href="../../../../org/apache/kudu/client/KuduSession.html#flush()"><code>flush()</code></a> and closes the sessions.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>List of OperationResponse, one per operation that was flushed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="getFlushMode--"> +<a name="getFlushMode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFlushMode</h4> <pre>public <a href="../../../../org/apache/kudu/client/SessionConfiguration.FlushMode.html" title="enum in org.apache.kudu.client">SessionConfiguration.FlushMode</a> getFlushMode()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getFlushMode--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getFlushMode()">SessionConfiguration</a></code></strong></div> <div class="block">Get the current flush mode.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getFlushMode--">getFlushMode</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>flush mode, AUTO_FLUSH_SYNC by default</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getFlushMode()">getFlushMode</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>flush mode, AUTO_FLUSH_SYNC by default</dd></dl> </li> </ul> -<a name="setFlushMode-org.apache.kudu.client.SessionConfiguration.FlushMode-"> +<a name="setFlushMode(org.apache.kudu.client.SessionConfiguration.FlushMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setFlushMode</h4> <pre>public void setFlushMode(<a href="../../../../org/apache/kudu/client/SessionConfiguration.FlushMode.html" title="enum in org.apache.kudu.client">SessionConfiguration.FlushMode</a> flushMode)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushMode-org.apache.kudu.client.SessionConfiguration.FlushMode-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushMode(org.apache.kudu.client.SessionConfiguration.FlushMode)">SessionConfiguration</a></code></strong></div> <div class="block">Set the new flush mode for this session.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushMode-org.apache.kudu.client.SessionConfiguration.FlushMode-">setFlushMode</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>flushMode</code> - new flush mode, can be the same as the previous one.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushMode(org.apache.kudu.client.SessionConfiguration.FlushMode)">setFlushMode</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>flushMode</code> - new flush mode, can be the same as the previous one.</dd></dl> </li> </ul> -<a name="setMutationBufferSpace-int-"> +<a name="setMutationBufferSpace(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setMutationBufferSpace</h4> <pre>public void setMutationBufferSpace(int size)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferSpace-int-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferSpace(int)">SessionConfiguration</a></code></strong></div> <div class="block">Set the number of operations that can be buffered.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferSpace-int-">setMutationBufferSpace</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>size</code> - number of ops.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferSpace(int)">setMutationBufferSpace</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - number of ops.</dd></dl> </li> </ul> -<a name="setMutationBufferLowWatermark-float-"> +<a name="setMutationBufferLowWatermark(float)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setMutationBufferLowWatermark</h4> <pre>public void setMutationBufferLowWatermark(float mutationBufferLowWatermarkPercentage)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferLowWatermark-float-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferLowWatermark(float)">SessionConfiguration</a></code></strong></div> <div class="block">Set the low watermark for this session. The default is set to half the mutation buffer space. For example, a buffer space of 1000 with a low watermark set to 50% (0.5) will start randomly sending PleaseRetryExceptions once there's an outstanding flush and the buffer is over 500. As the buffer gets fuller, it becomes likelier to hit the exception.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferLowWatermark-float-">setMutationBufferLowWatermark</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>mutationBufferLowWatermarkPercentage</code> - a new low watermark as a percentage, +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setMutationBufferLowWatermark(float)">setMutationBufferLowWatermark</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>mutationBufferLowWatermarkPercentage</code> - a new low watermark as a percentage, has to be between 0 and 1 (inclusive). A value of 1 disables - the low watermark since it's the same as the high one</dd> -</dl> + the low watermark since it's the same as the high one</dd></dl> </li> </ul> -<a name="setFlushInterval-int-"> +<a name="setFlushInterval(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setFlushInterval</h4> <pre>public void setFlushInterval(int interval)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushInterval-int-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushInterval(int)">SessionConfiguration</a></code></strong></div> <div class="block">Set the flush interval, which will be used for the next scheduling decision.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushInterval-int-">setFlushInterval</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>interval</code> - interval in milliseconds.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setFlushInterval(int)">setFlushInterval</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - interval in milliseconds.</dd></dl> </li> </ul> -<a name="getTimeoutMillis--"> +<a name="getTimeoutMillis()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTimeoutMillis</h4> <pre>public long getTimeoutMillis()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getTimeoutMillis--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getTimeoutMillis()">SessionConfiguration</a></code></strong></div> <div class="block">Get the current timeout.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getTimeoutMillis--">getTimeoutMillis</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>operation timeout in milliseconds, 0 if none was configured.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getTimeoutMillis()">getTimeoutMillis</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>operation timeout in milliseconds, 0 if none was configured.</dd></dl> </li> </ul> -<a name="setTimeoutMillis-long-"> +<a name="setTimeoutMillis(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setTimeoutMillis</h4> <pre>public void setTimeoutMillis(long timeout)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setTimeoutMillis-long-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setTimeoutMillis(long)">SessionConfiguration</a></code></strong></div> <div class="block">Sets the timeout for the next applied operations. The default timeout is 0, which disables the timeout functionality.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setTimeoutMillis-long-">setTimeoutMillis</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>timeout</code> - Timeout in milliseconds.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setTimeoutMillis(long)">setTimeoutMillis</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Timeout in milliseconds.</dd></dl> </li> </ul> -<a name="isClosed--"> +<a name="isClosed()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isClosed</h4> <pre>public boolean isClosed()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isClosed--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isClosed()">SessionConfiguration</a></code></strong></div> <div class="block">Returns true if this session has already been closed.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isClosed--">isClosed</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isClosed()">isClosed</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> </dl> </li> </ul> -<a name="hasPendingOperations--"> +<a name="hasPendingOperations()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasPendingOperations</h4> <pre>public boolean hasPendingOperations()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#hasPendingOperations--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#hasPendingOperations()">SessionConfiguration</a></code></strong></div> <div class="block">Check if there are operations that haven't been completely applied.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#hasPendingOperations--">hasPendingOperations</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if operations are pending, else false.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#hasPendingOperations()">hasPendingOperations</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if operations are pending, else false.</dd></dl> </li> </ul> -<a name="setExternalConsistencyMode-org.apache.kudu.client.ExternalConsistencyMode-"> +<a name="setExternalConsistencyMode(org.apache.kudu.client.ExternalConsistencyMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setExternalConsistencyMode</h4> <pre>public void setExternalConsistencyMode(<a href="../../../../org/apache/kudu/client/ExternalConsistencyMode.html" title="enum in org.apache.kudu.client">ExternalConsistencyMode</a> consistencyMode)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setExternalConsistencyMode-org.apache.kudu.client.ExternalConsistencyMode-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setExternalConsistencyMode(org.apache.kudu.client.ExternalConsistencyMode)">SessionConfiguration</a></code></strong></div> <div class="block">Set the new external consistency mode for this session.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setExternalConsistencyMode-org.apache.kudu.client.ExternalConsistencyMode-">setExternalConsistencyMode</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>consistencyMode</code> - new external consistency mode, can the same as the previous one.</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setExternalConsistencyMode(org.apache.kudu.client.ExternalConsistencyMode)">setExternalConsistencyMode</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>consistencyMode</code> - new external consistency mode, can the same as the previous one.</dd></dl> </li> </ul> -<a name="isIgnoreAllDuplicateRows--"> +<a name="isIgnoreAllDuplicateRows()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isIgnoreAllDuplicateRows</h4> <pre>public boolean isIgnoreAllDuplicateRows()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isIgnoreAllDuplicateRows--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isIgnoreAllDuplicateRows()">SessionConfiguration</a></code></strong></div> <div class="block">Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the AlreadyPresent type.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isIgnoreAllDuplicateRows--">isIgnoreAllDuplicateRows</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if the session is enforcing this, else false</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#isIgnoreAllDuplicateRows()">isIgnoreAllDuplicateRows</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the session is enforcing this, else false</dd></dl> </li> </ul> -<a name="setIgnoreAllDuplicateRows-boolean-"> +<a name="setIgnoreAllDuplicateRows(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setIgnoreAllDuplicateRows</h4> <pre>public void setIgnoreAllDuplicateRows(boolean ignoreAllDuplicateRows)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setIgnoreAllDuplicateRows-boolean-">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setIgnoreAllDuplicateRows(boolean)">SessionConfiguration</a></code></strong></div> <div class="block">Configures the option to ignore all the row errors if they are all of the AlreadyPresent type. This can be needed when facing KUDU-568. The effect of enabling this is that operation responses that match this pattern will be cleared of their row errors, meaning that we consider them successful. This is disabled by default.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setIgnoreAllDuplicateRows-boolean-">setIgnoreAllDuplicateRows</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>ignoreAllDuplicateRows</code> - true if this session should enforce this, else false</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#setIgnoreAllDuplicateRows(boolean)">setIgnoreAllDuplicateRows</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>ignoreAllDuplicateRows</code> - true if this session should enforce this, else false</dd></dl> </li> </ul> -<a name="countPendingErrors--"> +<a name="countPendingErrors()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>countPendingErrors</h4> <pre>public int countPendingErrors()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#countPendingErrors--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#countPendingErrors()">SessionConfiguration</a></code></strong></div> <div class="block">Return the number of errors which are pending. Errors may accumulate when using the AUTO_FLUSH_BACKGROUND mode.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#countPendingErrors--">countPendingErrors</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a count of errors</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#countPendingErrors()">countPendingErrors</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a count of errors</dd></dl> </li> </ul> -<a name="getPendingErrors--"> +<a name="getPendingErrors()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getPendingErrors</h4> <pre>public <a href="../../../../org/apache/kudu/client/RowErrorsAndOverflowStatus.html" title="class in org.apache.kudu.client">RowErrorsAndOverflowStatus</a> getPendingErrors()</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getPendingErrors--">SessionConfiguration</a></code></span></div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getPendingErrors()">SessionConfiguration</a></code></strong></div> <div class="block">Return any errors from previous calls. If there were more errors than could be held in the session's error storage, the overflow state is set to true. Resets the pending errors.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getPendingErrors--">getPendingErrors</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an object that contains the errors and the overflow status</dd> -</dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html#getPendingErrors()">getPendingErrors</a></code> in interface <code><a href="../../../../org/apache/kudu/client/SessionConfiguration.html" title="interface in org.apache.kudu.client">SessionConfiguration</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an object that contains the errors and the overflow status</dd></dl> </li> </ul> </li> @@ -645,11 +595,9 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -665,15 +613,15 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduSession.html" target="_top">Frames</a></li> -<li><a href="KuduSession.html" target="_top">No Frames</a></li> +<li><a href="KuduSession.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -691,18 +639,18 @@ implements <a href="../../../../org/apache/kudu/client/SessionConfiguration.html <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#field.summary">Field</a> | </li> +<li><a href="#field_summary">Field</a> | </li> <li>Constr | </li> -<li><a href="#method.summary">Method</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="#field_detail">Field</a> | </li> <li>Constr | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
