blob: dcdf0e1885918cdecd9976a7021e482cfd7f7ff8 [file] [log] [blame]
<!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>org.kududb.client (Kudu 0.5.0 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="org.kududb.client (Kudu 0.5.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/kududb/annotations/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../org/kududb/mapreduce/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kududb/client/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.kududb.client</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/HasFailedRpcException.html" title="interface in org.kududb.client">HasFailedRpcException</a></td>
<td class="colLast">
<div class="block">Interface implemented by <a href="../../../org/kududb/client/KuduException.html" title="class in org.kududb.client"><code>KuduException</code></a>s that can tell you which
RPC failed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/SessionConfiguration.html" title="interface in org.kududb.client">SessionConfiguration</a></td>
<td class="colLast">
<div class="block">Interface that defines the methods used to configure a session.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/AbstractKuduScannerBuilder.html" title="class in org.kududb.client">AbstractKuduScannerBuilder</a>&lt;S extends <a href="../../../org/kududb/client/AbstractKuduScannerBuilder.html" title="class in org.kududb.client">AbstractKuduScannerBuilder</a>&lt;? super S,T&gt;,T&gt;</td>
<td class="colLast">
<div class="block">Abstract class to extend in order to create builders for scanners.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/AlterTableBuilder.html" title="class in org.kududb.client">AlterTableBuilder</a></td>
<td class="colLast">
<div class="block">This builder must be used to alter a table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/AlterTableResponse.html" title="class in org.kududb.client">AlterTableResponse</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/AsyncKuduClient.html" title="class in org.kududb.client">AsyncKuduClient</a></td>
<td class="colLast">
<div class="block">A fully asynchronous and thread-safe client for Kudu.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/AsyncKuduScanner.html" title="class in org.kududb.client">AsyncKuduScanner</a></td>
<td class="colLast">
<div class="block">Creates a scanner to read data from Kudu.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/AsyncKuduSession.html" title="class in org.kududb.client">AsyncKuduSession</a></td>
<td class="colLast">
<div class="block">A AsyncKuduSession belongs to a specific AsyncKuduClient, and represents a context in
which all read/write data access should take place.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/ColumnRangePredicate.html" title="class in org.kududb.client">ColumnRangePredicate</a></td>
<td class="colLast">
<div class="block">A range predicate on one of the columns in the underlying data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/CreateTableBuilder.html" title="class in org.kududb.client">CreateTableBuilder</a></td>
<td class="colLast">
<div class="block">This is a builder class for all the options that can be provided while creating a table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/Delete.html" title="class in org.kududb.client">Delete</a></td>
<td class="colLast">
<div class="block">Class of Operation for whole row removals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/DeleteTableResponse.html" title="class in org.kududb.client">DeleteTableResponse</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/Insert.html" title="class in org.kududb.client">Insert</a></td>
<td class="colLast">
<div class="block">Represents a single row insert.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/IsAlterTableDoneResponse.html" title="class in org.kududb.client">IsAlterTableDoneResponse</a></td>
<td class="colLast">
<div class="block">Response to a isAlterTableDone command to use to know if an alter table is currently running on
the specified table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduClient.html" title="class in org.kududb.client">KuduClient</a></td>
<td class="colLast">
<div class="block">A synchronous and thread-safe client for Kudu.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduScanner.html" title="class in org.kududb.client">KuduScanner</a></td>
<td class="colLast">
<div class="block">Synchronous version of <a href="../../../org/kududb/client/AsyncKuduScanner.html" title="class in org.kududb.client"><code>AsyncKuduScanner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduScanner.KuduScannerBuilder.html" title="class in org.kududb.client">KuduScanner.KuduScannerBuilder</a></td>
<td class="colLast">
<div class="block">A Builder class to build <a href="../../../org/kududb/client/KuduScanner.html" title="class in org.kududb.client"><code>KuduScanner</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduSession.html" title="class in org.kududb.client">KuduSession</a></td>
<td class="colLast">
<div class="block">Synchronous version of <a href="../../../org/kududb/client/AsyncKuduSession.html" title="class in org.kududb.client"><code>AsyncKuduSession</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a></td>
<td class="colLast">
<div class="block">A KuduTable represents a table on a particular cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/ListTabletServersResponse.html" title="class in org.kududb.client">ListTabletServersResponse</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/LocatedTablet.html" title="class in org.kududb.client">LocatedTablet</a></td>
<td class="colLast">
<div class="block">Information about the locations of tablets in a Kudu table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/LocatedTablet.Replica.html" title="class in org.kududb.client">LocatedTablet.Replica</a></td>
<td class="colLast">
<div class="block">One of the replicas of the tablet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/Operation.html" title="class in org.kududb.client">Operation</a></td>
<td class="colLast">
<div class="block">Base class for the RPCs that related to WriteRequestPB.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/OperationResponse.html" title="class in org.kududb.client">OperationResponse</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/PartialRow.html" title="class in org.kududb.client">PartialRow</a></td>
<td class="colLast">
<div class="block">Class used to represent parts of row along with its schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/RowError.html" title="class in org.kududb.client">RowError</a></td>
<td class="colLast">
<div class="block">Wrapper class for a single row error.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/RowResult.html" title="class in org.kududb.client">RowResult</a></td>
<td class="colLast">
<div class="block">RowResult represents one row from a scanner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/RowResultIterator.html" title="class in org.kududb.client">RowResultIterator</a></td>
<td class="colLast">
<div class="block">Class that contains the rows sent by a tablet server, exhausting this iterator only means
that all the rows from the last server response were read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/Update.html" title="class in org.kududb.client">Update</a></td>
<td class="colLast">
<div class="block">Operation to update columns on an existing row</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/AsyncKuduScanner.ReadMode.html" title="enum in org.kududb.client">AsyncKuduScanner.ReadMode</a></td>
<td class="colLast">
<div class="block">The possible read modes for scanners.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/ExternalConsistencyMode.html" title="enum in org.kududb.client">ExternalConsistencyMode</a></td>
<td class="colLast">
<div class="block">The possible external consistency modes on which Kudu operates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/SessionConfiguration.FlushMode.html" title="enum in org.kududb.client">SessionConfiguration.FlushMode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/ConnectionResetException.html" title="class in org.kududb.client">ConnectionResetException</a></td>
<td class="colLast">
<div class="block">Exception thrown when an RPC was in flight while we got disconnected.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/InvalidResponseException.html" title="class in org.kududb.client">InvalidResponseException</a></td>
<td class="colLast">
<div class="block">Exception used when the server sends an invalid response to an RPC.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduException.html" title="class in org.kududb.client">KuduException</a></td>
<td class="colLast">
<div class="block">The parent class of all <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a> created by this package.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/KuduServerException.html" title="class in org.kududb.client">KuduServerException</a></td>
<td class="colLast">
<div class="block">This class is used for errors sent in response to a RPC.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/MasterErrorException.html" title="class in org.kududb.client">MasterErrorException</a></td>
<td class="colLast">
<div class="block">This exception is thrown when a Master responds to an RPC with an error message</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/NoLeaderMasterFoundException.html" title="class in org.kududb.client">NoLeaderMasterFoundException</a></td>
<td class="colLast">
<div class="block">Indicates that the request failed because we couldn't find a leader master server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/NonRecoverableException.html" title="class in org.kududb.client">NonRecoverableException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/PleaseThrottleException.html" title="class in org.kududb.client">PleaseThrottleException</a></td>
<td class="colLast">
<div class="block">This exception notifies the application to throttle its use of Kudu.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kududb/client/RecoverableException.html" title="class in org.kududb.client">RecoverableException</a></td>
<td class="colLast">
<div class="block">An exception for which it's typically useful to retry</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kududb/client/TabletServerErrorException.html" title="class in org.kududb.client">TabletServerErrorException</a></td>
<td class="colLast">
<div class="block">This exception is thrown by Tablet Servers when something goes wrong processing a request.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/kududb/annotations/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../org/kududb/mapreduce/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kududb/client/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>