| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>TopologyUtils (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="TopologyUtils (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.api.utils</a></div> |
| <h2 title="Class TopologyUtils" class="title">Class TopologyUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.api.utils.TopologyUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">TopologyUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utility to process TopologyAPI.Topology proto</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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 java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdditionalClassPath(org.apache.heron.api.generated.TopologyAPI.Topology)">getAdditionalClassPath</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCheckpointManagerRam(org.apache.heron.api.generated.TopologyAPI.Topology)">getCheckpointManagerRam</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected static java.util.Map<java.lang.String,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentConfigMap(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">getComponentConfigMap</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.lang.String key)</code></th> |
| <td class="colLast"> |
| <div class="block">This is a util function to parse cpumap, rammap and diskmap.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static java.util.Map<java.lang.String,​java.lang.Double></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentCpuMapConfig(org.apache.heron.api.generated.TopologyAPI.Topology)">getComponentCpuMapConfig</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> |
| <div class="block">Parses the value in Config.TOPOLOGY_COMPONENT_CPUMAP, |
| and returns a map containing only component specified.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.util.Map<java.lang.String,​<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentDiskMapConfig(org.apache.heron.api.generated.TopologyAPI.Topology)">getComponentDiskMapConfig</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> |
| <div class="block">Parses the value in Config.TOPOLOGY_COMPONENT_DISKMAP, |
| and returns a map containing only component specified.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentJvmOptions(org.apache.heron.api.generated.TopologyAPI.Topology)">getComponentJvmOptions</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static java.util.Map<java.lang.String,​java.lang.Integer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentParallelism(org.apache.heron.api.generated.TopologyAPI.Topology)">getComponentParallelism</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static java.util.Map<java.lang.String,​<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentRamMapConfig(org.apache.heron.api.generated.TopologyAPI.Topology)">getComponentRamMapConfig</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> |
| <div class="block">Parses the value in Config.TOPOLOGY_COMPONENT_RAMMAP, |
| and returns a map containing only component specified.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithDefault(java.util.List,java.lang.String,boolean)">getConfigWithDefault</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| boolean defaultValue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.Double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithDefault(java.util.List,java.lang.String,java.lang.Double)">getConfigWithDefault</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.Double defaultValue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static java.lang.Integer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithDefault(java.util.List,java.lang.String,java.lang.Integer)">getConfigWithDefault</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.Integer defaultValue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithDefault(java.util.List,java.lang.String,java.lang.Long)">getConfigWithDefault</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.Long defaultValue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithDefault(java.util.List,java.lang.String,java.lang.String)">getConfigWithDefault</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.String defaultValue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithDefault(java.util.List,java.lang.String,org.apache.heron.common.basics.ByteAmount)">getConfigWithDefault</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> defaultValue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigWithException(java.util.List,java.lang.String)">getConfigWithException</a></span>​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstanceJvmOptions(org.apache.heron.api.generated.TopologyAPI.Topology)">getInstanceJvmOptions</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumContainers(org.apache.heron.api.generated.TopologyAPI.Topology)">getNumContainers</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTopology(java.lang.String)">getTopology</a></span>​(java.lang.String topologyDefnFile)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTopologyRemoteDebuggingEnabled(org.apache.heron.api.generated.TopologyAPI.Topology)">getTopologyRemoteDebuggingEnabled</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalInstance(java.util.Map)">getTotalInstance</a></span>​(java.util.Map<java.lang.String,​java.lang.Integer> parallelismMap)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalInstance(org.apache.heron.api.generated.TopologyAPI.Topology)">getTotalInstance</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lookUpTopologyDefnFile(java.lang.String,java.lang.String)">lookUpTopologyDefnFile</a></span>​(java.lang.String dir, |
| java.lang.String filename)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeClassPath(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">makeClassPath</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.lang.String originalPackageFile)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldStartCkptMgr(org.apache.heron.api.generated.TopologyAPI.Topology)">shouldStartCkptMgr</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateTopology(org.apache.heron.api.generated.TopologyAPI.Topology)">validateTopology</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> |
| <div class="block">Throw a IllegalArgumentException if verifyTopology returns false</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verifyTopology(org.apache.heron.api.generated.TopologyAPI.Topology)">verifyTopology</a></span>​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> |
| <div class="block">Verify if the given topology has all the necessary information</div> |
| </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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getTopology(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopology</h4> |
| <pre class="methodSignature">public static <a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> getTopology​(java.lang.String topologyDefnFile) |
| throws <a href="../exception/InvalidTopologyException.html" title="class in org.apache.heron.api.exception">InvalidTopologyException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exception/InvalidTopologyException.html" title="class in org.apache.heron.api.exception">InvalidTopologyException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConfigWithDefault(java.util.List,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithDefault</h4> |
| <pre class="methodSignature">public static java.lang.String getConfigWithDefault​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.String defaultValue)</pre> |
| </li> |
| </ul> |
| <a id="getConfigWithDefault(java.util.List,java.lang.String,java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithDefault</h4> |
| <pre class="methodSignature">public static java.lang.Long getConfigWithDefault​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.Long defaultValue)</pre> |
| </li> |
| </ul> |
| <a id="getConfigWithDefault(java.util.List,java.lang.String,java.lang.Integer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithDefault</h4> |
| <pre class="methodSignature">public static java.lang.Integer getConfigWithDefault​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.Integer defaultValue)</pre> |
| </li> |
| </ul> |
| <a id="getConfigWithDefault(java.util.List,java.lang.String,java.lang.Double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithDefault</h4> |
| <pre class="methodSignature">public static java.lang.Double getConfigWithDefault​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| java.lang.Double defaultValue)</pre> |
| </li> |
| </ul> |
| <a id="getConfigWithDefault(java.util.List,java.lang.String,org.apache.heron.common.basics.ByteAmount)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithDefault</h4> |
| <pre class="methodSignature">public static <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> getConfigWithDefault​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> defaultValue)</pre> |
| </li> |
| </ul> |
| <a id="getConfigWithDefault(java.util.List,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithDefault</h4> |
| <pre class="methodSignature">public static java.lang.Boolean getConfigWithDefault​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key, |
| boolean defaultValue)</pre> |
| </li> |
| </ul> |
| <a id="getConfigWithException(java.util.List,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigWithException</h4> |
| <pre class="methodSignature">public static java.lang.String getConfigWithException​(java.util.List<<a href="../generated/TopologyAPI.Config.KeyValue.html" title="class in org.apache.heron.api.generated">TopologyAPI.Config.KeyValue</a>> config, |
| java.lang.String key)</pre> |
| </li> |
| </ul> |
| <a id="getComponentParallelism(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentParallelism</h4> |
| <pre class="methodSignature">public static java.util.Map<java.lang.String,​java.lang.Integer> getComponentParallelism​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="getInstanceJvmOptions(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstanceJvmOptions</h4> |
| <pre class="methodSignature">public static java.lang.String getInstanceJvmOptions​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="getComponentJvmOptions(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentJvmOptions</h4> |
| <pre class="methodSignature">public static java.lang.String getComponentJvmOptions​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="getTotalInstance(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalInstance</h4> |
| <pre class="methodSignature">public static int getTotalInstance​(java.util.Map<java.lang.String,​java.lang.Integer> parallelismMap)</pre> |
| </li> |
| </ul> |
| <a id="getTotalInstance(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalInstance</h4> |
| <pre class="methodSignature">public static int getTotalInstance​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="shouldStartCkptMgr(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldStartCkptMgr</h4> |
| <pre class="methodSignature">public static boolean shouldStartCkptMgr​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="getCheckpointManagerRam(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCheckpointManagerRam</h4> |
| <pre class="methodSignature">public static <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> getCheckpointManagerRam​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="validateTopology(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateTopology</h4> |
| <pre class="methodSignature">public static void validateTopology​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology) |
| throws <a href="../exception/InvalidTopologyException.html" title="class in org.apache.heron.api.exception">InvalidTopologyException</a></pre> |
| <div class="block">Throw a IllegalArgumentException if verifyTopology returns false</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topology</code> - to validate</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exception/InvalidTopologyException.html" title="class in org.apache.heron.api.exception">InvalidTopologyException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="verifyTopology(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>verifyTopology</h4> |
| <pre class="methodSignature">public static boolean verifyTopology​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| <div class="block">Verify if the given topology has all the necessary information</div> |
| </li> |
| </ul> |
| <a id="getAdditionalClassPath(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdditionalClassPath</h4> |
| <pre class="methodSignature">public static java.lang.String getAdditionalClassPath​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="getComponentCpuMapConfig(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentCpuMapConfig</h4> |
| <pre class="methodSignature">public static java.util.Map<java.lang.String,​java.lang.Double> getComponentCpuMapConfig​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology) |
| throws java.lang.RuntimeException</pre> |
| <div class="block">Parses the value in Config.TOPOLOGY_COMPONENT_CPUMAP, |
| and returns a map containing only component specified. |
| Returns a empty map if the Config is not set</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topology</code> - the topology def</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map (componentName -> cpu required)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.RuntimeException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentRamMapConfig(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentRamMapConfig</h4> |
| <pre class="methodSignature">public static java.util.Map<java.lang.String,​<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>> getComponentRamMapConfig​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology) |
| throws java.lang.RuntimeException</pre> |
| <div class="block">Parses the value in Config.TOPOLOGY_COMPONENT_RAMMAP, |
| and returns a map containing only component specified. |
| Returns a empty map if the Config is not set</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topology</code> - the topology def</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map (componentName -> RAM required)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.RuntimeException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentDiskMapConfig(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentDiskMapConfig</h4> |
| <pre class="methodSignature">public static java.util.Map<java.lang.String,​<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>> getComponentDiskMapConfig​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology) |
| throws java.lang.RuntimeException</pre> |
| <div class="block">Parses the value in Config.TOPOLOGY_COMPONENT_DISKMAP, |
| and returns a map containing only component specified. |
| Returns a empty map if the Config is not set</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topology</code> - the topology def</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map (componentName -> disk required)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.RuntimeException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentConfigMap(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentConfigMap</h4> |
| <pre class="methodSignature">protected static java.util.Map<java.lang.String,​java.lang.String> getComponentConfigMap​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.lang.String key) |
| throws java.lang.RuntimeException</pre> |
| <div class="block">This is a util function to parse cpumap, rammap and diskmap. A config example: |
| "spout1:1,spout2:1,bolt1:5". The function validates component name and throws exception |
| if any component name is wrong in the config.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.RuntimeException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumContainers(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumContainers</h4> |
| <pre class="methodSignature">public static int getNumContainers​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="makeClassPath(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeClassPath</h4> |
| <pre class="methodSignature">public static java.lang.String makeClassPath​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.lang.String originalPackageFile)</pre> |
| </li> |
| </ul> |
| <a id="lookUpTopologyDefnFile(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookUpTopologyDefnFile</h4> |
| <pre class="methodSignature">public static java.lang.String lookUpTopologyDefnFile​(java.lang.String dir, |
| java.lang.String filename)</pre> |
| </li> |
| </ul> |
| <a id="getTopologyRemoteDebuggingEnabled(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTopologyRemoteDebuggingEnabled</h4> |
| <pre class="methodSignature">public static boolean getTopologyRemoteDebuggingEnabled​(<a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
