blob: 3d01565db272dcdf3757833b24ff24c85794793c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>MetricValueProvider (kafka 3.6.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.kafka.common.metrics, interface: MetricValueProvider">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.kafka.common.metrics</a></div>
<h1 title="Interface MetricValueProvider" class="title">Interface MetricValueProvider&lt;T&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="Gauge.html" title="interface in org.apache.kafka.common.metrics">Gauge</a>&lt;T&gt;</code>, <code><a href="Measurable.html" title="interface in org.apache.kafka.common.metrics">Measurable</a></code>, <code><a href="MeasurableStat.html" title="interface in org.apache.kafka.common.metrics">MeasurableStat</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="stats/Avg.html" title="class in org.apache.kafka.common.metrics.stats">Avg</a></code>, <code><a href="stats/CumulativeCount.html" title="class in org.apache.kafka.common.metrics.stats">CumulativeCount</a></code>, <code><a href="stats/CumulativeSum.html" title="class in org.apache.kafka.common.metrics.stats">CumulativeSum</a></code>, <code><a href="stats/Frequencies.html" title="class in org.apache.kafka.common.metrics.stats">Frequencies</a></code>, <code><a href="stats/Max.html" title="class in org.apache.kafka.common.metrics.stats">Max</a></code>, <code><a href="stats/Min.html" title="class in org.apache.kafka.common.metrics.stats">Min</a></code>, <code><a href="stats/Percentiles.html" title="class in org.apache.kafka.common.metrics.stats">Percentiles</a></code>, <code><a href="stats/Rate.html" title="class in org.apache.kafka.common.metrics.stats">Rate</a></code>, <code><a href="stats/SampledStat.html" title="class in org.apache.kafka.common.metrics.stats">SampledStat</a></code>, <code><a href="stats/SimpleRate.html" title="class in org.apache.kafka.common.metrics.stats">SimpleRate</a></code>, <code><a href="stats/TokenBucket.html" title="class in org.apache.kafka.common.metrics.stats">TokenBucket</a></code>, <code><a href="stats/Value.html" title="class in org.apache.kafka.common.metrics.stats">Value</a></code>, <code><a href="stats/WindowedCount.html" title="class in org.apache.kafka.common.metrics.stats">WindowedCount</a></code>, <code><a href="stats/WindowedSum.html" title="class in org.apache.kafka.common.metrics.stats">WindowedSum</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MetricValueProvider&lt;T&gt;</span></div>
<div class="block">Super-interface for <a href="Measurable.html" title="interface in org.apache.kafka.common.metrics"><code>Measurable</code></a> or <a href="Gauge.html" title="interface in org.apache.kafka.common.metrics"><code>Gauge</code></a> that provides
metric values.
<p>
In the future for Java8 and above, <a href="Gauge.html#value(org.apache.kafka.common.metrics.MetricConfig,long)"><code>Gauge.value(MetricConfig, long)</code></a> will be
moved to this interface with a default implementation in <a href="Measurable.html" title="interface in org.apache.kafka.common.metrics"><code>Measurable</code></a> that returns
<a href="Measurable.html#measure(org.apache.kafka.common.metrics.MetricConfig,long)"><code>Measurable.measure(MetricConfig, long)</code></a>.
</p></div>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>