Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / windowing / class-use / TriggerPolicy.html
blob: 0172744fd81218904f7fba7c82e8d09552820e07 [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>Uses of Interface org.apache.storm.windowing.TriggerPolicy (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="Uses of Interface org.apache.storm.windowing.TriggerPolicy (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><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/windowing/class-use/TriggerPolicy.html" target="_top">Frames</a></li>
<li><a href="TriggerPolicy.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Interface org.apache.storm.windowing.TriggerPolicy" class="title">Uses of Interface<br>org.apache.storm.windowing.TriggerPolicy</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.trident.windowing.strategy">org.apache.storm.trident.windowing.strategy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.windowing">org.apache.storm.windowing</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.storm.trident.windowing.strategy">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a> in <a href="../../../../../org/apache/storm/trident/windowing/strategy/package-summary.html">org.apache.storm.trident.windowing.strategy</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/storm/trident/windowing/strategy/package-summary.html">org.apache.storm.trident.windowing.strategy</a> that return <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/TumblingDurationWindowStrategy.html" title="type parameter in TumblingDurationWindowStrategy">T</a>,?&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">TumblingDurationWindowStrategy.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/windowing/strategy/TumblingDurationWindowStrategy.html#getTriggerPolicy-org.apache.storm.windowing.TriggerHandler-org.apache.storm.windowing.EvictionPolicy-">getTriggerPolicy</a></span>(<a href="../../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a>&nbsp;triggerHandler,
<a href="../../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/TumblingDurationWindowStrategy.html" title="type parameter in TumblingDurationWindowStrategy">T</a>,?&gt;&nbsp;evictionPolicy)</code>
<div class="block">Returns a <code>TriggerPolicy</code> which triggers for every given sliding duration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/WindowStrategy.html" title="type parameter in WindowStrategy">T</a>,?&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">WindowStrategy.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/windowing/strategy/WindowStrategy.html#getTriggerPolicy-org.apache.storm.windowing.TriggerHandler-org.apache.storm.windowing.EvictionPolicy-">getTriggerPolicy</a></span>(<a href="../../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a>&nbsp;triggerHandler,
<a href="../../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/WindowStrategy.html" title="type parameter in WindowStrategy">T</a>,?&gt;&nbsp;evictionPolicy)</code>
<div class="block">Returns a <code>TriggerPolicy</code> by creating with <code>triggerHandler</code> and <code>evictionPolicy</code> with the given configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/TumblingCountWindowStrategy.html" title="type parameter in TumblingCountWindowStrategy">T</a>,?&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">TumblingCountWindowStrategy.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/windowing/strategy/TumblingCountWindowStrategy.html#getTriggerPolicy-org.apache.storm.windowing.TriggerHandler-org.apache.storm.windowing.EvictionPolicy-">getTriggerPolicy</a></span>(<a href="../../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a>&nbsp;triggerHandler,
<a href="../../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/TumblingCountWindowStrategy.html" title="type parameter in TumblingCountWindowStrategy">T</a>,?&gt;&nbsp;evictionPolicy)</code>
<div class="block">Returns a <code>TriggerPolicy</code> which triggers for every count of given sliding window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/SlidingCountWindowStrategy.html" title="type parameter in SlidingCountWindowStrategy">T</a>,?&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">SlidingCountWindowStrategy.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/windowing/strategy/SlidingCountWindowStrategy.html#getTriggerPolicy-org.apache.storm.windowing.TriggerHandler-org.apache.storm.windowing.EvictionPolicy-">getTriggerPolicy</a></span>(<a href="../../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a>&nbsp;triggerHandler,
<a href="../../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/SlidingCountWindowStrategy.html" title="type parameter in SlidingCountWindowStrategy">T</a>,?&gt;&nbsp;evictionPolicy)</code>
<div class="block">Returns a <code>TriggerPolicy</code> which triggers for every count of given sliding window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/SlidingDurationWindowStrategy.html" title="type parameter in SlidingDurationWindowStrategy">T</a>,?&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">SlidingDurationWindowStrategy.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/windowing/strategy/SlidingDurationWindowStrategy.html#getTriggerPolicy-org.apache.storm.windowing.TriggerHandler-org.apache.storm.windowing.EvictionPolicy-">getTriggerPolicy</a></span>(<a href="../../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a>&nbsp;triggerHandler,
<a href="../../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a>&lt;<a href="../../../../../org/apache/storm/trident/windowing/strategy/SlidingDurationWindowStrategy.html" title="type parameter in SlidingDurationWindowStrategy">T</a>,?&gt;&nbsp;evictionPolicy)</code>
<div class="block">Returns a <code>TriggerPolicy</code> which triggers for every configured sliding window duration.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.windowing">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a> in <a href="../../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> that implement <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/CountTriggerPolicy.html" title="class in org.apache.storm.windowing">CountTriggerPolicy</a>&lt;T&gt;</span></code>
<div class="block">A trigger that tracks event counts and calls back <a href="../../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--"><code>TriggerHandler.onTrigger()</code></a> when the count threshold is hit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/TimeTriggerPolicy.html" title="class in org.apache.storm.windowing">TimeTriggerPolicy</a>&lt;T&gt;</span></code>
<div class="block">Invokes <a href="../../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--"><code>TriggerHandler.onTrigger()</code></a> after the duration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/WatermarkCountTriggerPolicy.html" title="class in org.apache.storm.windowing">WatermarkCountTriggerPolicy</a>&lt;T&gt;</span></code>
<div class="block">A trigger policy that tracks event counts and sets the context for eviction policy to evict based on latest watermark time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/WatermarkTimeTriggerPolicy.html" title="class in org.apache.storm.windowing">WatermarkTimeTriggerPolicy</a>&lt;T&gt;</span></code>
<div class="block">Handles watermark events and triggers <a href="../../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--"><code>TriggerHandler.onTrigger()</code></a> for each window interval that has events to be processed up to the watermark ts.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
<caption><span>Fields in <a href="../../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> declared as <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">WindowManager.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/WindowManager.html#triggerPolicy">triggerPolicy</a></span></code>&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> with parameters of type <a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">WindowManager.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/WindowManager.html#setTriggerPolicy-org.apache.storm.windowing.TriggerPolicy-">setTriggerPolicy</a></span>(<a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a>&lt;<a href="../../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?&gt;&nbsp;triggerPolicy)</code>&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/windowing/class-use/TriggerPolicy.html" target="_top">Frames</a></li>
<li><a href="TriggerPolicy.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>
<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>