| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TopologyContext (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.task, class: TopologyContext"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/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="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.task</a></div> |
| <h1 title="Class TopologyContext" class="title">Class TopologyContext</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="GeneralTopologyContext.html" title="class in org.apache.storm.task">org.apache.storm.task.GeneralTopologyContext</a> |
| <div class="inheritance"><a href="WorkerTopologyContext.html" title="class in org.apache.storm.task">org.apache.storm.task.WorkerTopologyContext</a> |
| <div class="inheritance">org.apache.storm.task.TopologyContext</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.apache.storm.shade.net.minidev.json.JSONAware</code>, <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TopologyContext</span> |
| <span class="extends-implements">extends <a href="WorkerTopologyContext.html" title="class in org.apache.storm.task">WorkerTopologyContext</a> |
| implements <a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></span></div> |
| <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. |
| |
| <p>The `TopologyContext` is also used to declare `ISubscribedState` objects to synchronize state with StateSpouts |
| this object is subscribed to.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.task.WorkerTopologyContext">Fields inherited from class org.apache.storm.task.<a href="WorkerTopologyContext.html" title="class in org.apache.storm.task">WorkerTopologyContext</a></h3> |
| <code><a href="WorkerTopologyContext.html#SHARED_EXECUTOR">SHARED_EXECUTOR</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.task.GeneralTopologyContext">Fields inherited from class org.apache.storm.task.<a href="GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></h3> |
| <code><a href="GeneralTopologyContext.html#doSanityCheck">doSanityCheck</a>, <a href="GeneralTopologyContext.html#topoConf">topoConf</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(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)" class="member-name-link">TopologyContext</a><wbr>(<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a> topology, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> taskToComponent, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>>> componentToSortedTasks, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a>>> componentToStreamToFields, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> blobToLastKnownVersionShared, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> stormId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> codeDir, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pidDir, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> taskId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> workerPort, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> workerTasks, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> defaultResources, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> userResources, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> executorData, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>>>> registeredMetrics, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicBoolean.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicBoolean</a> openOrPrepareWasCalled, |
| <a href="../metrics2/StormMetricRegistry.html" title="class in org.apache.storm.metrics2">StormMetricRegistry</a> metricRegistry)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addTaskHook(org.apache.storm.hooks.ITaskHook)" class="member-name-link">addTaskHook</a><wbr>(<a href="../hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a> hook)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlobToLastKnownVersion()" class="member-name-link">getBlobToLastKnownVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExecutorData(java.lang.String)" class="member-name-link">getExecutorData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fetches the executor-level data for the given name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHooks()" class="member-name-link">getHooks</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="../metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getRegisteredMetricByName(java.lang.String)" class="member-name-link">getRegisteredMetricByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTaskData(java.lang.String)" class="member-name-link">getTaskData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fetches the task-level data for the given name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisComponentId()" class="member-name-link">getThisComponentId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get component id.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisInputFields()" class="member-name-link">getThisInputFields</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the declared input fields for this component.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisOutputFields(java.lang.String)" class="member-name-link">getThisOutputFields</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the declared output fields for the specified stream id for the component this task is a part of.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisOutputFieldsForStreams()" class="member-name-link">getThisOutputFieldsForStreams</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the declared output fields for all streams for the component this task is a part of.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a>,<wbr><a href="../generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisSources()" class="member-name-link">getThisSources</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the declared inputs to this component.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisStreams()" class="member-name-link">getThisStreams</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the set of streams declared for the component of this task.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisTargets()" class="member-name-link">getThisTargets</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets information about who is consuming the outputs of this component, and how.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisTaskId()" class="member-name-link">getThisTaskId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the task id of this task.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThisTaskIndex()" class="member-name-link">getThisTaskIndex</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the index of this task id in getComponentTasks(getThisComponentId()).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.codahale.metrics.Counter</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerCounter(java.lang.String)" class="member-name-link">registerCounter</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> com.codahale.metrics.Gauge<T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerGauge(java.lang.String,com.codahale.metrics.Gauge)" class="member-name-link">registerGauge</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| com.codahale.metrics.Gauge<T> gauge)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.codahale.metrics.Histogram</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerHistogram(java.lang.String)" class="member-name-link">registerHistogram</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.codahale.metrics.Meter</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerMeter(java.lang.String)" class="member-name-link">registerMeter</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="../metric/api/CombinedMetric.html" title="class in org.apache.storm.metric.api">CombinedMetric</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#registerMetric(java.lang.String,org.apache.storm.metric.api.ICombiner,int)" class="member-name-link">registerMetric</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../metric/api/ICombiner.html" title="interface in org.apache.storm.metric.api">ICombiner</a> combiner, |
| int timeBucketSizeInSecs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="../metric/api/ReducedMetric.html" title="class in org.apache.storm.metric.api">ReducedMetric</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#registerMetric(java.lang.String,org.apache.storm.metric.api.IReducer,int)" class="member-name-link">registerMetric</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../metric/api/IReducer.html" title="interface in org.apache.storm.metric.api">IReducer</a> reducer, |
| int timeBucketSizeInSecs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><T extends <a href="../metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>><br>T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#registerMetric(java.lang.String,T,int)" class="member-name-link">registerMetric</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| T metric, |
| int timeBucketSizeInSecs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerMetricSet(java.lang.String,com.codahale.metrics.MetricSet)" class="member-name-link">registerMetricSet</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, |
| com.codahale.metrics.MetricSet set)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.codahale.metrics.Timer</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerTimer(java.lang.String)" class="member-name-link">registerTimer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="../state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>><br>T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAllSubscribedState(T)" class="member-name-link">setAllSubscribedState</a><wbr>(T obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">All state from all subscribed state spouts streams will be synced with the provided object.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setExecutorData(java.lang.String,java.lang.Object)" class="member-name-link">setExecutorData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> data)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the executor-level data for the given name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="../state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>><br>T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSubscribedState(java.lang.String,java.lang.String,T)" class="member-name-link">setSubscribedState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| T obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Synchronizes the specified stream from the specified state spout component id with the provided ISubscribedState object.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="../state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>><br>T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSubscribedState(java.lang.String,T)" class="member-name-link">setSubscribedState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| T obj)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Synchronizes the default stream from the specified state spout component id with the provided ISubscribedState object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTaskData(java.lang.String,java.lang.Object)" class="member-name-link">setTaskData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> data)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the task-level data for the given name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toJSONString()" class="member-name-link">toJSONString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.task.WorkerTopologyContext">Methods inherited from class org.apache.storm.task.<a href="WorkerTopologyContext.html" title="class in org.apache.storm.task">WorkerTopologyContext</a></h3> |
| <code><a href="WorkerTopologyContext.html#getAssignmentId()">getAssignmentId</a>, <a href="WorkerTopologyContext.html#getCodeDir()">getCodeDir</a>, <a href="WorkerTopologyContext.html#getNodeToHost()">getNodeToHost</a>, <a href="WorkerTopologyContext.html#getPIDDir()">getPIDDir</a>, <a href="WorkerTopologyContext.html#getResource(java.lang.String)">getResource</a>, <a href="WorkerTopologyContext.html#getSharedExecutor()">getSharedExecutor</a>, <a href="WorkerTopologyContext.html#getTaskToNodePort()">getTaskToNodePort</a>, <a href="WorkerTopologyContext.html#getThisWorkerPort()">getThisWorkerPort</a>, <a href="WorkerTopologyContext.html#getThisWorkerTasks()">getThisWorkerTasks</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.task.GeneralTopologyContext">Methods inherited from class org.apache.storm.task.<a href="GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></h3> |
| <code><a href="GeneralTopologyContext.html#doSanityCheck()">doSanityCheck</a>, <a href="GeneralTopologyContext.html#getComponentCommon(java.lang.String)">getComponentCommon</a>, <a href="GeneralTopologyContext.html#getComponentId(int)">getComponentId</a>, <a href="GeneralTopologyContext.html#getComponentIds()">getComponentIds</a>, <a href="GeneralTopologyContext.html#getComponentOutputFields(java.lang.String,java.lang.String)">getComponentOutputFields</a>, <a href="GeneralTopologyContext.html#getComponentOutputFields(org.apache.storm.generated.GlobalStreamId)">getComponentOutputFields</a>, <a href="GeneralTopologyContext.html#getComponentStreams(java.lang.String)">getComponentStreams</a>, <a href="GeneralTopologyContext.html#getComponentTasks(java.lang.String)">getComponentTasks</a>, <a href="GeneralTopologyContext.html#getConf()">getConf</a>, <a href="GeneralTopologyContext.html#getRawTopology()">getRawTopology</a>, <a href="GeneralTopologyContext.html#getSources(java.lang.String)">getSources</a>, <a href="GeneralTopologyContext.html#getStormId()">getStormId</a>, <a href="GeneralTopologyContext.html#getTargets(java.lang.String)">getTargets</a>, <a href="GeneralTopologyContext.html#getTaskToComponent()">getTaskToComponent</a>, <a href="GeneralTopologyContext.html#maxTopologyMessageTimeout()">maxTopologyMessageTimeout</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(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)"> |
| <h3>TopologyContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TopologyContext</span><wbr><span class="parameters">(<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a> topology, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> taskToComponent, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>>> componentToSortedTasks, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a>>> componentToStreamToFields, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> blobToLastKnownVersionShared, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> stormId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> codeDir, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pidDir, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> taskId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> workerPort, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> workerTasks, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> defaultResources, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> userResources, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> executorData, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>>>> registeredMetrics, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicBoolean.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicBoolean</a> openOrPrepareWasCalled, |
| <a href="../metrics2/StormMetricRegistry.html" title="class in org.apache.storm.metrics2">StormMetricRegistry</a> metricRegistry)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setAllSubscribedState(T)"> |
| <h3 id="setAllSubscribedState(org.apache.storm.state.ISubscribedState)">setAllSubscribedState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="../state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>></span> <span class="return-type">T</span> <span class="element-name">setAllSubscribedState</span><wbr><span class="parameters">(T obj)</span></div> |
| <div class="block">All state from all subscribed state spouts streams will be synced with the provided object. |
| |
| <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>```java _myState = context.setAllSubscribedState(new MyState()); ```</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>obj</code> - Provided ISubscribedState implementation</dd> |
| <dt>Returns:</dt> |
| <dd>Returns the ISubscribedState object provided</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSubscribedState(java.lang.String,T)"> |
| <h3 id="setSubscribedState(java.lang.String,org.apache.storm.state.ISubscribedState)">setSubscribedState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="../state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>></span> <span class="return-type">T</span> <span class="element-name">setSubscribedState</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| T obj)</span></div> |
| <div class="block">Synchronizes the default stream from the specified state spout component id with the provided ISubscribedState object. |
| |
| <p>The recommended usage of this method is as follows: |
| |
| <p>```java _myState = context.setSubscribedState(componentId, new MyState()); ```</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>componentId</code> - the id of the StateSpout component to subscribe to</dd> |
| <dd><code>obj</code> - Provided ISubscribedState implementation</dd> |
| <dt>Returns:</dt> |
| <dd>Returns the ISubscribedState object provided</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSubscribedState(java.lang.String,java.lang.String,T)"> |
| <h3 id="setSubscribedState(java.lang.String,java.lang.String,org.apache.storm.state.ISubscribedState)">setSubscribedState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="../state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a>></span> <span class="return-type">T</span> <span class="element-name">setSubscribedState</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| T obj)</span></div> |
| <div class="block">Synchronizes the specified stream from the specified state spout component id with the provided ISubscribedState object. |
| |
| <p>The recommended usage of this method is as follows: |
| |
| <p>```java _myState = context.setSubscribedState(componentId, streamId, new MyState()); ```</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>Returns the ISubscribedState object provided</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlobToLastKnownVersion()"> |
| <h3>getBlobToLastKnownVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">getBlobToLastKnownVersion</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisTaskId()"> |
| <h3>getThisTaskId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getThisTaskId</span>()</div> |
| <div class="block">Gets the task id of this task.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the task id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisComponentId()"> |
| <h3>getThisComponentId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getThisComponentId</span>()</div> |
| <div class="block">Get component id.</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisOutputFields(java.lang.String)"> |
| <h3>getThisOutputFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></span> <span class="element-name">getThisOutputFields</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block">Gets the declared output fields for the specified stream id for the component this task is a part of.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisOutputFieldsForStreams()"> |
| <h3>getThisOutputFieldsForStreams</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></span> <span class="element-name">getThisOutputFieldsForStreams</span>()</div> |
| <div class="block">Gets the declared output fields for all streams for the component this task is a part of.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisStreams()"> |
| <h3>getThisStreams</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getThisStreams</span>()</div> |
| <div class="block">Gets the set of streams declared for the component of this task.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisTaskIndex()"> |
| <h3>getThisTaskIndex</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getThisTaskIndex</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisInputFields()"> |
| <h3>getThisInputFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>>></span> <span class="element-name">getThisInputFields</span>()</div> |
| <div class="block">Gets the declared input fields for this component.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A map from sources to streams to fields.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisSources()"> |
| <h3>getThisSources</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a>,<wbr><a href="../generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>></span> <span class="element-name">getThisSources</span>()</div> |
| <div class="block">Gets the declared inputs to this component.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A map from subscribed component/stream to the grouping subscribed with.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThisTargets()"> |
| <h3>getThisTargets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a>>></span> <span class="element-name">getThisTargets</span>()</div> |
| <div class="block">Gets information about who is consuming the outputs of this component, and how.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Map from stream id to component id to the Grouping used.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTaskData(java.lang.String,java.lang.Object)"> |
| <h3>setTaskData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTaskData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> data)</span></div> |
| <div class="block">Sets the task-level data for the given name. This data is shared amongst the task and its corresponding task hooks.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the task-level data to be set</dd> |
| <dd><code>data</code> - task-level data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTaskData(java.lang.String)"> |
| <h3>getTaskData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getTaskData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Fetches the task-level data for the given name. This data is shared amongst the task and its corresponding task hooks.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the task-level data to be fetched</dd> |
| <dt>Returns:</dt> |
| <dd>Associated task-level data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setExecutorData(java.lang.String,java.lang.Object)"> |
| <h3>setExecutorData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setExecutorData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> data)</span></div> |
| <div class="block">Sets the executor-level data for the given name. This data is shared amongst tasks and corresponding task hooks managed by the |
| given executor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the executor-level data to be set</dd> |
| <dd><code>data</code> - executor-level data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExecutorData(java.lang.String)"> |
| <h3>getExecutorData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getExecutorData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Fetches the executor-level data for the given name. This data is shared across tasks and corresponding task hook managed by the |
| given executor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the executor-level data to be fetched</dd> |
| <dt>Returns:</dt> |
| <dd>Associated executor-level data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addTaskHook(org.apache.storm.hooks.ITaskHook)"> |
| <h3>addTaskHook</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addTaskHook</span><wbr><span class="parameters">(<a href="../hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a> hook)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHooks()"> |
| <h3>getHooks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../hooks/ITaskHook.html" title="interface in org.apache.storm.hooks">ITaskHook</a>></span> <span class="element-name">getHooks</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toJSONString()"> |
| <h3>toJSONString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toJSONString</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>toJSONString</code> in interface <code>org.apache.storm.shade.net.minidev.json.JSONAware</code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="GeneralTopologyContext.html#toJSONString()">toJSONString</a></code> in class <code><a href="GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMetric(java.lang.String,T,int)"> |
| <h3 id="registerMetric(java.lang.String,org.apache.storm.metric.api.IMetric,int)">registerMetric</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="../metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a>></span> <span class="return-type">T</span> <span class="element-name">registerMetric</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| T metric, |
| int timeBucketSizeInSecs)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IMetricsContext.html#registerMetric(java.lang.String,T,int)">IMetricsContext</a></code></span></div> |
| <div class="block">Register metric.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerMetric(java.lang.String,T,int)">registerMetric</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMetric(java.lang.String,org.apache.storm.metric.api.IReducer,int)"> |
| <h3>registerMetric</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="../metric/api/ReducedMetric.html" title="class in org.apache.storm.metric.api">ReducedMetric</a></span> <span class="element-name">registerMetric</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../metric/api/IReducer.html" title="interface in org.apache.storm.metric.api">IReducer</a> reducer, |
| int timeBucketSizeInSecs)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IMetricsContext.html#registerMetric(java.lang.String,org.apache.storm.metric.api.IReducer,int)">IMetricsContext</a></code></span></div> |
| <div class="block">Register metric.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerMetric(java.lang.String,org.apache.storm.metric.api.IReducer,int)">registerMetric</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMetric(java.lang.String,org.apache.storm.metric.api.ICombiner,int)"> |
| <h3>registerMetric</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="../metric/api/CombinedMetric.html" title="class in org.apache.storm.metric.api">CombinedMetric</a></span> <span class="element-name">registerMetric</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../metric/api/ICombiner.html" title="interface in org.apache.storm.metric.api">ICombiner</a> combiner, |
| int timeBucketSizeInSecs)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IMetricsContext.html#registerMetric(java.lang.String,org.apache.storm.metric.api.ICombiner,int)">IMetricsContext</a></code></span></div> |
| <div class="block">Register metric.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerMetric(java.lang.String,org.apache.storm.metric.api.ICombiner,int)">registerMetric</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegisteredMetricByName(java.lang.String)"> |
| <h3>getRegisteredMetricByName</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="../metric/api/IMetric.html" title="interface in org.apache.storm.metric.api">IMetric</a></span> <span class="element-name">getRegisteredMetricByName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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(https://issues.apache.org/jira/browse/STORM-254) cause the same metric name can register twice. So we |
| just return the first metric we meet.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerTimer(java.lang.String)"> |
| <h3>registerTimer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.codahale.metrics.Timer</span> <span class="element-name">registerTimer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerTimer(java.lang.String)">registerTimer</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerHistogram(java.lang.String)"> |
| <h3>registerHistogram</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.codahale.metrics.Histogram</span> <span class="element-name">registerHistogram</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerHistogram(java.lang.String)">registerHistogram</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMeter(java.lang.String)"> |
| <h3>registerMeter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.codahale.metrics.Meter</span> <span class="element-name">registerMeter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerMeter(java.lang.String)">registerMeter</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerCounter(java.lang.String)"> |
| <h3>registerCounter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.codahale.metrics.Counter</span> <span class="element-name">registerCounter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerCounter(java.lang.String)">registerCounter</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerGauge(java.lang.String,com.codahale.metrics.Gauge)"> |
| <h3>registerGauge</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">com.codahale.metrics.Gauge<T></span> <span class="element-name">registerGauge</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| com.codahale.metrics.Gauge<T> gauge)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerGauge(java.lang.String,com.codahale.metrics.Gauge)">registerGauge</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMetricSet(java.lang.String,com.codahale.metrics.MetricSet)"> |
| <h3>registerMetricSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerMetricSet</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, |
| com.codahale.metrics.MetricSet set)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IMetricsContext.html#registerMetricSet(java.lang.String,com.codahale.metrics.MetricSet)">registerMetricSet</a></code> in interface <code><a href="IMetricsContext.html" title="interface in org.apache.storm.task">IMetricsContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
