| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SamplerMetric (Apache JMeter dist 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.jmeter.visualizers.backend, class: SamplerMetric"> |
| <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.6.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 evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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> |
| <div class="about-language"><b>Apache JMeter</b></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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></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> <a href="package-summary.html">org.apache.jmeter.visualizers.backend</a></div> |
| <h1 title="Class SamplerMetric" class="title">Class SamplerMetric</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jmeter.visualizers.backend.SamplerMetric</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SamplerMetric</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Sampler metric</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.13</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SamplerMetric</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">add</a><wbr>(<a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a <a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be used in the statistics</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addCumulated(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">addCumulated</a><wbr>(<a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a <a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> and its sub-results to be used in the statistics</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllMaxTime()" class="member-name-link">getAllMaxTime</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the maximal elapsed time for requests within sliding window</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllMean()" class="member-name-link">getAllMean</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the arithmetic mean of the stored values</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllMinTime()" class="member-name-link">getAllMinTime</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the minimal elapsed time for requests within sliding window</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllPercentile(double)" class="member-name-link">getAllPercentile</a><wbr>(double percentile)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an estimate for the requested percentile of the stored values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="ErrorMetric.html" title="class in org.apache.jmeter.visualizers.backend">ErrorMetric</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getErrors()" class="member-name-link">getErrors</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns by type ( response code and message ) the count of errors occurs</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFailures()" class="member-name-link">getFailures</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the number of failed requests for the current time slot</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHits()" class="member-name-link">getHits</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns hits to server</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKoMaxTime()" class="member-name-link">getKoMaxTime</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the maximal elapsed time for requests within sliding window</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKoMean()" class="member-name-link">getKoMean</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the arithmetic mean of the stored values</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKoMinTime()" class="member-name-link">getKoMinTime</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the minimal elapsed time for requests within sliding window</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKoPercentile(double)" class="member-name-link">getKoPercentile</a><wbr>(double percentile)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an estimate for the requested percentile of the stored values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOkMaxTime()" class="member-name-link">getOkMaxTime</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the maximal elapsed time for requests within sliding window</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOkMean()" class="member-name-link">getOkMean</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the arithmetic mean of the stored values</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOkMinTime()" class="member-name-link">getOkMinTime</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the minimal elapsed time for requests within sliding window</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOkPercentile(double)" class="member-name-link">getOkPercentile</a><wbr>(double percentile)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an estimate for the requested percentile of the stored values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReceivedBytes()" class="member-name-link">getReceivedBytes</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSentBytes()" class="member-name-link">getSentBytes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSuccesses()" class="member-name-link">getSuccesses</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the number of successful requests for the current time slot</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotal()" class="member-name-link">getTotal</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the number of total requests for the current time slot</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetForTimeInterval()" class="member-name-link">resetForTimeInterval</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reset metric except for percentile related data</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setDefaultWindowMode(org.apache.jmeter.visualizers.backend.WindowMode)" class="member-name-link">setDefaultWindowMode</a><wbr>(<a href="WindowMode.html" title="enum in org.apache.jmeter.visualizers.backend">WindowMode</a> windowMode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">only used for internal testing</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>SamplerMetric</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SamplerMetric</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setDefaultWindowMode(org.apache.jmeter.visualizers.backend.WindowMode)"> |
| <h3>setDefaultWindowMode</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| <a href="../../../jorphan/documentation/VisibleForTesting.html" title="annotation in org.apache.jorphan.documentation">@VisibleForTesting</a>(<a href="../../../jorphan/documentation/VisibleForTesting.html#visibility()">visibility</a>=<a href="../../../jorphan/documentation/VisibleForTesting.Visibility.html#PRIVATE">PRIVATE</a>) |
| </span><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">setDefaultWindowMode</span><wbr><span class="parameters">(<a href="WindowMode.html" title="enum in org.apache.jmeter.visualizers.backend">WindowMode</a> windowMode)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">only used for internal testing</div> |
| </div> |
| <div class="block">Set <a href="WindowMode.html" title="enum in org.apache.jmeter.visualizers.backend"><code>WindowMode</code></a> to use for newly created metrics.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowMode</code> - new visibility mode</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result)</span></div> |
| <div class="block">Add a <a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be used in the statistics</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - <a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addCumulated(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>addCumulated</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addCumulated</span><wbr><span class="parameters">(<a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result)</span></div> |
| <div class="block">Add a <a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> and its sub-results to be used in the statistics</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - <a href="../../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resetForTimeInterval()"> |
| <h3>resetForTimeInterval</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">resetForTimeInterval</span>()</div> |
| <div class="block">Reset metric except for percentile related data</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTotal()"> |
| <h3>getTotal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getTotal</span>()</div> |
| <div class="block">Get the number of total requests for the current time slot</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of total requests</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSuccesses()"> |
| <h3>getSuccesses</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSuccesses</span>()</div> |
| <div class="block">Get the number of successful requests for the current time slot</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of successful requests</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFailures()"> |
| <h3>getFailures</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getFailures</span>()</div> |
| <div class="block">Get the number of failed requests for the current time slot</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of failed requests</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOkMaxTime()"> |
| <h3>getOkMaxTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getOkMaxTime</span>()</div> |
| <div class="block">Get the maximal elapsed time for requests within sliding window</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the maximal elapsed time, or <code>0</code> if no requests have |
| been added yet</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOkMinTime()"> |
| <h3>getOkMinTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getOkMinTime</span>()</div> |
| <div class="block">Get the minimal elapsed time for requests within sliding window</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the minTime, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Long.MAX_VALUE</code></a> if no requests have been |
| added yet</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOkMean()"> |
| <h3>getOkMean</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getOkMean</span>()</div> |
| <div class="block">Get the arithmetic mean of the stored values</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The arithmetic mean of the stored values</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOkPercentile(double)"> |
| <h3>getOkPercentile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getOkPercentile</span><wbr><span class="parameters">(double percentile)</span></div> |
| <div class="block">Returns an estimate for the requested percentile of the stored values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>percentile</code> - the requested percentile (scaled from 0 - 100)</dd> |
| <dt>Returns:</dt> |
| <dd>Returns an estimate for the requested percentile of the stored |
| values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKoMaxTime()"> |
| <h3>getKoMaxTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getKoMaxTime</span>()</div> |
| <div class="block">Get the maximal elapsed time for requests within sliding window</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the maximal elapsed time, or <code>0</code> if no requests have |
| been added yet</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKoMinTime()"> |
| <h3>getKoMinTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getKoMinTime</span>()</div> |
| <div class="block">Get the minimal elapsed time for requests within sliding window</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the minTime, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Long.MAX_VALUE</code></a> if no requests have been |
| added yet</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKoMean()"> |
| <h3>getKoMean</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getKoMean</span>()</div> |
| <div class="block">Get the arithmetic mean of the stored values</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The arithmetic mean of the stored values</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKoPercentile(double)"> |
| <h3>getKoPercentile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getKoPercentile</span><wbr><span class="parameters">(double percentile)</span></div> |
| <div class="block">Returns an estimate for the requested percentile of the stored values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>percentile</code> - the requested percentile (scaled from 0 - 100)</dd> |
| <dt>Returns:</dt> |
| <dd>Returns an estimate for the requested percentile of the stored |
| values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllMaxTime()"> |
| <h3>getAllMaxTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAllMaxTime</span>()</div> |
| <div class="block">Get the maximal elapsed time for requests within sliding window</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the maximal elapsed time, or <code>0</code> if no requests have |
| been added yet</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllMinTime()"> |
| <h3>getAllMinTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAllMinTime</span>()</div> |
| <div class="block">Get the minimal elapsed time for requests within sliding window</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the minTime, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Long.MAX_VALUE</code></a> if no requests have been |
| added yet</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllMean()"> |
| <h3>getAllMean</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAllMean</span>()</div> |
| <div class="block">Get the arithmetic mean of the stored values</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The arithmetic mean of the stored values</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllPercentile(double)"> |
| <h3>getAllPercentile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAllPercentile</span><wbr><span class="parameters">(double percentile)</span></div> |
| <div class="block">Returns an estimate for the requested percentile of the stored values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>percentile</code> - the requested percentile (scaled from 0 - 100)</dd> |
| <dt>Returns:</dt> |
| <dd>Returns an estimate for the requested percentile of the stored |
| values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHits()"> |
| <h3>getHits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getHits</span>()</div> |
| <div class="block">Returns hits to server</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the hits</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrors()"> |
| <h3>getErrors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="ErrorMetric.html" title="class in org.apache.jmeter.visualizers.backend">ErrorMetric</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">getErrors</span>()</div> |
| <div class="block">Returns by type ( response code and message ) the count of errors occurs</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>errors</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSentBytes()"> |
| <h3>getSentBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSentBytes</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sentBytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReceivedBytes()"> |
| <h3>getReceivedBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getReceivedBytes</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the receivedBytes</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |