| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SampleEvent (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: SampleEvent"> |
| <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 SampleEvent" class="title">Class SampleEvent</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.SampleEvent</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></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SampleEvent</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></span></div> |
| <div class="block">Packages information regarding the target of a sample event, such as the |
| result from that event and the thread group it ran in.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.jmeter.samplers.SampleEvent">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="#HOSTNAME" class="member-name-link">HOSTNAME</a></code></div> |
| <div class="col-last even-row-color"> </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="#SAMPLE_VARIABLES" class="member-name-link">SAMPLE_VARIABLES</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The property "sample_variables" is used to define additional variables to be saved</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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SampleEvent</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructor used for Unit tests only.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.jmeter.samplers.SampleResult,java.lang.String)" class="member-name-link">SampleEvent</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates SampleEvent without saving any variables.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.jmeter.samplers.SampleResult,java.lang.String,java.lang.String)" class="member-name-link">SampleEvent</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup, |
| <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> hostname)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Only intended for use when loading results from a file.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.jmeter.samplers.SampleResult,java.lang.String,org.apache.jmeter.threads.JMeterVariables)" class="member-name-link">SampleEvent</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup, |
| <a href="../threads/JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a> jmvars)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructor used for normal samples, saves variable values if any are |
| defined.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.jmeter.samplers.SampleResult,java.lang.String,org.apache.jmeter.threads.JMeterVariables,boolean)" class="member-name-link">SampleEvent</a><wbr>(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup, |
| <a href="../threads/JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a> jmvars, |
| boolean isTransactionSampleEvent)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></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><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="#getHostname()" class="member-name-link">getHostname</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 name of the host for which this event was recorded</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResult()" class="member-name-link">getResult</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 <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> associated with this event</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="#getThreadGroup()" class="member-name-link">getThreadGroup</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 name of the thread group for which this event was recorded</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getVarCount()" class="member-name-link">getVarCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the number of defined variables</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#getVarName(int)" class="member-name-link">getVarName</a><wbr>(int i)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the nth variable name (zero-based)</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="#getVarValue(int)" class="member-name-link">getVarValue</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 class="block">Get the nth variable value (zero-based)</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#initSampleVariables()" class="member-name-link">initSampleVariables</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Set up the additional variable names to be saved |
| from the value in the <a href="#SAMPLE_VARIABLES"><code>SAMPLE_VARIABLES</code></a> property</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="#isTransactionSampleEvent()" class="member-name-link">isTransactionSampleEvent</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="SAMPLE_VARIABLES"> |
| <h3>SAMPLE_VARIABLES</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">SAMPLE_VARIABLES</span></div> |
| <div class="block">The property "sample_variables" is used to define additional variables to be saved</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.samplers.SampleEvent.SAMPLE_VARIABLES">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="HOSTNAME"> |
| <h3>HOSTNAME</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">HOSTNAME</span></div> |
| </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>SampleEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleEvent</span>()</div> |
| <div class="block">Constructor used for Unit tests only. Uses <code>null</code> for the |
| associated <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> and the <code>threadGroup</code>-name.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jmeter.samplers.SampleResult,java.lang.String)"> |
| <h3>SampleEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleEvent</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup)</span></div> |
| <div class="block">Creates SampleEvent without saving any variables.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - The SampleResult to be associated with this event</dd> |
| <dd><code>threadGroup</code> - The name of the thread, the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was recorded</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jmeter.samplers.SampleResult,java.lang.String,org.apache.jmeter.threads.JMeterVariables)"> |
| <h3>SampleEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleEvent</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup, |
| <a href="../threads/JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a> jmvars)</span></div> |
| <div class="block">Constructor used for normal samples, saves variable values if any are |
| defined.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - The SampleResult to be associated with this event</dd> |
| <dd><code>threadGroup</code> - The name of the thread, the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was recorded</dd> |
| <dd><code>jmvars</code> - the <a href="../threads/JMeterVariables.html" title="class in org.apache.jmeter.threads"><code>JMeterVariables</code></a> of the thread, the |
| <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was recorded</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jmeter.samplers.SampleResult,java.lang.String,java.lang.String)"> |
| <h3>SampleEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleEvent</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup, |
| <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> hostname)</span></div> |
| <div class="block">Only intended for use when loading results from a file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - The SampleResult to be associated with this event</dd> |
| <dd><code>threadGroup</code> - The name of the thread, the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was recorded</dd> |
| <dd><code>hostname</code> - The name of the host, for which the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was |
| recorded</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jmeter.samplers.SampleResult,java.lang.String,org.apache.jmeter.threads.JMeterVariables,boolean)"> |
| <h3>SampleEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SampleEvent</span><wbr><span class="parameters">(<a href="SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result, |
| <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> threadGroup, |
| <a href="../threads/JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a> jmvars, |
| boolean isTransactionSampleEvent)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - The SampleResult to be associated with this event</dd> |
| <dd><code>threadGroup</code> - The name of the thread, the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was recorded</dd> |
| <dd><code>jmvars</code> - the <a href="../threads/JMeterVariables.html" title="class in org.apache.jmeter.threads"><code>JMeterVariables</code></a> of the thread, the |
| <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> was recorded</dd> |
| <dd><code>isTransactionSampleEvent</code> - Flag whether this event is an transaction sample event</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="initSampleVariables()"> |
| <h3>initSampleVariables</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">initSampleVariables</span>()</div> |
| <div class="block">Set up the additional variable names to be saved |
| from the value in the <a href="#SAMPLE_VARIABLES"><code>SAMPLE_VARIABLES</code></a> property</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVarCount()"> |
| <h3>getVarCount</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">getVarCount</span>()</div> |
| <div class="block">Get the number of defined variables</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of variables defined</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVarName(int)"> |
| <h3>getVarName</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">getVarName</span><wbr><span class="parameters">(int i)</span></div> |
| <div class="block">Get the nth variable name (zero-based)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>i</code> - specifies which variable name should be returned (zero-based)</dd> |
| <dt>Returns:</dt> |
| <dd>the variable name of the nth variable</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVarValue(int)"> |
| <h3>getVarValue</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">getVarValue</span><wbr><span class="parameters">(int i)</span></div> |
| <div class="block">Get the nth variable value (zero-based)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>i</code> - specifies which variable value should be returned (zero-based)</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the nth variable</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../jorphan/util/JMeterError.html" title="class in org.apache.jorphan.util">JMeterError</a></code> - when an invalid index <code>i</code> was given</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResult()"> |
| <h3>getResult</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">getResult</span>()</div> |
| <div class="block">Get the <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a> associated with this event</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the associated <a href="SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreadGroup()"> |
| <h3>getThreadGroup</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">getThreadGroup</span>()</div> |
| <div class="block">Get the name of the thread group for which this event was recorded</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of the thread group</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHostname()"> |
| <h3>getHostname</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">getHostname</span>()</div> |
| <div class="block">Get the name of the host for which this event was recorded</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of the host</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTransactionSampleEvent()"> |
| <h3>isTransactionSampleEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isTransactionSampleEvent</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the isTransactionSampleEvent</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> |
