Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / trident / spout / IPartitionedTridentSpout.html
blob: 08bbd8f366835f907c1e8d77fe55036dcd4d5c29 [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>IPartitionedTridentSpout (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="IPartitionedTridentSpout (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IPartitionedTridentSpout.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/trident/spout/IOpaquePartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/spout/IPartitionedTridentSpout.html" target="_top">Frames</a></li>
<li><a href="IPartitionedTridentSpout.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.storm.trident.spout</div>
<h2 title="Interface IPartitionedTridentSpout" class="title">Interface IPartitionedTridentSpout&lt;PartitionsT,PartitionT extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/storm/trident/spout/ITridentDataSource.html" title="interface in org.apache.storm.trident.spout">ITridentDataSource</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/storm/kafka/spout/trident/KafkaTridentSpoutTransactional.html" title="class in org.apache.storm.kafka.spout.trident">KafkaTridentSpoutTransactional</a>, <a href="../../../../../org/apache/storm/eventhubs/trident/TransactionalTridentEventHubSpout.html" title="class in org.apache.storm.eventhubs.trident">TransactionalTridentEventHubSpout</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IPartitionedTridentSpout&lt;PartitionsT,PartitionT extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,T&gt;</span>
extends <a href="../../../../../org/apache/storm/trident/spout/ITridentDataSource.html" title="interface in org.apache.storm.trident.spout">ITridentDataSource</a></pre>
<div class="block"><p>This interface defines a transactional spout that reads its tuples from a partitioned set of brokers. It automates the storing of metadata for each partition to ensure that the same batch is always emitted for the same transaction id. The partition metadata is stored in Zookeeper.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Coordinator</a>&lt;<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="type parameter in IPartitionedTridentSpout.Coordinator">PartitionsT</a>&gt;</span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Emitter</a>&lt;<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="type parameter in IPartitionedTridentSpout.Emitter">PartitionsT</a>,<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="type parameter in IPartitionedTridentSpout.Emitter">PartitionT</a> extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="type parameter in IPartitionedTridentSpout.Emitter">X</a>&gt;</span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html#getComponentConfiguration--">getComponentConfiguration</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Coordinator</a>&lt;<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">PartitionsT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html#getCoordinator-java.util.Map-org.apache.storm.task.TopologyContext-">getCoordinator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf,
<a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Emitter</a>&lt;<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">PartitionsT</a>,<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">PartitionT</a>,<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html#getEmitter-java.util.Map-org.apache.storm.task.TopologyContext-">getEmitter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf,
<a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html#getOutputFields--">getOutputFields</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCoordinator-java.util.Map-org.apache.storm.task.TopologyContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoordinator</h4>
<pre><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Coordinator</a>&lt;<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">PartitionsT</a>&gt;&nbsp;getCoordinator(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf,
<a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context)</pre>
</li>
</ul>
<a name="getEmitter-java.util.Map-org.apache.storm.task.TopologyContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmitter</h4>
<pre><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Emitter</a>&lt;<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">PartitionsT</a>,<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">PartitionT</a>,<a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="type parameter in IPartitionedTridentSpout">T</a>&gt;&nbsp;getEmitter(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;conf,
<a href="../../../../../org/apache/storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context)</pre>
</li>
</ul>
<a name="getComponentConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentConfiguration</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getComponentConfiguration()</pre>
</li>
</ul>
<a name="getOutputFields--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOutputFields</h4>
<pre><a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a>&nbsp;getOutputFields()</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/IPartitionedTridentSpout.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/trident/spout/IOpaquePartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/spout/IPartitionedTridentSpout.html" target="_top">Frames</a></li>
<li><a href="IPartitionedTridentSpout.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>