blob: 2a770dec029a07bb1e10bbee528865d1c0cbe0ea [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kudu C++ client API: kudu::client::KuduTablet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Kudu C++ client API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>kudu</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classkudu_1_1client_1_1KuduTablet.html">KuduTablet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classkudu_1_1client_1_1KuduTablet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">kudu::client::KuduTablet Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>In-memory representation of a remote tablet.
<a href="classkudu_1_1client_1_1KuduTablet.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="client_8h_source.html">client.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1e04c8ec48f31f1a656ab5e1b9180104" id="r_a1e04c8ec48f31f1a656ab5e1b9180104"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduTablet.html#a1e04c8ec48f31f1a656ab5e1b9180104">id</a> () const</td></tr>
<tr class="separator:a1e04c8ec48f31f1a656ab5e1b9180104"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae96a417372dbb6a687bd27dbd047ab1c" id="r_ae96a417372dbb6a687bd27dbd047ab1c"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; const <a class="el" href="classkudu_1_1client_1_1KuduReplica.html">KuduReplica</a> * &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduTablet.html#ae96a417372dbb6a687bd27dbd047ab1c">replicas</a> () const</td></tr>
<tr class="separator:ae96a417372dbb6a687bd27dbd047ab1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>In-memory representation of a remote tablet. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1e04c8ec48f31f1a656ab5e1b9180104" name="a1e04c8ec48f31f1a656ab5e1b9180104"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e04c8ec48f31f1a656ab5e1b9180104">&#9670;&#160;</a></span>id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string &amp; kudu::client::KuduTablet::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The ID which is globally unique and guaranteed not to change for the lifetime of the tablet. </dd></dl>
</div>
</div>
<a id="ae96a417372dbb6a687bd27dbd047ab1c" name="ae96a417372dbb6a687bd27dbd047ab1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae96a417372dbb6a687bd27dbd047ab1c">&#9670;&#160;</a></span>replicas()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; const <a class="el" href="classkudu_1_1client_1_1KuduReplica.html">KuduReplica</a> * &gt; &amp; kudu::client::KuduTablet::replicas </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The replicas of this tablet. The <a class="el" href="classkudu_1_1client_1_1KuduTablet.html" title="In-memory representation of a remote tablet.">KuduTablet</a> retains ownership over the replicas.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This information may be stale; replicas may be added or removed from Raft configurations at any time. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/kudu/client/<a class="el" href="client_8h_source.html">client.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.17.0 on Mon Sep 4 2023 19:49:30 by Doxygen 1.9.8</small>
<br>
<small>Copyright © 2023 The Apache Software Foundation.</small>
</address>
</body>
</html>