| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TopologyContext (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TopologyContext (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"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":42,"i20":42,"i21":42,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TopologyContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/task/ShellBolt.html" title="class in org.apache.storm.task"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/task/WorkerTopologyContext.html" title="class in org.apache.storm.task"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/task/TopologyContext.html" target="_top">Frames</a></li> |
| <li><a href="TopologyContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.storm.task.WorkerTopologyContext">Field</a> | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.task</div> |
| <h2 title="Class TopologyContext" class="title">Class TopologyContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html" title="class in org.apache.storm.task">org.apache.storm.task.GeneralTopologyContext</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/storm/task/WorkerTopologyContext.html" title="class in org.apache.storm.task">org.apache.storm.task.WorkerTopologyContext</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.task.TopologyContext</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.storm.shade.org.json.simple.JSONAware, <a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TopologyContext</span> |
| extends <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html" title="class in org.apache.storm.task">WorkerTopologyContext</a> |
| implements <a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></pre> |
| <div class="block"><p>A <code>TopologyContext</code> is given to bolts and spouts in their <code>prepare()</code> and <code>open()</code> methods, respectively. This object provides information about the component’s place within the topology, such as task ids, inputs and outputs, etc.</p><p><p>The <code>TopologyContext</code> is also used to declare <code>ISubscribedState</code> objects to synchronize state with StateSpouts this object is subscribed to.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.storm.task.WorkerTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.storm.task.<a href="../../../../org/apache/storm/task/WorkerTopologyContext.html" title="class in org.apache.storm.task">WorkerTopologyContext</a></h3> |
| <code><a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#SHARED_EXECUTOR">SHARED_EXECUTOR</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.storm.task.GeneralTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.storm.task.<a href="../../../../org/apache/storm/task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></h3> |
| <code><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#doSanityCheck">doSanityCheck</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#topoConf">topoConf</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#TopologyContext-org.apache.storm.generated.StormTopology-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.lang.String-java.lang.String-java.lang.String-java.lang.Integer-java.lang.Integer-java.util.List-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.concurrent.atomic.AtomicBoolean-org.apache.storm.metrics2.StormMetricRegistry-">TopologyContext</a></span>(<a href="../../../../org/apache/storm/generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a> topology, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> topoConf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> taskToComponent, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>>> componentToSortedTasks, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a>>> componentToStreamToFields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> blobToLastKnownVersionShared, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stormId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> codeDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pidDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> taskId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> workerPort, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> workerTasks, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> defaultResources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> userResources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> executorData, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>>>> registeredMetrics, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a> openOrPrepareWasCalled, |
| <a href="../../../../org/apache/storm/metrics2/StormMetricRegistry.html" title="class in org.apache.storm.metrics2">StormMetricRegistry</a> metricRegistry)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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><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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#addTaskHook-org.apache.storm.hooks.ITaskHook-">addTaskHook</a></span>(<a href="../../../../org/apache/storm/hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a> hook)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getBlobToLastKnownVersion--">getBlobToLastKnownVersion</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getExecutorData-java.lang.String-">getExecutorData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/storm/hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getHooks--">getHooks</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getRegisteredMetricByName-java.lang.String-">getRegisteredMetricByName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getTaskData-java.lang.String-">getTaskData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisComponentId--">getThisComponentId</a></span>()</code> |
| <div class="block">Get component id.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisInputFields--">getThisInputFields</a></span>()</code> |
| <div class="block">Gets the declared input fields for this component.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisOutputFields-java.lang.String-">getThisOutputFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <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="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisOutputFieldsForStreams--">getThisOutputFieldsForStreams</a></span>()</code> |
| <div class="block">Gets the declared output fields for all streams for the component this task is a part of.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/storm/generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a>,<a href="../../../../org/apache/storm/generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisSources--">getThisSources</a></span>()</code> |
| <div class="block">Gets the declared inputs to this component.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisStreams--">getThisStreams</a></span>()</code> |
| <div class="block">Gets the set of streams declared for the component of this task.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisTargets--">getThisTargets</a></span>()</code> |
| <div class="block">Gets information about who is consuming the outputs of this component, and how.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisTaskId--">getThisTaskId</a></span>()</code> |
| <div class="block">Gets the task id of this task.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#getThisTaskIndex--">getThisTaskIndex</a></span>()</code> |
| <div class="block">Gets the index of this task id in getComponentTasks(getThisComponentId()).</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>com.codahale.metrics.Counter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerCounter-java.lang.String-">registerCounter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><T> com.codahale.metrics.Gauge<T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerGauge-java.lang.String-com.codahale.metrics.Gauge-">registerGauge</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| com.codahale.metrics.Gauge<T> gauge)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>com.codahale.metrics.Histogram</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerHistogram-java.lang.String-">registerHistogram</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>com.codahale.metrics.Meter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerMeter-java.lang.String-">registerMeter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/metric/api/CombinedMetric.html" title="class in org.apache.storm.metric.api">CombinedMetric</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerMetric-java.lang.String-org.apache.storm.metric.api.ICombiner-int-">registerMetric</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/storm/metric/api/ICombiner.html" title="interface in org.apache.storm.metric.api">ICombiner</a> combiner, |
| int timeBucketSizeInSecs)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/metric/api/ReducedMetric.html" title="class in org.apache.storm.metric.api">ReducedMetric</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerMetric-java.lang.String-org.apache.storm.metric.api.IReducer-int-">registerMetric</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/storm/metric/api/IReducer.html" title="interface in org.apache.storm.metric.api">IReducer</a> reducer, |
| int timeBucketSizeInSecs)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><T extends <a href="../../../../org/apache/storm/metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerMetric-java.lang.String-T-int-">registerMetric</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| T metric, |
| int timeBucketSizeInSecs)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerMetricSet-java.lang.String-com.codahale.metrics.MetricSet-">registerMetricSet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| com.codahale.metrics.MetricSet set)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>com.codahale.metrics.Timer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#registerTimer-java.lang.String-">registerTimer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#setAllSubscribedState-T-">setAllSubscribedState</a></span>(T obj)</code> |
| <div class="block">All state from all subscribed state spouts streams will be synced with the provided object.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#setExecutorData-java.lang.String-java.lang.Object-">setExecutorData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data)</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#setSubscribedState-java.lang.String-java.lang.String-T-">setSubscribedState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| T obj)</code> |
| <div class="block">Synchronizes the specified stream from the specified state spout component id with the provided ISubscribedState object.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><T extends <a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#setSubscribedState-java.lang.String-T-">setSubscribedState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| T obj)</code> |
| <div class="block">Synchronizes the default stream from the specified state spout component id with the provided ISubscribedState object.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#setTaskData-java.lang.String-java.lang.Object-">setTaskData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data)</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/task/TopologyContext.html#toJSONString--">toJSONString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.task.WorkerTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.storm.task.<a href="../../../../org/apache/storm/task/WorkerTopologyContext.html" title="class in org.apache.storm.task">WorkerTopologyContext</a></h3> |
| <code><a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getAssignmentId--">getAssignmentId</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getCodeDir--">getCodeDir</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getNodeToHost--">getNodeToHost</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getPIDDir--">getPIDDir</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getResource-java.lang.String-">getResource</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getSharedExecutor--">getSharedExecutor</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getTaskToNodePort--">getTaskToNodePort</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getThisWorkerPort--">getThisWorkerPort</a>, <a href="../../../../org/apache/storm/task/WorkerTopologyContext.html#getThisWorkerTasks--">getThisWorkerTasks</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.task.GeneralTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.storm.task.<a href="../../../../org/apache/storm/task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></h3> |
| <code><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#doSanityCheck--">doSanityCheck</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentCommon-java.lang.String-">getComponentCommon</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentId-int-">getComponentId</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentIds--">getComponentIds</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentOutputFields-org.apache.storm.generated.GlobalStreamId-">getComponentOutputFields</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentOutputFields-java.lang.String-java.lang.String-">getComponentOutputFields</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentStreams-java.lang.String-">getComponentStreams</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getComponentTasks-java.lang.String-">getComponentTasks</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getConf--">getConf</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getRawTopology--">getRawTopology</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getSources-java.lang.String-">getSources</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getStormId--">getStormId</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getTargets-java.lang.String-">getTargets</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#getTaskToComponent--">getTaskToComponent</a>, <a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#maxTopologyMessageTimeout--">maxTopologyMessageTimeout</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TopologyContext-org.apache.storm.generated.StormTopology-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.lang.String-java.lang.String-java.lang.String-java.lang.Integer-java.lang.Integer-java.util.List-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.concurrent.atomic.AtomicBoolean-org.apache.storm.metrics2.StormMetricRegistry-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TopologyContext</h4> |
| <pre>public TopologyContext(<a href="../../../../org/apache/storm/generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a> topology, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> topoConf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> taskToComponent, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>>> componentToSortedTasks, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a>>> componentToStreamToFields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> blobToLastKnownVersionShared, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stormId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> codeDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pidDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> taskId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> workerPort, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> workerTasks, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> defaultResources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> userResources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> executorData, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>>>> registeredMetrics, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a> openOrPrepareWasCalled, |
| <a href="../../../../org/apache/storm/metrics2/StormMetricRegistry.html" title="class in org.apache.storm.metrics2">StormMetricRegistry</a> metricRegistry)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setAllSubscribedState-org.apache.storm.state.ISubscribedState-"> |
| <!-- --> |
| </a><a name="setAllSubscribedState-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAllSubscribedState</h4> |
| <pre>public <T extends <a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>> T setAllSubscribedState(T obj)</pre> |
| <div class="block"><p>All state from all subscribed state spouts streams will be synced with the provided object.</p><p><p>It is recommended that your ISubscribedState object is kept as an instance variable of this object. The recommended usage of this method is as follows:</p><p><p><code>java _myState = context.setAllSubscribedState(new MyState());</code></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - Provided ISubscribedState implementation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the ISubscribedState object provided</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSubscribedState-java.lang.String-org.apache.storm.state.ISubscribedState-"> |
| <!-- --> |
| </a><a name="setSubscribedState-java.lang.String-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubscribedState</h4> |
| <pre>public <T extends <a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>> T setSubscribedState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| T obj)</pre> |
| <div class="block"><p>Synchronizes the default stream from the specified state spout component id with the provided ISubscribedState object.</p><p><p>The recommended usage of this method is as follows:</p><p><p><code>java _myState = context.setSubscribedState(componentId, new MyState());</code></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>componentId</code> - the id of the StateSpout component to subscribe to</dd> |
| <dd><code>obj</code> - Provided ISubscribedState implementation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the ISubscribedState object provided</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSubscribedState-java.lang.String-java.lang.String-org.apache.storm.state.ISubscribedState-"> |
| <!-- --> |
| </a><a name="setSubscribedState-java.lang.String-java.lang.String-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubscribedState</h4> |
| <pre>public <T extends <a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>> T setSubscribedState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| T obj)</pre> |
| <div class="block"><p>Synchronizes the specified stream from the specified state spout component id with the provided ISubscribedState object.</p><p><p>The recommended usage of this method is as follows:</p><p><p><code>java _myState = context.setSubscribedState(componentId, streamId, new MyState());</code></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>componentId</code> - the id of the StateSpout component to subscribe to</dd> |
| <dd><code>streamId</code> - the stream to subscribe to</dd> |
| <dd><code>obj</code> - Provided ISubscribedState implementation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the ISubscribedState object provided</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBlobToLastKnownVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBlobToLastKnownVersion</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> getBlobToLastKnownVersion()</pre> |
| </li> |
| </ul> |
| <a name="getThisTaskId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisTaskId</h4> |
| <pre>public int getThisTaskId()</pre> |
| <div class="block"><p>Gets the task id of this task.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the task id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getThisComponentId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisComponentId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getThisComponentId()</pre> |
| <div class="block"><p>Get component id.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the component id for this task. The component id maps to a component id specified for a Spout or Bolt in the topology definition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getThisOutputFields-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisOutputFields</h4> |
| <pre>public <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> getThisOutputFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>Gets the declared output fields for the specified stream id for the component this task is a part of.</p></div> |
| </li> |
| </ul> |
| <a name="getThisOutputFieldsForStreams--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisOutputFieldsForStreams</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> getThisOutputFieldsForStreams()</pre> |
| <div class="block"><p>Gets the declared output fields for all streams for the component this task is a part of.</p></div> |
| </li> |
| </ul> |
| <a name="getThisStreams--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisStreams</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getThisStreams()</pre> |
| <div class="block"><p>Gets the set of streams declared for the component of this task.</p></div> |
| </li> |
| </ul> |
| <a name="getThisTaskIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisTaskIndex</h4> |
| <pre>public int getThisTaskIndex()</pre> |
| <div class="block"><p>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.</p></div> |
| </li> |
| </ul> |
| <a name="getThisInputFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisInputFields</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>> getThisInputFields()</pre> |
| <div class="block"><p>Gets the declared input fields for this component.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A map from sources to streams to fields.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getThisSources--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisSources</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/storm/generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a>,<a href="../../../../org/apache/storm/generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>> getThisSources()</pre> |
| <div class="block"><p>Gets the declared inputs to this component.</p></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 name="getThisTargets--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThisTargets</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>>> getThisTargets()</pre> |
| <div class="block"><p>Gets information about who is consuming the outputs of this component, and how.</p></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 name="setTaskData-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTaskData</h4> |
| <pre>public void setTaskData(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data)</pre> |
| </li> |
| </ul> |
| <a name="getTaskData-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTaskData</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getTaskData(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </li> |
| </ul> |
| <a name="setExecutorData-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutorData</h4> |
| <pre>public void setExecutorData(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data)</pre> |
| </li> |
| </ul> |
| <a name="getExecutorData-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutorData</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getExecutorData(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </li> |
| </ul> |
| <a name="addTaskHook-org.apache.storm.hooks.ITaskHook-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTaskHook</h4> |
| <pre>public void addTaskHook(<a href="../../../../org/apache/storm/hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a> hook)</pre> |
| </li> |
| </ul> |
| <a name="getHooks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHooks</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/storm/hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a>> getHooks()</pre> |
| </li> |
| </ul> |
| <a name="toJSONString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJSONString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toJSONString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>toJSONString</code> in interface <code>org.apache.storm.shade.org.json.simple.JSONAware</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html#toJSONString--">toJSONString</a></code> in class <code><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMetric-java.lang.String-org.apache.storm.metric.api.IMetric-int-"> |
| <!-- --> |
| </a><a name="registerMetric-java.lang.String-T-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetric</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <T extends <a href="../../../../org/apache/storm/metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>> T registerMetric(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| T metric, |
| int timeBucketSizeInSecs)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetric-java.lang.String-T-int-">IMetricsContext</a></code></span></div> |
| <div class="block"><p>Register metric.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetric-java.lang.String-T-int-">registerMetric</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMetric-java.lang.String-org.apache.storm.metric.api.IReducer-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetric</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/storm/metric/api/ReducedMetric.html" title="class in org.apache.storm.metric.api">ReducedMetric</a> registerMetric(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/storm/metric/api/IReducer.html" title="interface in org.apache.storm.metric.api">IReducer</a> reducer, |
| int timeBucketSizeInSecs)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetric-java.lang.String-org.apache.storm.metric.api.IReducer-int-">IMetricsContext</a></code></span></div> |
| <div class="block"><p>Register metric.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetric-java.lang.String-org.apache.storm.metric.api.IReducer-int-">registerMetric</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMetric-java.lang.String-org.apache.storm.metric.api.ICombiner-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetric</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/storm/metric/api/CombinedMetric.html" title="class in org.apache.storm.metric.api">CombinedMetric</a> registerMetric(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/storm/metric/api/ICombiner.html" title="interface in org.apache.storm.metric.api">ICombiner</a> combiner, |
| int timeBucketSizeInSecs)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetric-java.lang.String-org.apache.storm.metric.api.ICombiner-int-">IMetricsContext</a></code></span></div> |
| <div class="block"><p>Register metric.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetric-java.lang.String-org.apache.storm.metric.api.ICombiner-int-">registerMetric</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegisteredMetricByName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegisteredMetricByName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/storm/metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a> getRegisteredMetricByName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block"><p>Get component’s metric from registered metrics by name. Notice: Normally, one component can only register one metric name once. But now registerMetric has a bug(<a href="https://issues.apache.org/jira/browse/STORM-254">https://issues.apache.org/jira/browse/STORM-254</a>) cause the same metric name can register twice. So we just return the first metric we meet.</p></div> |
| </li> |
| </ul> |
| <a name="registerTimer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerTimer</h4> |
| <pre>public com.codahale.metrics.Timer registerTimer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerTimer-java.lang.String-">registerTimer</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerHistogram-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerHistogram</h4> |
| <pre>public com.codahale.metrics.Histogram registerHistogram(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerHistogram-java.lang.String-">registerHistogram</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMeter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMeter</h4> |
| <pre>public com.codahale.metrics.Meter registerMeter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMeter-java.lang.String-">registerMeter</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerCounter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerCounter</h4> |
| <pre>public com.codahale.metrics.Counter registerCounter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerCounter-java.lang.String-">registerCounter</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerGauge-java.lang.String-com.codahale.metrics.Gauge-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerGauge</h4> |
| <pre>public <T> com.codahale.metrics.Gauge<T> registerGauge(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| com.codahale.metrics.Gauge<T> gauge)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerGauge-java.lang.String-com.codahale.metrics.Gauge-">registerGauge</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMetricSet-java.lang.String-com.codahale.metrics.MetricSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>registerMetricSet</h4> |
| <pre>public void registerMetricSet(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| com.codahale.metrics.MetricSet set)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/task/IMetricsContext.html#registerMetricSet-java.lang.String-com.codahale.metrics.MetricSet-">registerMetricSet</a></code> in interface <code><a href="../../../../org/apache/storm/task/IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TopologyContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/task/ShellBolt.html" title="class in org.apache.storm.task"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/task/WorkerTopologyContext.html" title="class in org.apache.storm.task"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/task/TopologyContext.html" target="_top">Frames</a></li> |
| <li><a href="TopologyContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.storm.task.WorkerTopologyContext">Field</a> | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
