blob: 647a48c67f3c088794f5762150d3b85d0ac69aef [file] [log] [blame]
<!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>TopologyBuilder.SpoutGetter (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="TopologyBuilder.SpoutGetter (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
</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/TopologyBuilder.SpoutGetter.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/topology/TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/topology/TupleFieldTimestampExtractor.html" title="class in org.apache.storm.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/TopologyBuilder.SpoutGetter.html" target="_top">Frames</a></li>
<li><a href="TopologyBuilder.SpoutGetter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.storm.topology.TopologyBuilder.ConfigGetter">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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.topology</div>
<h2 title="Class TopologyBuilder.SpoutGetter" class="title">Class TopologyBuilder.SpoutGetter</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/topology/BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">org.apache.storm.topology.BaseConfigurationDeclarer</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">org.apache.storm.topology.TopologyBuilder.ConfigGetter</a>&lt;<a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.storm.topology.TopologyBuilder.SpoutGetter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&lt;<a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a>&gt;, <a href="../../../../org/apache/storm/topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;<a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a>&gt;, <a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/apache/storm/topology/TopologyBuilder.html" title="class in org.apache.storm.topology">TopologyBuilder</a></dd>
</dl>
<hr>
<br>
<pre>protected class <span class="typeNameLabel">TopologyBuilder.SpoutGetter</span>
extends <a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.ConfigGetter</a>&lt;<a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a>&gt;
implements <a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/topology/TopologyBuilder.SpoutGetter.html#SpoutGetter-java.lang.String-">SpoutGetter</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>&nbsp;id)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.TopologyBuilder.ConfigGetter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.topology.<a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.ConfigGetter</a></h3>
<code><a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html#addConfigurations-java.util.Map-">addConfigurations</a>, <a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html#addResource-java.lang.String-java.lang.Number-">addResource</a>, <a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html#addResources-java.util.Map-">addResources</a>, <a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html#addSharedMemory-org.apache.storm.generated.SharedMemory-">addSharedMemory</a>, <a href="../../../../org/apache/storm/topology/TopologyBuilder.ConfigGetter.html#getComponentConfiguration--">getComponentConfiguration</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.BaseConfigurationDeclarer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.topology.<a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">BaseConfigurationDeclarer</a></h3>
<code><a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#addConfiguration-java.lang.String-java.lang.Object-">addConfiguration</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setCPULoad-java.lang.Number-">setCPULoad</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setDebug-boolean-">setDebug</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setMaxSpoutPending-java.lang.Number-">setMaxSpoutPending</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setMaxTaskParallelism-java.lang.Number-">setMaxTaskParallelism</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setMemoryLoad-java.lang.Number-">setMemoryLoad</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setMemoryLoad-java.lang.Number-java.lang.Number-">setMemoryLoad</a>, <a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html#setNumTasks-java.lang.Number-">setNumTasks</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&nbsp;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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.ComponentConfigurationDeclarer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a></h3>
<code><a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#addConfiguration-java.lang.String-java.lang.Object-">addConfiguration</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#addConfigurations-java.util.Map-">addConfigurations</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#addResource-java.lang.String-java.lang.Number-">addResource</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#addResources-java.util.Map-">addResources</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#getComponentConfiguration--">getComponentConfiguration</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#setDebug-boolean-">setDebug</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#setMaxSpoutPending-java.lang.Number-">setMaxSpoutPending</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#setMaxTaskParallelism-java.lang.Number-">setMaxTaskParallelism</a>, <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html#setNumTasks-java.lang.Number-">setNumTasks</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.ResourceDeclarer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="../../../../org/apache/storm/topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a></h3>
<code><a href="../../../../org/apache/storm/topology/ResourceDeclarer.html#addSharedMemory-org.apache.storm.generated.SharedMemory-">addSharedMemory</a>, <a href="../../../../org/apache/storm/topology/ResourceDeclarer.html#setCPULoad-java.lang.Number-">setCPULoad</a>, <a href="../../../../org/apache/storm/topology/ResourceDeclarer.html#setMemoryLoad-java.lang.Number-">setMemoryLoad</a>, <a href="../../../../org/apache/storm/topology/ResourceDeclarer.html#setMemoryLoad-java.lang.Number-java.lang.Number-">setMemoryLoad</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="SpoutGetter-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SpoutGetter</h4>
<pre>public&nbsp;SpoutGetter(<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>&nbsp;id)</pre>
</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/TopologyBuilder.SpoutGetter.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/topology/TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/topology/TupleFieldTimestampExtractor.html" title="class in org.apache.storm.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/TopologyBuilder.SpoutGetter.html" target="_top">Frames</a></li>
<li><a href="TopologyBuilder.SpoutGetter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.storm.topology.TopologyBuilder.ConfigGetter">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>