| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>AssertPacking (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/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="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AssertPacking (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.packing</a></div> |
| <h2 title="Class AssertPacking" class="title">Class AssertPacking</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.packing.AssertPacking</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">AssertPacking</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utility methods for common test assertions related to packing</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DELTA">DELTA</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertContainerCpu(java.util.Set,double)">assertContainerCpu</a></span>​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| double maxCpuforResources)</code></th> |
| <td class="colLast"> |
| <div class="block">Verifies that the CPU allocated for every container in a packing plan is less than a given |
| maximum value.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertContainerRam(java.util.Set,org.apache.heron.common.basics.ByteAmount)">assertContainerRam</a></span>​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| <a href="../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> maxRamforResources)</code></th> |
| <td class="colLast"> |
| <div class="block">Verifies that the RAM allocated for every container in a packing plan is less than a given |
| maximum value.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertInstanceCpu(java.util.Set,java.lang.String,java.lang.String,java.lang.Double,java.lang.Double)">assertInstanceCpu</a></span>​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String boltName, |
| java.lang.String spoutName, |
| java.lang.Double expectedBoltCpu, |
| java.lang.Double expectedSpoutCpu)</code></th> |
| <td class="colLast"> |
| <div class="block">Verifies that the containerPlan has at least one bolt named boltName with CPU equal to |
| expectedBoltCpu and likewise for spouts.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertInstanceIndices(java.util.Set,java.lang.String,java.lang.String)">assertInstanceIndices</a></span>​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String boltName, |
| java.lang.String spoutName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertInstanceRam(java.util.Set,java.lang.String,java.lang.String,org.apache.heron.common.basics.ByteAmount,org.apache.heron.common.basics.ByteAmount)">assertInstanceRam</a></span>​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String boltName, |
| java.lang.String spoutName, |
| <a href="../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> expectedBoltRam, |
| <a href="../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> expectedSpoutRam)</code></th> |
| <td class="colLast"> |
| <div class="block">Verifies that the containerPlan has at least one bolt named boltName with RAM equal to |
| expectedBoltRam and likewise for spouts.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertNumInstances(java.util.Set,java.lang.String,int)">assertNumInstances</a></span>​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String component, |
| int numInstances)</code></th> |
| <td class="colLast"> |
| <div class="block">Verifies that the containerPlan contains a specific number of instances for the given component.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertPackingPlan(java.lang.String,org.apache.heron.common.basics.Pair%5B%5D,org.apache.heron.spi.packing.PackingPlan)">assertPackingPlan</a></span>​(java.lang.String expectedTopologyName, |
| <a href="../common/basics/Pair.html" title="class in org.apache.heron.common.basics">Pair</a><java.lang.Integer,​<a href="../spi/packing/InstanceId.html" title="class in org.apache.heron.spi.packing">InstanceId</a>>[] expectedComponentInstances, |
| <a href="../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> plan)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="DELTA"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DELTA</h4> |
| <pre>public static final double DELTA</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.heron.packing.AssertPacking.DELTA">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="assertInstanceRam(java.util.Set,java.lang.String,java.lang.String,org.apache.heron.common.basics.ByteAmount,org.apache.heron.common.basics.ByteAmount)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertInstanceRam</h4> |
| <pre class="methodSignature">public static void assertInstanceRam​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String boltName, |
| java.lang.String spoutName, |
| <a href="../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> expectedBoltRam, |
| <a href="../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> expectedSpoutRam)</pre> |
| <div class="block">Verifies that the containerPlan has at least one bolt named boltName with RAM equal to |
| expectedBoltRam and likewise for spouts. If notExpectedContainerRam is not null, verifies that |
| the container RAM is not that.</div> |
| </li> |
| </ul> |
| <a id="assertInstanceCpu(java.util.Set,java.lang.String,java.lang.String,java.lang.Double,java.lang.Double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertInstanceCpu</h4> |
| <pre class="methodSignature">public static void assertInstanceCpu​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String boltName, |
| java.lang.String spoutName, |
| java.lang.Double expectedBoltCpu, |
| java.lang.Double expectedSpoutCpu)</pre> |
| <div class="block">Verifies that the containerPlan has at least one bolt named boltName with CPU equal to |
| expectedBoltCpu and likewise for spouts. If notExpectedContainerCpu is not null, verifies that |
| the container CPU is not that.</div> |
| </li> |
| </ul> |
| <a id="assertInstanceIndices(java.util.Set,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertInstanceIndices</h4> |
| <pre class="methodSignature">public static void assertInstanceIndices​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String boltName, |
| java.lang.String spoutName)</pre> |
| </li> |
| </ul> |
| <a id="assertNumInstances(java.util.Set,java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertNumInstances</h4> |
| <pre class="methodSignature">public static void assertNumInstances​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| java.lang.String component, |
| int numInstances)</pre> |
| <div class="block">Verifies that the containerPlan contains a specific number of instances for the given component.</div> |
| </li> |
| </ul> |
| <a id="assertContainerRam(java.util.Set,org.apache.heron.common.basics.ByteAmount)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertContainerRam</h4> |
| <pre class="methodSignature">public static void assertContainerRam​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| <a href="../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> maxRamforResources)</pre> |
| <div class="block">Verifies that the RAM allocated for every container in a packing plan is less than a given |
| maximum value.</div> |
| </li> |
| </ul> |
| <a id="assertContainerCpu(java.util.Set,double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertContainerCpu</h4> |
| <pre class="methodSignature">public static void assertContainerCpu​(java.util.Set<<a href="../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>> containerPlans, |
| double maxCpuforResources)</pre> |
| <div class="block">Verifies that the CPU allocated for every container in a packing plan is less than a given |
| maximum value.</div> |
| </li> |
| </ul> |
| <a id="assertPackingPlan(java.lang.String,org.apache.heron.common.basics.Pair[],org.apache.heron.spi.packing.PackingPlan)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>assertPackingPlan</h4> |
| <pre class="methodSignature">public static void assertPackingPlan​(java.lang.String expectedTopologyName, |
| <a href="../common/basics/Pair.html" title="class in org.apache.heron.common.basics">Pair</a><java.lang.Integer,​<a href="../spi/packing/InstanceId.html" title="class in org.apache.heron.spi.packing">InstanceId</a>>[] expectedComponentInstances, |
| <a href="../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> plan)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
