| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>GeneralTopologyContext (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="GeneralTopologyContext (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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.topology</a></div> |
| <h2 title="Interface GeneralTopologyContext" class="title">Interface GeneralTopologyContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../common/utils/topology/GeneralTopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">GeneralTopologyContextImpl</a></code>, <code><a href="../../integration_test/core/TestTopologyContext.html" title="class in org.apache.heron.integration_test.core">TestTopologyContext</a></code>, <code><a href="../../common/utils/topology/TopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">TopologyContextImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">GeneralTopologyContext</span></pre> |
| </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentId(int)">getComponentId</a></span>​(int taskId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the component id for the specified task id.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentIds()">getComponentIds</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a list of all component ids in this topology</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../tuple/Fields.html" title="class in org.apache.heron.api.tuple">Fields</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentOutputFields(java.lang.String,java.lang.String)">getComponentOutputFields</a></span>​(java.lang.String componentId, |
| java.lang.String streamId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the declared output fields for the specified component/stream.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentStreams(java.lang.String)">getComponentStreams</a></span>​(java.lang.String componentId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the set of streams declared for the specified component.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.Integer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentTasks(java.lang.String)">getComponentTasks</a></span>​(java.lang.String componentId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the task ids allocated for the given component id.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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="#getRawTopology()">getRawTopology</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">for backwards compatibility purposes</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<<a href="../generated/TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a>,​<a href="../generated/TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSources(java.lang.String)">getSources</a></span>​(java.lang.String componentId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the declared inputs to the specified component.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​<a href="../generated/TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargets(java.lang.String)">getTargets</a></span>​(java.lang.String componentId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets information about who is consuming the outputs of the specified component, |
| and how.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTaskToComponent()">getTaskToComponent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a map from task id to component id.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTopologyId()">getTopologyId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the unique id assigned to this topology.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxTopologyMessageTimeout()">maxTopologyMessageTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </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="getTopologyId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopologyId</h4> |
| <pre class="methodSignature">java.lang.String getTopologyId()</pre> |
| <div class="block">Gets the unique id assigned to this topology. The id is the topology name with a |
| unique nonce appended to it.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the topology id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRawTopology()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRawTopology</h4> |
| <pre class="methodSignature">@Deprecated |
| <a href="../generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> getRawTopology()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">for backwards compatibility purposes</div> |
| </div> |
| <div class="block">Gets the Protobuf object representing the topology. |
| Deprecated. Only for storm compatiblity purposes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Protobuf definition representing the topology</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentId(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentId</h4> |
| <pre class="methodSignature">java.lang.String getComponentId​(int taskId)</pre> |
| <div class="block">Gets the component id for the specified task id. The component id maps |
| to a component id specified for a Spout or Bolt in the topology definition.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>taskId</code> - the task id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the component id for the input task id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentStreams(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentStreams</h4> |
| <pre class="methodSignature">java.util.Set<java.lang.String> getComponentStreams​(java.lang.String componentId)</pre> |
| <div class="block">Gets the set of streams declared for the specified component.</div> |
| </li> |
| </ul> |
| <a id="getComponentTasks(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentTasks</h4> |
| <pre class="methodSignature">java.util.List<java.lang.Integer> getComponentTasks​(java.lang.String componentId)</pre> |
| <div class="block">Gets the task ids allocated for the given component id. The task ids are |
| always returned in ascending order.</div> |
| </li> |
| </ul> |
| <a id="getComponentOutputFields(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentOutputFields</h4> |
| <pre class="methodSignature"><a href="../tuple/Fields.html" title="class in org.apache.heron.api.tuple">Fields</a> getComponentOutputFields​(java.lang.String componentId, |
| java.lang.String streamId)</pre> |
| <div class="block">Gets the declared output fields for the specified component/stream.</div> |
| </li> |
| </ul> |
| <a id="getSources(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSources</h4> |
| <pre class="methodSignature">java.util.Map<<a href="../generated/TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a>,​<a href="../generated/TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a>> getSources​(java.lang.String componentId)</pre> |
| <div class="block">Gets the declared inputs to the specified component.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A map from subscribed component/stream to the grouping subscribed with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTargets(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTargets</h4> |
| <pre class="methodSignature">java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​<a href="../generated/TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a>>> getTargets​(java.lang.String componentId)</pre> |
| <div class="block">Gets information about who is consuming the outputs of the specified component, |
| and how.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map from stream id to component id to the Grouping used.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTaskToComponent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTaskToComponent</h4> |
| <pre class="methodSignature">java.util.Map<java.lang.Integer,​java.lang.String> getTaskToComponent()</pre> |
| <div class="block">Gets a map from task id to component id.</div> |
| </li> |
| </ul> |
| <a id="getComponentIds()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentIds</h4> |
| <pre class="methodSignature">java.util.Set<java.lang.String> getComponentIds()</pre> |
| <div class="block">Gets a list of all component ids in this topology</div> |
| </li> |
| </ul> |
| <a id="maxTopologyMessageTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>maxTopologyMessageTimeout</h4> |
| <pre class="methodSignature">int maxTopologyMessageTimeout()</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> |