| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>TopologyContextImpl (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="TopologyContextImpl (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.common.utils.topology</a></div> |
| <h2 title="Class TopologyContextImpl" class="title">Class TopologyContextImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="GeneralTopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">org.apache.heron.common.utils.topology.GeneralTopologyContextImpl</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.common.utils.topology.TopologyContextImpl</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../../api/metric/IMetricsRegister.html" title="interface in org.apache.heron.api.metric">IMetricsRegister</a></code>, <code><a href="../../../api/topology/GeneralTopologyContext.html" title="interface in org.apache.heron.api.topology">GeneralTopologyContext</a></code>, <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">TopologyContextImpl</span> |
| extends <a href="GeneralTopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">GeneralTopologyContextImpl</a> |
| implements <a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></pre> |
| <div class="block">A TopologyContext is given to bolts and spouts in their "prepare" and "open" |
| methods, respectively. This object provides information about the component's |
| place within the topology, such as task ids, inputs and outputs, etc.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,org.apache.heron.api.generated.TopologyAPI.Topology,java.util.Map,int,org.apache.heron.common.utils.metrics.MetricsCollector)">TopologyContextImpl</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> clusterConfig, |
| <a href="../../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.util.Map<java.lang.Integer,​java.lang.String> taskToComponentMap, |
| int myTaskId, |
| <a href="../metrics/MetricsCollector.html" title="class in org.apache.heron.common.utils.metrics">MetricsCollector</a> metricsCollector)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTaskHook(org.apache.heron.api.hooks.ITaskHook)">addTaskHook</a></span>​(<a href="../../../api/hooks/ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a> hook)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a Task Hook for this instance</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../../../api/hooks/ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHooks()">getHooks</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the list of all task hooks</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTaskData(java.lang.String)">getTaskData</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThisComponentId()">getThisComponentId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the component id for this task.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../api/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="#getThisOutputFields(java.lang.String)">getThisOutputFields</a></span>​(java.lang.String streamId)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the declared output fields for the specified stream id for the component |
| this task is a part of.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<<a href="../../../api/generated/TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a>,​<a href="../../../api/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="#getThisSources()">getThisSources</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the declared inputs to this component.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThisStreams()">getThisStreams</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the set of streams declared for the component of this task.</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="../../../api/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="#getThisTargets()">getThisTargets</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets information about who is consuming the outputs of this component, and how.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThisTaskId()">getThisTaskId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the task id of this task.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThisTaskIndex()">getThisTaskIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the index of this task id in getComponentTasks(getThisComponentId()).</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookBoltAck(org.apache.heron.api.tuple.Tuple,java.time.Duration)">invokeHookBoltAck</a></span>​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple, |
| java.time.Duration processLatency)</code></th> |
| <td class="colLast"> |
| <div class="block">Task hook called in bolt every time a tuple gets acked</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookBoltExecute(org.apache.heron.api.tuple.Tuple,java.time.Duration)">invokeHookBoltExecute</a></span>​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple, |
| java.time.Duration executeLatency)</code></th> |
| <td class="colLast"> |
| <div class="block">Task hook called in bolt every time a tuple gets executed</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookBoltFail(org.apache.heron.api.tuple.Tuple,java.time.Duration)">invokeHookBoltFail</a></span>​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple, |
| java.time.Duration failLatency)</code></th> |
| <td class="colLast"> |
| <div class="block">Task hook called in bolt every time a tuple gets failed</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookCleanup()">invokeHookCleanup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Task Hook Called just before the spout/bolt's cleanup method is called.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookEmit(java.util.List,java.lang.String,java.util.Collection)">invokeHookEmit</a></span>​(java.util.List<java.lang.Object> values, |
| java.lang.String stream, |
| java.util.Collection<java.lang.Integer> outTasks)</code></th> |
| <td class="colLast"> |
| <div class="block">Task hook called every time a tuple is emitted in spout/bolt</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookPrepare()">invokeHookPrepare</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Task Hook Called just after the spout/bolt's prepare method is called.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookSpoutAck(java.lang.Object,java.time.Duration)">invokeHookSpoutAck</a></span>​(java.lang.Object messageId, |
| java.time.Duration completeLatency)</code></th> |
| <td class="colLast"> |
| <div class="block">Task hook called in spout every time a tuple gets acked</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeHookSpoutFail(java.lang.Object,java.time.Duration)">invokeHookSpoutFail</a></span>​(java.lang.Object messageId, |
| java.time.Duration failLatency)</code></th> |
| <td class="colLast"> |
| <div class="block">Task hook called in spout every time a tuple gets failed</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../api/metric/CombinedMetric.html" title="class in org.apache.heron.api.metric">CombinedMetric</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerMetric(java.lang.String,org.apache.heron.api.metric.ICombiner,int)">registerMetric</a></span>​(java.lang.String name, |
| <a href="../../../api/metric/ICombiner.html" title="interface in org.apache.heron.api.metric">ICombiner</a><T> combiner, |
| int timeBucketSizeInSecs)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><T,​U,​V><br><a href="../../../api/metric/ReducedMetric.html" title="class in org.apache.heron.api.metric">ReducedMetric</a><T,​U,​V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerMetric(java.lang.String,org.apache.heron.api.metric.IReducer,int)">registerMetric</a></span>​(java.lang.String name, |
| <a href="../../../api/metric/IReducer.html" title="interface in org.apache.heron.api.metric">IReducer</a><T,​U,​V> reducer, |
| int timeBucketSizeInSecs)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../../api/metric/IMetric.html" title="interface in org.apache.heron.api.metric">IMetric</a><U>,​U><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerMetric(java.lang.String,T,int)">registerMetric</a></span>​(java.lang.String name, |
| T metric, |
| int timeBucketSizeInSecs)</code></th> |
| <td class="colLast"> |
| <div class="block">Register an IMetric instance.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTaskData(java.lang.String,java.lang.Object)">setTaskData</a></span>​(java.lang.String name, |
| java.lang.Object data)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.common.utils.topology.GeneralTopologyContextImpl"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.common.utils.topology.<a href="GeneralTopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">GeneralTopologyContextImpl</a></h3> |
| <code><a href="GeneralTopologyContextImpl.html#getComponentId(int)">getComponentId</a>, <a href="GeneralTopologyContextImpl.html#getComponentIds()">getComponentIds</a>, <a href="GeneralTopologyContextImpl.html#getComponentOutputFields(java.lang.String,java.lang.String)">getComponentOutputFields</a>, <a href="GeneralTopologyContextImpl.html#getComponentStreams(java.lang.String)">getComponentStreams</a>, <a href="GeneralTopologyContextImpl.html#getComponentTasks(java.lang.String)">getComponentTasks</a>, <a href="GeneralTopologyContextImpl.html#getOutputToComponentsFields(java.util.List)">getOutputToComponentsFields</a>, <a href="GeneralTopologyContextImpl.html#getRawTopology()">getRawTopology</a>, <a href="GeneralTopologyContextImpl.html#getSources(java.lang.String)">getSources</a>, <a href="GeneralTopologyContextImpl.html#getTargets(java.lang.String)">getTargets</a>, <a href="GeneralTopologyContextImpl.html#getTaskToComponent()">getTaskToComponent</a>, <a href="GeneralTopologyContextImpl.html#getTopologyConfig()">getTopologyConfig</a>, <a href="GeneralTopologyContextImpl.html#getTopologyId()">getTopologyId</a>, <a href="GeneralTopologyContextImpl.html#maxTopologyMessageTimeout()">maxTopologyMessageTimeout</a></code></li> |
| </ul> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.topology.GeneralTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.heron.api.topology.<a href="../../../api/topology/GeneralTopologyContext.html" title="interface in org.apache.heron.api.topology">GeneralTopologyContext</a></h3> |
| <code><a href="../../../api/topology/GeneralTopologyContext.html#getComponentId(int)">getComponentId</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getComponentIds()">getComponentIds</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getComponentOutputFields(java.lang.String,java.lang.String)">getComponentOutputFields</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getComponentStreams(java.lang.String)">getComponentStreams</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getComponentTasks(java.lang.String)">getComponentTasks</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getRawTopology()">getRawTopology</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getSources(java.lang.String)">getSources</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getTargets(java.lang.String)">getTargets</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getTaskToComponent()">getTaskToComponent</a>, <a href="../../../api/topology/GeneralTopologyContext.html#getTopologyId()">getTopologyId</a>, <a href="../../../api/topology/GeneralTopologyContext.html#maxTopologyMessageTimeout()">maxTopologyMessageTimeout</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.util.Map,org.apache.heron.api.generated.TopologyAPI.Topology,java.util.Map,int,org.apache.heron.common.utils.metrics.MetricsCollector)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TopologyContextImpl</h4> |
| <pre>public TopologyContextImpl​(java.util.Map<java.lang.String,​java.lang.Object> clusterConfig, |
| <a href="../../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.util.Map<java.lang.Integer,​java.lang.String> taskToComponentMap, |
| int myTaskId, |
| <a href="../metrics/MetricsCollector.html" title="class in org.apache.heron.common.utils.metrics">MetricsCollector</a> metricsCollector)</pre> |
| </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="invokeHookPrepare()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookPrepare</h4> |
| <pre class="methodSignature">public void invokeHookPrepare()</pre> |
| <div class="block">Task Hook Called just after the spout/bolt's prepare method is called.</div> |
| </li> |
| </ul> |
| <a id="invokeHookCleanup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookCleanup</h4> |
| <pre class="methodSignature">public void invokeHookCleanup()</pre> |
| <div class="block">Task Hook Called just before the spout/bolt's cleanup method is called.</div> |
| </li> |
| </ul> |
| <a id="invokeHookEmit(java.util.List,java.lang.String,java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookEmit</h4> |
| <pre class="methodSignature">public void invokeHookEmit​(java.util.List<java.lang.Object> values, |
| java.lang.String stream, |
| java.util.Collection<java.lang.Integer> outTasks)</pre> |
| <div class="block">Task hook called every time a tuple is emitted in spout/bolt</div> |
| </li> |
| </ul> |
| <a id="invokeHookSpoutAck(java.lang.Object,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookSpoutAck</h4> |
| <pre class="methodSignature">public void invokeHookSpoutAck​(java.lang.Object messageId, |
| java.time.Duration completeLatency)</pre> |
| <div class="block">Task hook called in spout every time a tuple gets acked</div> |
| </li> |
| </ul> |
| <a id="invokeHookSpoutFail(java.lang.Object,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookSpoutFail</h4> |
| <pre class="methodSignature">public void invokeHookSpoutFail​(java.lang.Object messageId, |
| java.time.Duration failLatency)</pre> |
| <div class="block">Task hook called in spout every time a tuple gets failed</div> |
| </li> |
| </ul> |
| <a id="invokeHookBoltExecute(org.apache.heron.api.tuple.Tuple,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookBoltExecute</h4> |
| <pre class="methodSignature">public void invokeHookBoltExecute​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple, |
| java.time.Duration executeLatency)</pre> |
| <div class="block">Task hook called in bolt every time a tuple gets executed</div> |
| </li> |
| </ul> |
| <a id="invokeHookBoltAck(org.apache.heron.api.tuple.Tuple,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookBoltAck</h4> |
| <pre class="methodSignature">public void invokeHookBoltAck​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple, |
| java.time.Duration processLatency)</pre> |
| <div class="block">Task hook called in bolt every time a tuple gets acked</div> |
| </li> |
| </ul> |
| <a id="invokeHookBoltFail(org.apache.heron.api.tuple.Tuple,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeHookBoltFail</h4> |
| <pre class="methodSignature">public void invokeHookBoltFail​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple, |
| java.time.Duration failLatency)</pre> |
| <div class="block">Task hook called in bolt every time a tuple gets failed</div> |
| </li> |
| </ul> |
| <a id="getThisTaskId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisTaskId</h4> |
| <pre class="methodSignature">public int getThisTaskId()</pre> |
| <div class="block">Gets the task id of this task.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisTaskId()">getThisTaskId</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the task id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThisComponentId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisComponentId</h4> |
| <pre class="methodSignature">public java.lang.String getThisComponentId()</pre> |
| <div class="block">Gets the component id for this task. The component id maps |
| to a component id specified for a Spout or Bolt in the topology definition.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisComponentId()">getThisComponentId</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThisOutputFields(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisOutputFields</h4> |
| <pre class="methodSignature">public <a href="../../../api/tuple/Fields.html" title="class in org.apache.heron.api.tuple">Fields</a> getThisOutputFields​(java.lang.String streamId)</pre> |
| <div class="block">Gets the declared output fields for the specified stream id for the component |
| this task is a part of.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisOutputFields(java.lang.String)">getThisOutputFields</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThisStreams()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisStreams</h4> |
| <pre class="methodSignature">public java.util.Set<java.lang.String> getThisStreams()</pre> |
| <div class="block">Gets the set of streams declared for the component of this task.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisStreams()">getThisStreams</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThisTaskIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisTaskIndex</h4> |
| <pre class="methodSignature">public int getThisTaskIndex()</pre> |
| <div class="block">Gets the index of this task id in getComponentTasks(getThisComponentId()). |
| An example use case for this method is determining which task |
| accesses which resource in a distributed resource to ensure an even distribution.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisTaskIndex()">getThisTaskIndex</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThisSources()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisSources</h4> |
| <pre class="methodSignature">public java.util.Map<<a href="../../../api/generated/TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a>,​<a href="../../../api/generated/TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a>> getThisSources()</pre> |
| <div class="block">Gets the declared inputs to this component.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisSources()">getThisSources</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| <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="getThisTargets()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisTargets</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​<a href="../../../api/generated/TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a>>> getThisTargets()</pre> |
| <div class="block">Gets information about who is consuming the outputs of this component, and how.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getThisTargets()">getThisTargets</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| <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="setTaskData(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTaskData</h4> |
| <pre class="methodSignature">public void setTaskData​(java.lang.String name, |
| java.lang.Object data)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#setTaskData(java.lang.String,java.lang.Object)">setTaskData</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTaskData(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTaskData</h4> |
| <pre class="methodSignature">public java.lang.Object getTaskData​(java.lang.String name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getTaskData(java.lang.String)">getTaskData</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="registerMetric(java.lang.String,org.apache.heron.api.metric.IMetric,int)"> |
| <!-- --> |
| </a><a id="registerMetric(java.lang.String,T,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetric</h4> |
| <pre class="methodSignature">public <T extends <a href="../../../api/metric/IMetric.html" title="interface in org.apache.heron.api.metric">IMetric</a><U>,​U> T registerMetric​(java.lang.String name, |
| T metric, |
| int timeBucketSizeInSecs)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../api/metric/IMetricsRegister.html#registerMetric(java.lang.String,T,int)">IMetricsRegister</a></code></span></div> |
| <div class="block">Register an IMetric instance. |
| Heron will then call getValueAndReset on the metric every timeBucketSizeInSecs |
| and the returned value is sent to all metrics consumers. |
| You must call this during IBolt::prepare or ISpout::open.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/metric/IMetricsRegister.html#registerMetric(java.lang.String,T,int)">registerMetric</a></code> in interface <code><a href="../../../api/metric/IMetricsRegister.html" title="interface in org.apache.heron.api.metric">IMetricsRegister</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The IMetric argument unchanged.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="registerMetric(java.lang.String,org.apache.heron.api.metric.IReducer,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetric</h4> |
| <pre class="methodSignature">public <T,​U,​V> <a href="../../../api/metric/ReducedMetric.html" title="class in org.apache.heron.api.metric">ReducedMetric</a><T,​U,​V> registerMetric​(java.lang.String name, |
| <a href="../../../api/metric/IReducer.html" title="interface in org.apache.heron.api.metric">IReducer</a><T,​U,​V> reducer, |
| int timeBucketSizeInSecs)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#registerMetric(java.lang.String,org.apache.heron.api.metric.IReducer,int)">registerMetric</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="registerMetric(java.lang.String,org.apache.heron.api.metric.ICombiner,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetric</h4> |
| <pre class="methodSignature">public <T> <a href="../../../api/metric/CombinedMetric.html" title="class in org.apache.heron.api.metric">CombinedMetric</a><T> registerMetric​(java.lang.String name, |
| <a href="../../../api/metric/ICombiner.html" title="interface in org.apache.heron.api.metric">ICombiner</a><T> combiner, |
| int timeBucketSizeInSecs)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#registerMetric(java.lang.String,org.apache.heron.api.metric.ICombiner,int)">registerMetric</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addTaskHook(org.apache.heron.api.hooks.ITaskHook)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTaskHook</h4> |
| <pre class="methodSignature">public void addTaskHook​(<a href="../../../api/hooks/ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a> hook)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../api/topology/TopologyContext.html#addTaskHook(org.apache.heron.api.hooks.ITaskHook)">TopologyContext</a></code></span></div> |
| <div class="block">Add a Task Hook for this instance</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#addTaskHook(org.apache.heron.api.hooks.ITaskHook)">addTaskHook</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHooks()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHooks</h4> |
| <pre class="methodSignature">public java.util.Collection<<a href="../../../api/hooks/ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a>> getHooks()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../api/topology/TopologyContext.html#getHooks()">TopologyContext</a></code></span></div> |
| <div class="block">Get the list of all task hooks</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../api/topology/TopologyContext.html#getHooks()">getHooks</a></code> in interface <code><a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a></code></dd> |
| </dl> |
| </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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
