blob: 43bd1628d161562b9cc34df42c844327ae848fdb [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 (1.8.0_362) on Sun Jun 18 09:16:43 GMT 2023 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IOStatisticsSetters (Apache Hadoop Main 3.3.6 API)</title>
<meta name="date" content="2023-06-18">
<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="IOStatisticsSetters (Apache Hadoop Main 3.3.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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">
<!-- -->
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IOStatisticsSetters.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/apache/hadoop/fs/statistics/IOStatisticsLogging.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSnapshot.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/fs/statistics/IOStatisticsSetters.html" target="_top">Frames</a></li>
<li><a href="IOStatisticsSetters.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.fs.statistics</div>
<h2 title="Interface IOStatisticsSetters" class="title">Interface IOStatisticsSetters</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html" title="interface in org.apache.hadoop.fs.statistics">IOStatistics</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSnapshot.html" title="class in org.apache.hadoop.fs.statistics">IOStatisticsSnapshot</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface <span class="typeNameLabel">IOStatisticsSetters</span>
extends <a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html" title="interface in org.apache.hadoop.fs.statistics">IOStatistics</a></pre>
<div class="block">Setter for IOStatistics entries.
These operations have been in the read/write API
<code>IOStatisticsStore</code> since IOStatistics
was added; extracting into its own interface allows for
<a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSnapshot.html" title="class in org.apache.hadoop.fs.statistics"><code>IOStatisticsSnapshot</code></a> to also support it.
These are the simple setters, they don't provide for increments,
decrements, calculation of min/max/mean etc.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>The interface and IOStatisticsSnapshot support was added <i>after</i> Hadoop 3.3.5</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.fs.statistics.IOStatistics">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.hadoop.fs.statistics.<a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html" title="interface in org.apache.hadoop.fs.statistics">IOStatistics</a></h3>
<code><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#MAX_UNSET_VALUE">MAX_UNSET_VALUE</a>, <a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#MIN_UNSET_VALUE">MIN_UNSET_VALUE</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></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">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSetters.html#setCounter-java.lang.String-long-">setCounter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</code>
<div class="block">Set a counter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSetters.html#setGauge-java.lang.String-long-">setGauge</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</code>
<div class="block">Set a gauge.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSetters.html#setMaximum-java.lang.String-long-">setMaximum</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</code>
<div class="block">Set a maximum.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSetters.html#setMeanStatistic-java.lang.String-org.apache.hadoop.fs.statistics.MeanStatistic-">setMeanStatistic</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;value)</code>
<div class="block">Set a mean statistic to a given value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSetters.html#setMinimum-java.lang.String-long-">setMinimum</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</code>
<div class="block">Set a minimum.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.fs.statistics.IOStatistics">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.fs.statistics.<a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html" title="interface in org.apache.hadoop.fs.statistics">IOStatistics</a></h3>
<code><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#counters--">counters</a>, <a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#gauges--">gauges</a>, <a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#maximums--">maximums</a>, <a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#meanStatistics--">meanStatistics</a>, <a href="../../../../../org/apache/hadoop/fs/statistics/IOStatistics.html#minimums--">minimums</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setCounter-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCounter</h4>
<pre>void&nbsp;setCounter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</pre>
<div class="block">Set a counter.
No-op if the counter is unknown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - statistics key</dd>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="setGauge-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGauge</h4>
<pre>void&nbsp;setGauge(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</pre>
<div class="block">Set a gauge.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - statistics key</dd>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="setMaximum-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaximum</h4>
<pre>void&nbsp;setMaximum(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</pre>
<div class="block">Set a maximum.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - statistics key</dd>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="setMinimum-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinimum</h4>
<pre>void&nbsp;setMinimum(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
long&nbsp;value)</pre>
<div class="block">Set a minimum.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - statistics key</dd>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="setMeanStatistic-java.lang.String-org.apache.hadoop.fs.statistics.MeanStatistic-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setMeanStatistic</h4>
<pre>void&nbsp;setMeanStatistic(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;value)</pre>
<div class="block">Set a mean statistic to a given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - statistic key</dd>
<dd><code>value</code> - new value.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IOStatisticsSetters.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/apache/hadoop/fs/statistics/IOStatisticsLogging.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSnapshot.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/fs/statistics/IOStatisticsSetters.html" target="_top">Frames</a></li>
<li><a href="IOStatisticsSetters.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>