blob: 70d077ddf5cdca6c90f65194ae4b7f2abf054dcf [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>api - org.apache.gearpump.streaming.dsl.window.api</title>
<meta name="description" content="api - org.apache.gearpump.streaming.dsl.window.api" />
<meta name="keywords" content="api org.apache.gearpump.streaming.dsl.window.api" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../../../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../../../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../../../../../lib/template.js"></script>
<script type="text/javascript" src="../../../../../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../../../../../index.html';
var hash = 'org.apache.gearpump.streaming.dsl.window.api.package';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="value">
<div id="definition">
<img alt="Package" src="../../../../../../../lib/package_big.png" />
<p id="owner"><a href="../../../../../../package.html" class="extype" name="org">org</a>.<a href="../../../../../package.html" class="extype" name="org.apache">apache</a>.<a href="../../../../package.html" class="extype" name="org.apache.gearpump">gearpump</a>.<a href="../../../package.html" class="extype" name="org.apache.gearpump.streaming">streaming</a>.<a href="../../package.html" class="extype" name="org.apache.gearpump.streaming.dsl">dsl</a>.<a href="../package.html" class="extype" name="org.apache.gearpump.streaming.dsl.window">window</a></p>
<h1>api</h1><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<span class="name">api</span>
</span>
</h4>
<div id="comment" class="fullcommenttop"></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="types" class="types members">
<h3>Type Members</h3>
<ol><li name="org.apache.gearpump.streaming.dsl.window.api.AccumulationMode" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="AccumulationModeextendsAnyRef"></a>
<a id="AccumulationMode:AccumulationMode"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">sealed </span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="AccumulationMode.html"><span class="name">AccumulationMode</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@AccumulationModeextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.CountWindowFn" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="CountWindowFnextendsWindowFnwithProductwithSerializable"></a>
<a id="CountWindowFn:CountWindowFn"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a href="CountWindowFn.html"><span class="name">CountWindowFn</span></a><span class="params">(<span name="size">size: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result"> extends <a href="WindowFn.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.WindowFn">WindowFn</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@CountWindowFnextendsWindowFnwithProductwithSerializable" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.GroupByFn" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="GroupByFn[T,GROUP]extendsAnyRef"></a>
<a id="GroupByFn[T,GROUP]:GroupByFn[T,GROUP]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="GroupByFn.html"><span class="name">GroupByFn</span></a><span class="tparams">[<span name="T">T</span>, <span name="GROUP">GROUP</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@GroupByFn[T,GROUP]extendsAnyRef" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Divides messages into groups according its payload and timestamp.</p><div class="fullcomment"><div class="comment cmt"><p>Divides messages into groups according its payload and timestamp.
Check <a href="../impl/GroupAlsoByWindow.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.impl.GroupAlsoByWindow">org.apache.gearpump.streaming.dsl.window.impl.GroupAlsoByWindow</a>
for default implementation.
</p></div></div>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.SlidingWindowFn" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="SlidingWindowFnextendsWindowFnwithProductwithSerializable"></a>
<a id="SlidingWindowFn:SlidingWindowFn"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a href="SlidingWindowFn.html"><span class="name">SlidingWindowFn</span></a><span class="params">(<span name="size">size: <span class="extype" name="java.time.Duration">Duration</span></span>, <span name="step">step: <span class="extype" name="java.time.Duration">Duration</span></span>)</span><span class="result"> extends <a href="WindowFn.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.WindowFn">WindowFn</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@SlidingWindowFnextendsWindowFnwithProductwithSerializable" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.Trigger" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="TriggerextendsAnyRef"></a>
<a id="Trigger:Trigger"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">sealed </span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="Trigger.html"><span class="name">Trigger</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@TriggerextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.Window" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="WindowextendsProductwithSerializable"></a>
<a id="Window:Window"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a href="Window.html"><span class="name">Window</span></a><span class="params">(<span name="windowFn">windowFn: <a href="WindowFn.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.WindowFn">WindowFn</a></span>, <span name="trigger">trigger: <a href="Trigger.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.Trigger">Trigger</a> = <span class="symbol"><span class="name"><a href="EventTimeTrigger$.html">EventTimeTrigger</a></span></span></span>, <span name="accumulationMode">accumulationMode: <a href="AccumulationMode.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.AccumulationMode">AccumulationMode</a> = <span class="symbol"><span class="name"><a href="Discarding$.html">Discarding</a></span></span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@WindowextendsProductwithSerializable" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt"></p>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.WindowFn" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="WindowFnextendsAnyRef"></a>
<a id="WindowFn:WindowFn"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">sealed </span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="WindowFn.html"><span class="name">WindowFn</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@WindowFnextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="org.apache.gearpump.streaming.dsl.window.api.Accumulating" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Accumulating"></a>
<a id="Accumulating:Accumulating"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Accumulating$.html"><span class="name">Accumulating</span></a><span class="result"> extends <a href="AccumulationMode.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.AccumulationMode">AccumulationMode</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@Accumulating" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.CountTrigger" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="CountTrigger"></a>
<a id="CountTrigger:CountTrigger"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="CountTrigger$.html"><span class="name">CountTrigger</span></a><span class="result"> extends <a href="Trigger.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.Trigger">Trigger</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@CountTrigger" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.CountWindow" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="CountWindow"></a>
<a id="CountWindow:CountWindow"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="CountWindow$.html"><span class="name">CountWindow</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@CountWindow" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.Discarding" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Discarding"></a>
<a id="Discarding:Discarding"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Discarding$.html"><span class="name">Discarding</span></a><span class="result"> extends <a href="AccumulationMode.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.AccumulationMode">AccumulationMode</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@Discarding" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.EventTimeTrigger" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="EventTimeTrigger"></a>
<a id="EventTimeTrigger:EventTimeTrigger"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="EventTimeTrigger$.html"><span class="name">EventTimeTrigger</span></a><span class="result"> extends <a href="Trigger.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.Trigger">Trigger</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@EventTimeTrigger" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.FixedWindow" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="FixedWindow"></a>
<a id="FixedWindow:FixedWindow"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="FixedWindow$.html"><span class="name">FixedWindow</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@FixedWindow" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.ProcessingTimeTrigger" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="ProcessingTimeTrigger"></a>
<a id="ProcessingTimeTrigger:ProcessingTimeTrigger"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="ProcessingTimeTrigger$.html"><span class="name">ProcessingTimeTrigger</span></a><span class="result"> extends <a href="Trigger.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.Trigger">Trigger</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@ProcessingTimeTrigger" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.streaming.dsl.window.api.SlidingWindow" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="SlidingWindow"></a>
<a id="SlidingWindow:SlidingWindow"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="SlidingWindow$.html"><span class="name">SlidingWindow</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@SlidingWindow" title="Permalink" target="_top">
<img src="../../../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>