blob: 7e9cb3332b8460647f07ca3871a54c9e5efce9d8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TopologyLoadConf (Storm 2.4.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TopologyLoadConf (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TopologyLoadConf.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/loadgen/ThroughputVsLatency.WordCount.html" title="class in org.apache.storm.loadgen"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/loadgen/TopologyLoadConf.html" target="_top">Frames</a></li>
<li><a href="TopologyLoadConf.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.storm.loadgen</div>
<h2 title="Class TopologyLoadConf" class="title">Class TopologyLoadConf</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.storm.loadgen.TopologyLoadConf</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">TopologyLoadConf</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>Configuration for a simulated topology.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#bolts">bolts</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#name">name</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#spouts">spouts</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/InputStream.html" title="class in org.apache.storm.loadgen">InputStream</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#streams">streams</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#topoConf">topoConf</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#TopologyLoadConf-java.lang.String-java.util.Map-java.util.List-java.util.List-java.util.List-">TopologyLoadConf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;topoConf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt;&nbsp;spouts,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt;&nbsp;bolts,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/InputStream.html" title="class in org.apache.storm.loadgen">InputStream</a>&gt;&nbsp;streams)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#anonymize--">anonymize</a></span>()</code>
<div class="block">Create a new version of this topology with identifiable information removed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#fromConf-java.io.File-">fromConf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</code>
<div class="block">Parse the TopologyLoadConf from a file in YAML format.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#fromConf-java.util.Map-">fromConf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf)</code>
<div class="block">Parse the TopologyLoadConf from a config map.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#getAllEmittedAggregate--">getAllEmittedAggregate</a></span>()</code>
<div class="block">Get the messages emitted per second in aggregate across all streams in the topology.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#getSpoutEmittedAggregate--">getSpoutEmittedAggregate</a></span>()</code>
<div class="block">Get the messages emitted per second in aggregate for all of the spouts in the topology.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#getTridentEstimatedEmittedAggregate--">getTridentEstimatedEmittedAggregate</a></span>()</code>
<div class="block">Try and guess at the actual number of messages emitted per second by a trident topology, not the number of batches.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#looksLikeTrident--">looksLikeTrident</a></span>()</code>
<div class="block">Try to see if this looks like a trident topology.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#overrideSlowExecs-java.util.Map-">overrideSlowExecs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/loadgen/SlowExecutorPattern.html" title="class in org.apache.storm.loadgen">SlowExecutorPattern</a>&gt;&nbsp;topoSpecific)</code>
<div class="block">Override the SlowExecutorPattern for given components.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#replaceShuffleWithLocalOrShuffle--">replaceShuffleWithLocalOrShuffle</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#scaleParallel-double-java.util.Map-">scaleParallel</a></span>(double&nbsp;v,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&gt;&nbsp;topoSpecific)</code>
<div class="block">Scale all of the components in the topology by a percentage (but keep the throughput the same).</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#scaleThroughput-double-java.util.Map-">scaleThroughput</a></span>(double&nbsp;v,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&gt;&nbsp;topoSpecific)</code>
<div class="block">Scale the throughput of the entire topology by a percentage.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#toConf--">toConf</a></span>()</code>
<div class="block">Covert this into a Map config.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#toYamlString--">toYamlString</a></span>()</code>
<div class="block">Convert this into a YAML String.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#withName-java.lang.String-">withName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;baseName)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html#writeTo-java.io.File-">writeTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</code>
<div class="block">Write this out to a file in YAML format.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre>
</li>
</ul>
<a name="topoConf">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topoConf</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt; topoConf</pre>
</li>
</ul>
<a name="spouts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spouts</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt; spouts</pre>
</li>
</ul>
<a name="bolts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bolts</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt; bolts</pre>
</li>
</ul>
<a name="streams">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>streams</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/InputStream.html" title="class in org.apache.storm.loadgen">InputStream</a>&gt; streams</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TopologyLoadConf-java.lang.String-java.util.Map-java.util.List-java.util.List-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TopologyLoadConf</h4>
<pre>public&nbsp;TopologyLoadConf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;topoConf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt;&nbsp;spouts,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&gt;&nbsp;bolts,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/storm/loadgen/InputStream.html" title="class in org.apache.storm.loadgen">InputStream</a>&gt;&nbsp;streams)</pre>
<div class="block"><p>Constructor.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the topology.</dd>
<dd><code>topoConf</code> - the config for the topology</dd>
<dd><code>spouts</code> - the spouts for the topology</dd>
<dd><code>bolts</code> - the bolts for the topology</dd>
<dd><code>streams</code> - the streams for the topology</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromConf-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromConf</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;fromConf(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><p>Parse the TopologyLoadConf from a file in YAML format.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - the file to read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed conf</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is an issue reading the file.</dd>
</dl>
</li>
</ul>
<a name="fromConf-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromConf</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;fromConf(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf)</pre>
<div class="block"><p>Parse the TopologyLoadConf from a config map.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - the config with the TopologyLoadConf in it</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed instance.</dd>
</dl>
</li>
</ul>
<a name="writeTo-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeTo</h4>
<pre>public&nbsp;void&nbsp;writeTo(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><p>Write this out to a file in YAML format.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - the file to write to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is an error writing to the file.</dd>
</dl>
</li>
</ul>
<a name="toYamlString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toYamlString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toYamlString()</pre>
<div class="block"><p>Convert this into a YAML String.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this as a YAML String.</dd>
</dl>
</li>
</ul>
<a name="toConf--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toConf</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;toConf()</pre>
<div class="block"><p>Covert this into a Map config.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this as a Map config.</dd>
</dl>
</li>
</ul>
<a name="withName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withName</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;withName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;baseName)</pre>
</li>
</ul>
<a name="scaleParallel-double-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scaleParallel</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;scaleParallel(double&nbsp;v,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&gt;&nbsp;topoSpecific)</pre>
<div class="block"><p>Scale all of the components in the topology by a percentage (but keep the throughput the same).</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v</code> - the amount to scale them by. 1.0 is nothing, 0.5 cuts them in half, 2.0 doubles them.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of this with the needed adjustments made.</dd>
</dl>
</li>
</ul>
<a name="scaleThroughput-double-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scaleThroughput</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;scaleThroughput(double&nbsp;v,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&gt;&nbsp;topoSpecific)</pre>
<div class="block"><p>Scale the throughput of the entire topology by a percentage.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v</code> - the amount to scale it by 1.0 is nothing 0.5 cuts it in half and 2.0 doubles it.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of this with the needed adjustments made.</dd>
</dl>
</li>
</ul>
<a name="overrideSlowExecs-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>overrideSlowExecs</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;overrideSlowExecs(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/loadgen/SlowExecutorPattern.html" title="class in org.apache.storm.loadgen">SlowExecutorPattern</a>&gt;&nbsp;topoSpecific)</pre>
<div class="block"><p>Override the SlowExecutorPattern for given components.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topoSpecific</code> - what we are going to use to override.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of this with the needed adjustments made.</dd>
</dl>
</li>
</ul>
<a name="anonymize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>anonymize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;anonymize()</pre>
<div class="block"><p>Create a new version of this topology with identifiable information removed.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the anonymized version of the TopologyLoadConf.</dd>
</dl>
</li>
</ul>
<a name="looksLikeTrident--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>looksLikeTrident</h4>
<pre>public&nbsp;boolean&nbsp;looksLikeTrident()</pre>
<div class="block"><p>Try to see if this looks like a trident topology. NOTE: this will not work for anonymized configs</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it does else false.</dd>
</dl>
</li>
</ul>
<a name="getAllEmittedAggregate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllEmittedAggregate</h4>
<pre>public&nbsp;double&nbsp;getAllEmittedAggregate()</pre>
<div class="block"><p>Get the messages emitted per second in aggregate across all streams in the topology.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>messages per second.</dd>
</dl>
</li>
</ul>
<a name="getSpoutEmittedAggregate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpoutEmittedAggregate</h4>
<pre>public&nbsp;double&nbsp;getSpoutEmittedAggregate()</pre>
<div class="block"><p>Get the messages emitted per second in aggregate for all of the spouts in the topology.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>messages per second.</dd>
</dl>
</li>
</ul>
<a name="getTridentEstimatedEmittedAggregate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTridentEstimatedEmittedAggregate</h4>
<pre>public&nbsp;double&nbsp;getTridentEstimatedEmittedAggregate()</pre>
<div class="block"><p>Try and guess at the actual number of messages emitted per second by a trident topology, not the number of batches. This does not work on an anonymized conf.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>messages per second or 0 if this does not look like a trident topology.</dd>
</dl>
</li>
</ul>
<a name="replaceShuffleWithLocalOrShuffle--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>replaceShuffleWithLocalOrShuffle</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/loadgen/TopologyLoadConf.html" title="class in org.apache.storm.loadgen">TopologyLoadConf</a>&nbsp;replaceShuffleWithLocalOrShuffle()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TopologyLoadConf.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/loadgen/ThroughputVsLatency.WordCount.html" title="class in org.apache.storm.loadgen"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/loadgen/TopologyLoadConf.html" target="_top">Frames</a></li>
<li><a href="TopologyLoadConf.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>