releases/1.18.0/cpp-client-api/classkudu_1_1client_1_1ResourceMetrics.html - kudu - Git at Google

 <!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.14.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>Kudu C++ client API: kudu::client::ResourceMetrics 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>
 <script type="text/javascript" src="clipboard.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <script type="text/javascript" src="cookie.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.14.0 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 </script>
 <script type="text/javascript">
 $(function() { codefold.init(); });
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 $(function() {
   initMenu('',true,false,'search.php','Search',true);
   $(function() { init_search(); });
 });
 </script>
 <div id="main-nav"></div>
 </div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
     <div id="nav-tree-contents">
       <div id="nav-sync" class="sync"></div>
     </div>
   </div>
   <div id="splitbar" style="-moz-user-select:none;"
        class="ui-resizable-handle">
   </div>
 </div>
 <script type="text/javascript">
 $(function(){initNavTree('classkudu_1_1client_1_1ResourceMetrics.html','','classkudu_1_1client_1_1ResourceMetrics-members'); });
 </script>
 <div id="container">
 <div id="doc-content">
 <!-- 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 class="header">
   <div class="headertitle"><div class="title">kudu::client::ResourceMetrics Class Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>A generic catalog of simple metrics.
  <a href="#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="resource__metrics_8h_source.html">resource_metrics.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:aa5cb88bb63936f5d1ca8a47a0c5b18eb" id="r_aa5cb88bb63936f5d1ca8a47a0c5b18eb"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5cb88bb63936f5d1ca8a47a0c5b18eb">Get</a> () const</td></tr>
 <tr class="memitem:ae7b5f6021f63c25bbd087ba2cf48dc8a" id="r_ae7b5f6021f63c25bbd087ba2cf48dc8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7b5f6021f63c25bbd087ba2cf48dc8a">Increment</a> (const std::string &amp;name, int64_t amount)</td></tr>
 <tr class="memitem:ae9d5ad8c55283103999e47a5bf754bdc" id="r_ae9d5ad8c55283103999e47a5bf754bdc"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae9d5ad8c55283103999e47a5bf754bdc">GetMetric</a> (const std::string &amp;name) const</td></tr>
 </table>
 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>A generic catalog of simple metrics. </p>
 </div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
 <a id="aa5cb88bb63936f5d1ca8a47a0c5b18eb" name="aa5cb88bb63936f5d1ca8a47a0c5b18eb"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#aa5cb88bb63936f5d1ca8a47a0c5b18eb">&#9670;&#160;</a></span>Get()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">std::map&lt; std::string, int64_t &gt; kudu::client::ResourceMetrics::Get </td>
           <td>(</td>
           <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <dl class="section return"><dt>Returns</dt><dd>A map that contains all metrics, its key is the metric name and its value is corresponding metric count. </dd></dl>

 </div>
 </div>
 <a id="ae9d5ad8c55283103999e47a5bf754bdc" name="ae9d5ad8c55283103999e47a5bf754bdc"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ae9d5ad8c55283103999e47a5bf754bdc">&#9670;&#160;</a></span>GetMetric()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int64_t kudu::client::ResourceMetrics::GetMetric </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;</td>          <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Get current count for the specified metric.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the metric in question. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The metric's current count. </dd></dl>

 </div>
 </div>
 <a id="ae7b5f6021f63c25bbd087ba2cf48dc8a" name="ae7b5f6021f63c25bbd087ba2cf48dc8a"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ae7b5f6021f63c25bbd087ba2cf48dc8a">&#9670;&#160;</a></span>Increment()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void kudu::client::ResourceMetrics::Increment </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;</td>          <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int64_t</td>          <td class="paramname"><span class="paramname"><em>amount</em></span>&#160;)</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Increment/decrement the given metric.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the metric. </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">amount</td><td>The amount to increment the metric (negative <code>amount</code> corresponds to decrementing the metric). </td></tr>
   </table>
   </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="resource__metrics_8h_source.html">resource_metrics.h</a></li>
 </ul>
 </div><!-- contents -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">
 <div id="page-nav-resize-handle"></div>
 <div id="page-nav-tree">
 <div id="page-nav-contents">
 </div><!-- page-nav-contents -->
 </div><!-- page-nav-tree -->
 </div><!-- page-nav -->
 </div><!-- container -->
 <!-- start footer part -->
 <hr class="footer"/>
 <address class="footer">
   <small>Generated for Kudu version 1.18.0 on Wed Jul 9 2025 13:08:41 by Doxygen 1.14.0</small>
   <br>
   <small>Copyright © 2025 The Apache Software Foundation.</small>
 </address>
 </body>
 </html>
	<!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.14.0"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Kudu C++ client API: kudu::client::ResourceMetrics 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>
	<script type="text/javascript" src="clipboard.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="navtreedata.js"></script>
	<script type="text/javascript" src="navtree.js"></script>
	<script type="text/javascript" src="cookie.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.14.0 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search/",'.html');
	</script>
	<script type="text/javascript">
	$(function() { codefold.init(); });
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	$(function() {
	initMenu('',true,false,'search.php','Search',true);
	$(function() { init_search(); });
	});
	</script>
	<div id="main-nav"></div>
	</div><!-- top -->
	<div id="side-nav" class="ui-resizable side-nav-resizable">
	<div id="nav-tree">
	<div id="nav-tree-contents">
	<div id="nav-sync" class="sync"></div>
	</div>
	</div>
	<div id="splitbar" style="-moz-user-select:none;"
	class="ui-resizable-handle">
	</div>
	</div>
	<script type="text/javascript">
	$(function(){initNavTree('classkudu_1_1client_1_1ResourceMetrics.html','','classkudu_1_1client_1_1ResourceMetrics-members'); });
	</script>
	<div id="container">
	<div id="doc-content">
	<!-- 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 class="header">
	<div class="headertitle"><div class="title">kudu::client::ResourceMetrics Class Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>A generic catalog of simple metrics.
	<a href="#details">More...</a></p>

	<p><code>#include <<a class="el" href="resource__metrics_8h_source.html">resource_metrics.h</a>></code></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
	Public Member Functions</h2></td></tr>
	<tr class="memitem:aa5cb88bb63936f5d1ca8a47a0c5b18eb" id="r_aa5cb88bb63936f5d1ca8a47a0c5b18eb"><td class="memItemLeft" align="right" valign="top">std::map< std::string, int64_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5cb88bb63936f5d1ca8a47a0c5b18eb">Get</a> () const</td></tr>
	<tr class="memitem:ae7b5f6021f63c25bbd087ba2cf48dc8a" id="r_ae7b5f6021f63c25bbd087ba2cf48dc8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7b5f6021f63c25bbd087ba2cf48dc8a">Increment</a> (const std::string &name, int64_t amount)</td></tr>
	<tr class="memitem:ae9d5ad8c55283103999e47a5bf754bdc" id="r_ae9d5ad8c55283103999e47a5bf754bdc"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae9d5ad8c55283103999e47a5bf754bdc">GetMetric</a> (const std::string &name) const</td></tr>
	</table>
	<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>A generic catalog of simple metrics. </p>
	</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
	<a id="aa5cb88bb63936f5d1ca8a47a0c5b18eb" name="aa5cb88bb63936f5d1ca8a47a0c5b18eb"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#aa5cb88bb63936f5d1ca8a47a0c5b18eb">◆ </a></span>Get()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">std::map< std::string, int64_t > kudu::client::ResourceMetrics::Get </td>
	<td>(</td>
	<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
	<td> const</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<dl class="section return"><dt>Returns</dt><dd>A map that contains all metrics, its key is the metric name and its value is corresponding metric count. </dd></dl>

	</div>
	</div>
	<a id="ae9d5ad8c55283103999e47a5bf754bdc" name="ae9d5ad8c55283103999e47a5bf754bdc"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#ae9d5ad8c55283103999e47a5bf754bdc">◆ </a></span>GetMetric()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">int64_t kudu::client::ResourceMetrics::GetMetric </td>
	<td>(</td>
	<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
	<td> const</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Get current count for the specified metric.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the metric in question. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>The metric's current count. </dd></dl>

	</div>
	</div>
	<a id="ae7b5f6021f63c25bbd087ba2cf48dc8a" name="ae7b5f6021f63c25bbd087ba2cf48dc8a"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#ae7b5f6021f63c25bbd087ba2cf48dc8a">◆ </a></span>Increment()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">void kudu::client::ResourceMetrics::Increment </td>
	<td>(</td>
	<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">int64_t</td> <td class="paramname"><span class="paramname"><em>amount</em></span> )</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Increment/decrement the given metric.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the metric. </td></tr>
	<tr><td class="paramdir">[in]</td><td class="paramname">amount</td><td>The amount to increment the metric (negative <code>amount</code> corresponds to decrementing the metric). </td></tr>
	</table>
	</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="resource__metrics_8h_source.html">resource_metrics.h</a></li>
	</ul>
	</div><!-- contents -->
	</div><!-- doc-content -->
	<div id="page-nav" class="page-nav-panel">
	<div id="page-nav-resize-handle"></div>
	<div id="page-nav-tree">
	<div id="page-nav-contents">
	</div><!-- page-nav-contents -->
	</div><!-- page-nav-tree -->
	</div><!-- page-nav -->
	</div><!-- container -->
	<!-- start footer part -->
	<hr class="footer"/>
	<address class="footer">
	<small>Generated for Kudu version 1.18.0 on Wed Jul 9 2025 13:08:41 by Doxygen 1.14.0</small>
	<br>
	<small>Copyright © 2025 The Apache Software Foundation.</small>
	</address>
	</body>
	</html>