| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SampleResult (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.samplers, class: SampleResult"> |
| <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><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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.samplers</a></div> |
| <h1 title="Class SampleResult" class="title">Class SampleResult</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.samplers.SampleResult</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../gui/Searchable.html" title="interface in org.apache.jmeter.gui">Searchable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../protocol/http/sampler/HTTPSampleResult.html" title="class in org.apache.jmeter.protocol.http.sampler">HTTPSampleResult</a></code>, <code><a href="StatisticalSampleResult.html" title="class in org.apache.jmeter.samplers">StatisticalSampleResult</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SampleResult</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> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a>, <a href="../gui/Searchable.html" title="interface in org.apache.jmeter.gui">Searchable</a></span></div> |
| <div class="block">This is a nice packaging for the various information returned from taking a |
| sample of an entry.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.jmeter.samplers.SampleResult">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#BINARY" class="member-name-link">BINARY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Data type value ("bin") indicating that the response data is binary.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_ENCODING" class="member-name-link">DEFAULT_ENCODING</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The default encoding to be used to decode the responseData byte array.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_HTTP_ENCODING" class="member-name-link">DEFAULT_HTTP_ENCODING</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The default encoding to be used if not overridden.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#TEXT" class="member-name-link">TEXT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Data type value ("text") indicating that the response data is text.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SampleResult</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(long,boolean)" class="member-name-link">SampleResult</a><wbr>(long elapsed, |
| boolean atend)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a sample with a specific elapsed time but don't allow the times to |
| be changed later |
| |
| (only used by HTTPSampleResult)</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(long,long)" class="member-name-link">SampleResult</a><wbr>(long stamp, |
| long elapsed)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Allow users to create a sample with specific timestamp and elapsed times |
| for cloning purposes, but don't allow the times to be changed later |
| |
| Currently used by CSVSaveService and |
| StatisticalSampleResult</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">SampleResult</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> res)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Copy constructor.</div> |
| </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="#addAssertionResult(org.apache.jmeter.assertions.AssertionResult)" class="member-name-link">addAssertionResult</a><wbr>(<a href="../assertions/AssertionResult.html" title="class in org.apache.jmeter.assertions">AssertionResult</a> assertResult)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRawSubResult(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">addRawSubResult</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult)</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 subresult to the collection without updating any parent fields.</div> |
| </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="#addSubResult(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">addSubResult</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult)</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 subresult and adjust the parent byte count and end-time.</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="#addSubResult(org.apache.jmeter.samplers.SampleResult,boolean)" class="member-name-link">addSubResult</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult, |
| boolean renameSubResults)</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 subresult and adjust the parent byte count and end-time.</div> |
| </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="#cleanAfterSample()" class="member-name-link">cleanAfterSample</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clean up cached data</div> |
| </div> |
| <div class="col-first odd-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/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connectEnd()" class="member-name-link">connectEnd</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the time to the end of connecting</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createTestSample(long)" class="member-name-link">createTestSample</a><wbr>(long elapsed)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a sample with a specific elapsed time for test purposes, but don't |
| allow the times to be changed later</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createTestSample(long,long)" class="member-name-link">createTestSample</a><wbr>(long start, |
| long end)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a sample with specific start and end times for test purposes, but |
| don't allow the times to be changed later |
| |
| (used by StatVisualizerModel.Test)</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="#currentTimeInMillis()" class="member-name-link">currentTimeInMillis</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Helper method to get 1 ms resolution timing.</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="#getAllThreads()" class="member-name-link">getAllThreads</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><a href="../assertions/AssertionResult.html" title="class in org.apache.jmeter.assertions">AssertionResult</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAssertionResults()" class="member-name-link">getAssertionResults</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the assertion results associated with this sample.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getBodySize()" class="member-name-link">getBodySize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">replaced by getBodySizeAsLong()</div> |
| </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="#getBodySizeAsLong()" class="member-name-link">getBodySizeAsLong</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 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getBytes()" class="member-name-link">getBytes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use getBytesAsLong</div> |
| </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="#getBytesAsLong()" class="member-name-link">getBytesAsLong</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">return the bytes returned by the response.</div> |
| </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="#getConnectTime()" class="member-name-link">getConnectTime</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContentType()" class="member-name-link">getContentType</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataEncodingNoDefault()" class="member-name-link">getDataEncodingNoDefault</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 the dataEncoding.</div> |
| </div> |
| <div class="col-first odd-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataEncodingWithDefault()" class="member-name-link">getDataEncodingWithDefault</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the dataEncoding or the default if no dataEncoding was provided.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataEncodingWithDefault(java.lang.String)" class="member-name-link">getDataEncodingWithDefault</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> defaultEncoding)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the dataEncoding or the default if no dataEncoding was provided.</div> |
| </div> |
| <div class="col-first odd-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataType()" class="member-name-link">getDataType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the data type of the sample.</div> |
| </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="#getEndTime()" class="member-name-link">getEndTime</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="#getErrorCount()" class="member-name-link">getErrorCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the count of errors.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFirstAssertionFailureMessage()" class="member-name-link">getFirstAssertionFailureMessage</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="#getGroupThreads()" class="member-name-link">getGroupThreads</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>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeadersSize()" class="member-name-link">getHeadersSize</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 headers size in bytes</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="#getIdleTime()" class="member-name-link">getIdleTime</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="#getLatency()" class="member-name-link">getLatency</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMediaType()" class="member-name-link">getMediaType</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 media type from the Content Type</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParent()" class="member-name-link">getParent</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRequestHeaders()" class="member-name-link">getRequestHeaders</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseCode()" class="member-name-link">getResponseCode</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>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseData()" class="member-name-link">getResponseData</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the responseData attribute of the SampleResult object.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseDataAsString()" class="member-name-link">getResponseDataAsString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the responseData of the SampleResult object as a String</div> |
| </div> |
| <div class="col-first odd-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseHeaders()" class="member-name-link">getResponseHeaders</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseMessage()" class="member-name-link">getResponseMessage</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResultFileName()" class="member-name-link">getResultFileName</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>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSampleCount()" class="member-name-link">getSampleCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">return the sample count.</div> |
| </div> |
| <div class="col-first odd-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSampleLabel()" class="member-name-link">getSampleLabel</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSampleLabel(boolean)" class="member-name-link">getSampleLabel</a><wbr>(boolean includeGroup)</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 sample label for use in summary reports etc.</div> |
| </div> |
| <div class="col-first odd-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplerData()" class="member-name-link">getSamplerData</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><a href="SampleSaveConfiguration.html" title="class in org.apache.jmeter.samplers">SampleSaveConfiguration</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSaveConfig()" class="member-name-link">getSaveConfig</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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSearchableTokens()" class="member-name-link">getSearchableTokens</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 a list of all tokens that should be visible to searching</div> |
| </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>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStartTime()" class="member-name-link">getStartTime</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><a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubResults()" class="member-name-link">getSubResults</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the subresults associated with this sample.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../threads/JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTestLogicalAction()" class="member-name-link">getTestLogicalAction</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThreadName()" class="member-name-link">getThreadName</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>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTime()" class="member-name-link">getTime</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 time it took this sample to occur.</div> |
| </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="#getTimeStamp()" class="member-name-link">getTimeStamp</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 sample timestamp, which may be either the start time or the end time.</div> |
| </div> |
| <div class="col-first odd-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/net/URL.html" title="class or interface in java.net" class="external-link">URL</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getURL()" class="member-name-link">getURL</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUrlAsString()" class="member-name-link">getUrlAsString</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 a String representation of the URL (if defined).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isBinaryType(java.lang.String)" class="member-name-link">isBinaryType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ct)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIgnore()" class="member-name-link">isIgnore</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 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isMonitor()" class="member-name-link">isMonitor</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.2 always return false</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isRenameSampleLabel()" class="member-name-link">isRenameSampleLabel</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">see https://bz.apache.org/bugzilla/show_bug.cgi?id=63055</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isResponseCodeOK()" class="member-name-link">isResponseCodeOK</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStampedAtStart()" class="member-name-link">isStampedAtStart</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 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isStartNextThreadLoop()" class="member-name-link">isStartNextThreadLoop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#getTestLogicalAction()"><code>getTestLogicalAction()</code></a></div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStopTest()" class="member-name-link">isStopTest</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>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStopTestNow()" class="member-name-link">isStopTestNow</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStopThread()" class="member-name-link">isStopThread</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>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSuccessful()" class="member-name-link">isSuccessful</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#latencyEnd()" class="member-name-link">latencyEnd</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the time to the first response</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#markFile(java.lang.String)" class="member-name-link">markFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filename)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the "marked" flag to show that the result has been written to the file.</div> |
| </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="#removeAssertionResults()" class="member-name-link">removeAssertionResults</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allow custom SampleSenders to drop unwanted assertionResults</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="#removeSubResults()" class="member-name-link">removeSubResults</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allow custom SampleSenders to drop unwanted subResults</div> |
| </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="#sampleEnd()" class="member-name-link">sampleEnd</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Record the end time of a sample and calculate the elapsed time</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="#samplePause()" class="member-name-link">samplePause</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Pause a sample</div> |
| </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="#sampleResume()" class="member-name-link">sampleResume</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Resume a sample</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="#sampleStart()" class="member-name-link">sampleStart</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Record the start time of a sample</div> |
| </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="#setAllThreads(int)" class="member-name-link">setAllThreads</a><wbr>(int n)</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 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setBodySize(int)" class="member-name-link">setBodySize</a><wbr>(int bodySize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use setBodySize(long)</div> |
| </div> |
| </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="#setBodySize(long)" class="member-name-link">setBodySize</a><wbr>(long bodySize)</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 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setBytes(int)" class="member-name-link">setBytes</a><wbr>(int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use setBytes(long)</div> |
| </div> |
| </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="#setBytes(long)" class="member-name-link">setBytes</a><wbr>(long length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">In the event the sampler does want to pass back the actual contents, we |
| still want to calculate the throughput.</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="#setConnectTime(long)" class="member-name-link">setConnectTime</a><wbr>(long time)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is only intended for use by SampleResultConverter!</div> |
| </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="#setContentType(java.lang.String)" class="member-name-link">setContentType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stores the content-type string, e.g.</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="#setDataEncoding(java.lang.String)" class="member-name-link">setDataEncoding</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> dataEncoding)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the dataEncoding.</div> |
| </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="#setDataType(java.lang.String)" class="member-name-link">setDataType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> dataType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the data type of the sample.</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="#setEncodingAndType(java.lang.String)" class="member-name-link">setEncodingAndType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ct)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Extract and save the DataEncoding and DataType from the parameter provided.</div> |
| </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="#setEndTime(long)" class="member-name-link">setEndTime</a><wbr>(long end)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setErrorCount(int)" class="member-name-link">setErrorCount</a><wbr>(int i)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGroupThreads(int)" class="member-name-link">setGroupThreads</a><wbr>(int n)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeadersSize(int)" class="member-name-link">setHeadersSize</a><wbr>(int size)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the headers size in bytes</div> |
| </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="#setIdleTime(long)" class="member-name-link">setIdleTime</a><wbr>(long idle)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set idle time pause.</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="#setIgnore()" class="member-name-link">setIgnore</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Call this method to tell JMeter to ignore this SampleResult by Listeners</div> |
| </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="#setLatency(long)" class="member-name-link">setLatency</a><wbr>(long latency)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is only intended for use by SampleResultConverter!</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setMonitor(boolean)" class="member-name-link">setMonitor</a><wbr>(boolean monitor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.2 NOOP</div> |
| </div> |
| </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="#setParent(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">setParent</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> parent)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRequestHeaders(java.lang.String)" class="member-name-link">setRequestHeaders</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResponseCode(java.lang.String)" class="member-name-link">setResponseCode</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> code)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResponseCodeOK()" class="member-name-link">setResponseCodeOK</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set response code to OK, i.e.</div> |
| </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="#setResponseData(byte%5B%5D)" class="member-name-link">setResponseData</a><wbr>(byte[] response)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the responseData attribute of the SampleResult object.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setResponseData(java.lang.String)" class="member-name-link">setResponseData</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> response)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">- only intended for use from BeanShell code</div> |
| </div> |
| </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="#setResponseData(java.lang.String,java.lang.String)" class="member-name-link">setResponseData</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> response, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the encoding and responseData attributes of the SampleResult object.</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="#setResponseHeaders(java.lang.String)" class="member-name-link">setResponseHeaders</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResponseMessage(java.lang.String)" class="member-name-link">setResponseMessage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msg)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResponseMessageOK()" class="member-name-link">setResponseMessageOK</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResponseOK()" class="member-name-link">setResponseOK</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set result statuses OK - shorthand method to set: |
| |
| ResponseCode |
| ResponseMessage |
| Successful status |
| </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="#setResultFileName(java.lang.String)" class="member-name-link">setResultFileName</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resultFileName)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSampleCount(int)" class="member-name-link">setSampleCount</a><wbr>(int count)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The statistical sample sender aggregates several samples to save on |
| transmission costs.</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="#setSampleLabel(java.lang.String)" class="member-name-link">setSampleLabel</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSamplerData(java.lang.String)" class="member-name-link">setSamplerData</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSaveConfig(org.apache.jmeter.samplers.SampleSaveConfiguration)" class="member-name-link">setSaveConfig</a><wbr>(<a href="SampleSaveConfiguration.html" title="class in org.apache.jmeter.samplers">SampleSaveConfiguration</a> propertiesToSave)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSentBytes(long)" class="member-name-link">setSentBytes</a><wbr>(long sentBytesCount)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStampAndTime(long,long)" class="member-name-link">setStampAndTime</a><wbr>(long stamp, |
| long elapsed)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">For use by SaveService only.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setStartNextThreadLoop(boolean)" class="member-name-link">setStartNextThreadLoop</a><wbr>(boolean startNextThreadLoop)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use SampleResult#setTestLogicalAction(TestLogicalAction)</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStartTime(long)" class="member-name-link">setStartTime</a><wbr>(long start)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStopTest(boolean)" class="member-name-link">setStopTest</a><wbr>(boolean b)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStopTestNow(boolean)" class="member-name-link">setStopTestNow</a><wbr>(boolean b)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStopThread(boolean)" class="member-name-link">setStopThread</a><wbr>(boolean b)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSuccessful(boolean)" class="member-name-link">setSuccessful</a><wbr>(boolean success)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the successful attribute of the SampleResult object.</div> |
| </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="#setTestLogicalAction(org.apache.jmeter.threads.JMeterContext.TestLogicalAction)" class="member-name-link">setTestLogicalAction</a><wbr>(<a href="../threads/JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a> testLogicalAction)</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setThreadName(java.lang.String)" class="member-name-link">setThreadName</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> threadName)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTimeStamp(long)" class="member-name-link">setTimeStamp</a><wbr>(long timeStamp)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is only intended for use by SampleResultConverter!</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="#setURL(java.net.URL)" class="member-name-link">setURL</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html" title="class or interface in java.net" class="external-link">URL</a> location)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#storeSubResult(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">storeSubResult</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult)</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 subresult read from a results file.</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="#storeSubResult(org.apache.jmeter.samplers.SampleResult,boolean)" class="member-name-link">storeSubResult</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult, |
| boolean renameSubResults)</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 subresult read from a results file.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</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 the display name.</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#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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_HTTP_ENCODING"> |
| <h3>DEFAULT_HTTP_ENCODING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">DEFAULT_HTTP_ENCODING</span></div> |
| <div class="block">The default encoding to be used if not overridden. |
| The value is ISO-8859-1.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_ENCODING"> |
| <h3>DEFAULT_ENCODING</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">DEFAULT_ENCODING</span></div> |
| <div class="block">The default encoding to be used to decode the responseData byte array. |
| The value is defined by the property "sampleresult.default.encoding" |
| with a default of DEFAULT_HTTP_ENCODING if that is not defined.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TEXT"> |
| <h3>TEXT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">TEXT</span></div> |
| <div class="block">Data type value ("text") indicating that the response data is text.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getDataType()"><code>getDataType()</code></a></li> |
| <li><a href="#setDataType(java.lang.String)"><code>setDataType(java.lang.String)</code></a></li> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.samplers.SampleResult.TEXT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BINARY"> |
| <h3>BINARY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">BINARY</span></div> |
| <div class="block">Data type value ("bin") indicating that the response data is binary.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getDataType()"><code>getDataType()</code></a></li> |
| <li><a href="#setDataType(java.lang.String)"><code>setDataType(java.lang.String)</code></a></li> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.samplers.SampleResult.BINARY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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>SampleResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleResult</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>SampleResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleResult</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> res)</span></div> |
| <div class="block">Copy constructor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>res</code> - existing sample result</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(long,boolean)"> |
| <h3>SampleResult</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">SampleResult</span><wbr><span class="parameters">(long elapsed, |
| boolean atend)</span></div> |
| <div class="block">Create a sample with a specific elapsed time but don't allow the times to |
| be changed later |
| |
| (only used by HTTPSampleResult)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>elapsed</code> - time</dd> |
| <dd><code>atend</code> - create the sample finishing now, else starting now</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(long,long)"> |
| <h3>SampleResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleResult</span><wbr><span class="parameters">(long stamp, |
| long elapsed)</span></div> |
| <div class="block">Allow users to create a sample with specific timestamp and elapsed times |
| for cloning purposes, but don't allow the times to be changed later |
| |
| Currently used by CSVSaveService and |
| StatisticalSampleResult</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stamp</code> - this may be a start time or an end time (both in |
| milliseconds)</dd> |
| <dd><code>elapsed</code> - time in milliseconds</dd> |
| </dl> |
| </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="setSaveConfig(org.apache.jmeter.samplers.SampleSaveConfiguration)"> |
| <h3>setSaveConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSaveConfig</span><wbr><span class="parameters">(<a href="SampleSaveConfiguration.html" title="class in org.apache.jmeter.samplers">SampleSaveConfiguration</a> propertiesToSave)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>propertiesToSave</code> - The propertiesToSave to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSaveConfig()"> |
| <h3>getSaveConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SampleSaveConfiguration.html" title="class in org.apache.jmeter.samplers">SampleSaveConfiguration</a></span> <span class="element-name">getSaveConfig</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStampedAtStart()"> |
| <h3>isStampedAtStart</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStampedAtStart</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTestSample(long,long)"> |
| <h3>createTestSample</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></span> <span class="element-name">createTestSample</span><wbr><span class="parameters">(long start, |
| long end)</span></div> |
| <div class="block">Create a sample with specific start and end times for test purposes, but |
| don't allow the times to be changed later |
| |
| (used by StatVisualizerModel.Test)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>start</code> - start time in milliseconds since unix epoch</dd> |
| <dd><code>end</code> - end time in milliseconds since unix epoch</dd> |
| <dt>Returns:</dt> |
| <dd>sample with given start and end time</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTestSample(long)"> |
| <h3>createTestSample</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></span> <span class="element-name">createTestSample</span><wbr><span class="parameters">(long elapsed)</span></div> |
| <div class="block">Create a sample with a specific elapsed time for test purposes, but don't |
| allow the times to be changed later</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>elapsed</code> - - desired elapsed time in milliseconds</dd> |
| <dt>Returns:</dt> |
| <dd>sample that starts 'now' and ends <code>elapsed</code> milliseconds later</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="currentTimeInMillis()"> |
| <h3>currentTimeInMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">currentTimeInMillis</span>()</div> |
| <div class="block">Helper method to get 1 ms resolution timing.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the current time in milliseconds</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></code> - when <code>useNanoTime</code> is <code>true</code> but |
| <code>nanoTimeOffset</code> is not set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStampAndTime(long,long)"> |
| <h3>setStampAndTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStampAndTime</span><wbr><span class="parameters">(long stamp, |
| long elapsed)</span></div> |
| <div class="block">For use by SaveService only.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stamp</code> - this may be a start time or an end time (both in milliseconds)</dd> |
| <dd><code>elapsed</code> - time in milliseconds</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></code> - when <code>startTime</code> or <code>endTime</code> has been |
| set already</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="markFile(java.lang.String)"> |
| <h3>markFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">markFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filename)</span></div> |
| <div class="block">Set the "marked" flag to show that the result has been written to the file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filename</code> - the name of the file</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the result was previously marked</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponseCode()"> |
| <h3>getResponseCode</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getResponseCode</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseCodeOK()"> |
| <h3>setResponseCodeOK</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseCodeOK</span>()</div> |
| <div class="block">Set response code to OK, i.e. "200"</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseCode(java.lang.String)"> |
| <h3>setResponseCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseCode</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> code)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isResponseCodeOK()"> |
| <h3>isResponseCodeOK</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isResponseCodeOK</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponseMessage()"> |
| <h3>getResponseMessage</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getResponseMessage</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseMessage(java.lang.String)"> |
| <h3>setResponseMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseMessage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msg)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseMessageOK()"> |
| <h3>setResponseMessageOK</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseMessageOK</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseOK()"> |
| <h3>setResponseOK</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseOK</span>()</div> |
| <div class="block">Set result statuses OK - shorthand method to set: |
| <ul> |
| <li>ResponseCode</li> |
| <li>ResponseMessage</li> |
| <li>Successful status</li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreadName()"> |
| <h3>getThreadName</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getThreadName</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setThreadName(java.lang.String)"> |
| <h3>setThreadName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setThreadName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> threadName)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeStamp()"> |
| <h3>getTimeStamp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTimeStamp</span>()</div> |
| <div class="block">Get the sample timestamp, which may be either the start time or the end time.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>timeStamp in milliseconds</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getStartTime()"><code>getStartTime()</code></a></li> |
| <li><a href="#getEndTime()"><code>getEndTime()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSampleLabel()"> |
| <h3>getSampleLabel</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSampleLabel</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSampleLabel(boolean)"> |
| <h3>getSampleLabel</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSampleLabel</span><wbr><span class="parameters">(boolean includeGroup)</span></div> |
| <div class="block">Get the sample label for use in summary reports etc.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>includeGroup</code> - whether to include the thread group name</dd> |
| <dt>Returns:</dt> |
| <dd>the label</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSampleLabel(java.lang.String)"> |
| <h3>setSampleLabel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSampleLabel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAssertionResult(org.apache.jmeter.assertions.AssertionResult)"> |
| <h3>addAssertionResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addAssertionResult</span><wbr><span class="parameters">(<a href="../assertions/AssertionResult.html" title="class in org.apache.jmeter.assertions">AssertionResult</a> assertResult)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssertionResults()"> |
| <h3>getAssertionResults</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../assertions/AssertionResult.html" title="class in org.apache.jmeter.assertions">AssertionResult</a>[]</span> <span class="element-name">getAssertionResults</span>()</div> |
| <div class="block">Gets the assertion results associated with this sample.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the assertion results for this sample. |
| Returns empty array if there are no assertion results.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addSubResult(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>addSubResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSubResult</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult)</span></div> |
| <div class="block">Add a subresult and adjust the parent byte count and end-time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>subResult</code> - the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be added</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRenameSampleLabel()"> |
| <h3>isRenameSampleLabel</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isRenameSampleLabel</span>()</div> |
| <div class="block">see https://bz.apache.org/bugzilla/show_bug.cgi?id=63055</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if TestPlan is in functional mode or property subresults.disable_renaming is true</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addSubResult(org.apache.jmeter.samplers.SampleResult,boolean)"> |
| <h3>addSubResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSubResult</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult, |
| boolean renameSubResults)</span></div> |
| <div class="block">Add a subresult and adjust the parent byte count and end-time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>subResult</code> - the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be added</dd> |
| <dd><code>renameSubResults</code> - boolean do we rename subResults based on position</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRawSubResult(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>addRawSubResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addRawSubResult</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult)</span></div> |
| <div class="block">Add a subresult to the collection without updating any parent fields.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>subResult</code> - the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be added</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="storeSubResult(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>storeSubResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">storeSubResult</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult)</span></div> |
| <div class="block">Add a subresult read from a results file. |
| <p> |
| As for <a href="#addSubResult(org.apache.jmeter.samplers.SampleResult)"><code>addSubResult(SampleResult)</code></a>, except that the fields don't need to be |
| accumulated</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>subResult</code> - the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be added</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="storeSubResult(org.apache.jmeter.samplers.SampleResult,boolean)"> |
| <h3>storeSubResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">storeSubResult</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> subResult, |
| boolean renameSubResults)</span></div> |
| <div class="block">Add a subresult read from a results file. |
| <p> |
| As for <a href="#addSubResult(org.apache.jmeter.samplers.SampleResult)"><code>addSubResult(SampleResult)</code></a>, except that the fields don't need to be |
| accumulated</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>subResult</code> - the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> to be added</dd> |
| <dd><code>renameSubResults</code> - boolean do we rename subResults based on position</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubResults()"> |
| <h3>getSubResults</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a>[]</span> <span class="element-name">getSubResults</span>()</div> |
| <div class="block">Gets the subresults associated with this sample.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the subresults for this sample. Returns an |
| empty array if there are no subresults.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseData(byte[])"> |
| <h3>setResponseData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseData</span><wbr><span class="parameters">(byte[] response)</span></div> |
| <div class="block">Sets the responseData attribute of the SampleResult object. |
| |
| If the parameter is null, then the responseData is set to an empty byte array. |
| This ensures that getResponseData() can never be null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>response</code> - the new responseData value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseData(java.lang.String)"> |
| <h3>setResponseData</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> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> response)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">- only intended for use from BeanShell code</div> |
| </div> |
| <div class="block">Sets the responseData attribute of the SampleResult object. |
| Should only be called after setting the dataEncoding (if necessary)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>response</code> - the new responseData value (String)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseData(java.lang.String,java.lang.String)"> |
| <h3>setResponseData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> response, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</span></div> |
| <div class="block">Sets the encoding and responseData attributes of the SampleResult object.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>response</code> - the new responseData value (String)</dd> |
| <dd><code>encoding</code> - the encoding to set and then use (if null, use platform default)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponseData()"> |
| <h3>getResponseData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">getResponseData</span>()</div> |
| <div class="block">Gets the responseData attribute of the SampleResult object. |
| <p> |
| Note that some samplers may not store all the data, in which case |
| getResponseData().length will be incorrect. |
| |
| Instead, always use <a href="#getBytes()"><code>getBytes()</code></a> to obtain the sample result byte count. |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the responseData value (cannot be null)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponseDataAsString()"> |
| <h3>getResponseDataAsString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getResponseDataAsString</span>()</div> |
| <div class="block">Gets the responseData of the SampleResult object as a String</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the responseData value as a String, converted according to the encoding</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSamplerData(java.lang.String)"> |
| <h3>setSamplerData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSamplerData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSamplerData()"> |
| <h3>getSamplerData</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSamplerData</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTime()"> |
| <h3>getTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTime</span>()</div> |
| <div class="block">Get the time it took this sample to occur.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>elapsed time in milliseconds</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSuccessful()"> |
| <h3>isSuccessful</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSuccessful</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDataType(java.lang.String)"> |
| <h3>setDataType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDataType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> dataType)</span></div> |
| <div class="block">Sets the data type of the sample.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dataType</code> - String containing <a href="#BINARY"><code>BINARY</code></a> or <a href="#TEXT"><code>TEXT</code></a></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#BINARY"><code>BINARY</code></a></li> |
| <li><a href="#TEXT"><code>TEXT</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataType()"> |
| <h3>getDataType</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDataType</span>()</div> |
| <div class="block">Returns the data type of the sample.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>String containing <a href="#BINARY"><code>BINARY</code></a> or <a href="#TEXT"><code>TEXT</code></a> or the empty string</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#BINARY"><code>BINARY</code></a></li> |
| <li><a href="#TEXT"><code>TEXT</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEncodingAndType(java.lang.String)"> |
| <h3>setEncodingAndType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEncodingAndType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ct)</span></div> |
| <div class="block">Extract and save the DataEncoding and DataType from the parameter provided. |
| Does not save the full content Type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ct</code> - - content type (may be null)</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#setContentType(java.lang.String)"><code>which should be used to save the full content-type string</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBinaryType(java.lang.String)"> |
| <h3>isBinaryType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isBinaryType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ct)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSuccessful(boolean)"> |
| <h3>setSuccessful</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSuccessful</span><wbr><span class="parameters">(boolean success)</span></div> |
| <div class="block">Sets the successful attribute of the SampleResult object.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>success</code> - the new successful value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Returns the display name.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt>Returns:</dt> |
| <dd>display name of this sample result</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataEncodingWithDefault()"> |
| <h3>getDataEncodingWithDefault</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDataEncodingWithDefault</span>()</div> |
| <div class="block">Returns the dataEncoding or the default if no dataEncoding was provided.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the value of the dataEncoding or DEFAULT_ENCODING</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataEncodingWithDefault(java.lang.String)"> |
| <h3>getDataEncodingWithDefault</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDataEncodingWithDefault</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> defaultEncoding)</span></div> |
| <div class="block">Returns the dataEncoding or the default if no dataEncoding was provided.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>defaultEncoding</code> - the default to be applied</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the dataEncoding or the provided default</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataEncodingNoDefault()"> |
| <h3>getDataEncodingNoDefault</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDataEncodingNoDefault</span>()</div> |
| <div class="block">Returns the dataEncoding. May be null or the empty String.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the value of the dataEncoding</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDataEncoding(java.lang.String)"> |
| <h3>setDataEncoding</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDataEncoding</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> dataEncoding)</span></div> |
| <div class="block">Sets the dataEncoding.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dataEncoding</code> - the dataEncoding to set, e.g. ISO-8895-1, UTF-8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStopTest()"> |
| <h3>isStopTest</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStopTest</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to stop the test waiting for current running Sampler to end</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStopTestNow()"> |
| <h3>isStopTestNow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStopTestNow</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to stop the test now interrupting current running samplers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStopThread()"> |
| <h3>isStopThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStopThread</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to stop this thread</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStopTest(boolean)"> |
| <h3>setStopTest</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStopTest</span><wbr><span class="parameters">(boolean b)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStopTestNow(boolean)"> |
| <h3>setStopTestNow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStopTestNow</span><wbr><span class="parameters">(boolean b)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStopThread(boolean)"> |
| <h3>setStopThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStopThread</span><wbr><span class="parameters">(boolean b)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestHeaders()"> |
| <h3>getRequestHeaders</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getRequestHeaders</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the request headers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponseHeaders()"> |
| <h3>getResponseHeaders</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getResponseHeaders</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the response headers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRequestHeaders(java.lang.String)"> |
| <h3>setRequestHeaders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRequestHeaders</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>string</code> - - |
| request headers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResponseHeaders(java.lang.String)"> |
| <h3>setResponseHeaders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResponseHeaders</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>string</code> - - |
| response headers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContentType()"> |
| <h3>getContentType</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getContentType</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the full content type - e.g. text/html [;charset=utf-8 ]</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMediaType()"> |
| <h3>getMediaType</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getMediaType</span>()</div> |
| <div class="block">Get the media type from the Content Type</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the media type - e.g. text/html (without charset, if any)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setContentType(java.lang.String)"> |
| <h3>setContentType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setContentType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div> |
| <div class="block">Stores the content-type string, e.g. <code>text/xml; charset=utf-8</code></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>string</code> - the content-type to be set</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#setEncodingAndType(java.lang.String)"><code>which can be used to extract the charset.</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIdleTime()"> |
| <h3>getIdleTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getIdleTime</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>idleTime</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEndTime()"> |
| <h3>getEndTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEndTime</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the end time</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartTime()"> |
| <h3>getStartTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getStartTime</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the start time</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStartTime(long)"> |
| <h3>setStartTime</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">void</span> <span class="element-name">setStartTime</span><wbr><span class="parameters">(long start)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEndTime(long)"> |
| <h3>setEndTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEndTime</span><wbr><span class="parameters">(long end)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIdleTime(long)"> |
| <h3>setIdleTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIdleTime</span><wbr><span class="parameters">(long idle)</span></div> |
| <div class="block">Set idle time pause. |
| For use by SampleResultConverter/CSVSaveService.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>idle</code> - long</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sampleStart()"> |
| <h3>sampleStart</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sampleStart</span>()</div> |
| <div class="block">Record the start time of a sample</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sampleEnd()"> |
| <h3>sampleEnd</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sampleEnd</span>()</div> |
| <div class="block">Record the end time of a sample and calculate the elapsed time</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="samplePause()"> |
| <h3>samplePause</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">samplePause</span>()</div> |
| <div class="block">Pause a sample</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sampleResume()"> |
| <h3>sampleResume</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sampleResume</span>()</div> |
| <div class="block">Resume a sample</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMonitor(boolean)"> |
| <h3>setMonitor</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> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMonitor</span><wbr><span class="parameters">(boolean monitor)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.2 NOOP</div> |
| </div> |
| <div class="block">When a Sampler is working as a monitor</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>monitor</code> - flag whether this sampler is working as a monitor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMonitor()"> |
| <h3>isMonitor</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> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMonitor</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.2 always return false</div> |
| </div> |
| <div class="block">If the sampler is a monitor, method will return true.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the sampler is a monitor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSampleCount(int)"> |
| <h3>setSampleCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSampleCount</span><wbr><span class="parameters">(int count)</span></div> |
| <div class="block">The statistical sample sender aggregates several samples to save on |
| transmission costs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>count</code> - number of samples represented by this instance</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSampleCount()"> |
| <h3>getSampleCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSampleCount</span>()</div> |
| <div class="block">return the sample count. by default, the value is 1.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sample count</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorCount()"> |
| <h3>getErrorCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getErrorCount</span>()</div> |
| <div class="block">Returns the count of errors.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>0 - or 1 if the sample failed |
| |
| TODO do we need allow for nested samples?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setErrorCount(int)"> |
| <h3>setErrorCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setErrorCount</span><wbr><span class="parameters">(int i)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBytes(long)"> |
| <h3>setBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBytes</span><wbr><span class="parameters">(long length)</span></div> |
| <div class="block">In the event the sampler does want to pass back the actual contents, we |
| still want to calculate the throughput. The bytes are the bytes of the |
| response data.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - the number of bytes of the response data for this sample</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBytes(int)"> |
| <h3>setBytes</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> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBytes</span><wbr><span class="parameters">(int length)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use setBytes(long)</div> |
| </div> |
| <div class="block">In the event the sampler does want to pass back the actual contents, we |
| still want to calculate the throughput. The bytes are the bytes of the |
| response data.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - the number of bytes of the response data for this sample</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSentBytes(long)"> |
| <h3>setSentBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSentBytes</span><wbr><span class="parameters">(long sentBytesCount)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sentBytesCount</code> - long sent bytes</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="getBytes()"> |
| <h3>getBytes</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> |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBytes</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use getBytesAsLong</div> |
| </div> |
| <div class="block">return the bytes returned by the response.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>byte count</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBytesAsLong()"> |
| <h3>getBytesAsLong</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getBytesAsLong</span>()</div> |
| <div class="block">return the bytes returned by the response.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>byte count</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLatency()"> |
| <h3>getLatency</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLatency</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Returns the latency.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="latencyEnd()"> |
| <h3>latencyEnd</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">latencyEnd</span>()</div> |
| <div class="block">Set the time to the first response</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLatency(long)"> |
| <h3>setLatency</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLatency</span><wbr><span class="parameters">(long latency)</span></div> |
| <div class="block">This is only intended for use by SampleResultConverter!</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>latency</code> - The latency to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConnectTime()"> |
| <h3>getConnectTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getConnectTime</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Returns the connect time.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connectEnd()"> |
| <h3>connectEnd</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">connectEnd</span>()</div> |
| <div class="block">Set the time to the end of connecting</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConnectTime(long)"> |
| <h3>setConnectTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConnectTime</span><wbr><span class="parameters">(long time)</span></div> |
| <div class="block">This is only intended for use by SampleResultConverter!</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>time</code> - The connect time to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTimeStamp(long)"> |
| <h3>setTimeStamp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTimeStamp</span><wbr><span class="parameters">(long timeStamp)</span></div> |
| <div class="block">This is only intended for use by SampleResultConverter!</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>timeStamp</code> - The timeStamp to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setURL(java.net.URL)"> |
| <h3>setURL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setURL</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html" title="class or interface in java.net" class="external-link">URL</a> location)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getURL()"> |
| <h3>getURL</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/net/URL.html" title="class or interface in java.net" class="external-link">URL</a></span> <span class="element-name">getURL</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUrlAsString()"> |
| <h3>getUrlAsString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getUrlAsString</span>()</div> |
| <div class="block">Get a String representation of the URL (if defined).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>ExternalForm of URL, or empty string if url is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParent()"> |
| <h3>getParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></span> <span class="element-name">getParent</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Returns the parent.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParent(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>setParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setParent</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> parent)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parent</code> - The parent to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResultFileName()"> |
| <h3>getResultFileName</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getResultFileName</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setResultFileName(java.lang.String)"> |
| <h3>setResultFileName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setResultFileName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resultFileName)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGroupThreads()"> |
| <h3>getGroupThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getGroupThreads</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setGroupThreads(int)"> |
| <h3>setGroupThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setGroupThreads</span><wbr><span class="parameters">(int n)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllThreads()"> |
| <h3>getAllThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getAllThreads</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAllThreads(int)"> |
| <h3>setAllThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAllThreads</span><wbr><span class="parameters">(int n)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAssertionResults()"> |
| <h3>removeAssertionResults</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeAssertionResults</span>()</div> |
| <div class="block">Allow custom SampleSenders to drop unwanted assertionResults</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeSubResults()"> |
| <h3>removeSubResults</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeSubResults</span>()</div> |
| <div class="block">Allow custom SampleSenders to drop unwanted subResults</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHeadersSize(int)"> |
| <h3>setHeadersSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setHeadersSize</span><wbr><span class="parameters">(int size)</span></div> |
| <div class="block">Set the headers size in bytes</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>size</code> - the number of bytes of the header</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeadersSize()"> |
| <h3>getHeadersSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getHeadersSize</span>()</div> |
| <div class="block">Get the headers size in bytes</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the headers size</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBodySize()"> |
| <h3>getBodySize</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> |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBodySize</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">replaced by getBodySizeAsLong()</div> |
| </div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the body size in bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBodySizeAsLong()"> |
| <h3>getBodySizeAsLong</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getBodySizeAsLong</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the body size in bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBodySize(long)"> |
| <h3>setBodySize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBodySize</span><wbr><span class="parameters">(long bodySize)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bodySize</code> - the body size to set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBodySize(int)"> |
| <h3>setBodySize</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> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBodySize</span><wbr><span class="parameters">(int bodySize)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use setBodySize(long)</div> |
| </div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bodySize</code> - the body size to set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStartNextThreadLoop()"> |
| <h3>isStartNextThreadLoop</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> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStartNextThreadLoop</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#getTestLogicalAction()"><code>getTestLogicalAction()</code></a></div> |
| </div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the startNextThreadLoop</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStartNextThreadLoop(boolean)"> |
| <h3>setStartNextThreadLoop</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> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStartNextThreadLoop</span><wbr><span class="parameters">(boolean startNextThreadLoop)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use SampleResult#setTestLogicalAction(TestLogicalAction)</div> |
| </div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startNextThreadLoop</code> - the startNextLoop to set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanAfterSample()"> |
| <h3>cleanAfterSample</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanAfterSample</span>()</div> |
| <div class="block">Clean up cached data</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</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/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">clone</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSearchableTokens()"> |
| <h3>getSearchableTokens</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getSearchableTokens</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../gui/Searchable.html#getSearchableTokens()">Searchable</a></code></span></div> |
| <div class="block">Get a list of all tokens that should be visible to searching</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../gui/Searchable.html#getSearchableTokens()">getSearchableTokens</a></code> in interface <code><a href="../gui/Searchable.html" title="interface in org.apache.jmeter.gui">Searchable</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>List of searchable tokens</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - when something fails while getting the searchable tokens</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIgnore()"> |
| <h3>isIgnore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isIgnore</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>boolean true if this SampleResult should not be sent to Listeners</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIgnore()"> |
| <h3>setIgnore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIgnore</span>()</div> |
| <div class="block">Call this method to tell JMeter to ignore this SampleResult by Listeners</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFirstAssertionFailureMessage()"> |
| <h3>getFirstAssertionFailureMessage</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFirstAssertionFailureMessage</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>String first non null assertion failure message if assertionResults is not null, null otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTestLogicalAction()"> |
| <h3>getTestLogicalAction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../threads/JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a></span> <span class="element-name">getTestLogicalAction</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the testLogicalAction</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTestLogicalAction(org.apache.jmeter.threads.JMeterContext.TestLogicalAction)"> |
| <h3>setTestLogicalAction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTestLogicalAction</span><wbr><span class="parameters">(<a href="../threads/JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a> testLogicalAction)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>testLogicalAction</code> - the testLogicalAction to set</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> |