| <!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.GlobalWindowFunction" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="GlobalWindowFunctionextendsNonMergingWindowFunctionwithProductwithSerializable"></a> |
| <a id="GlobalWindowFunction:GlobalWindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="GlobalWindowFunction.html"><span class="name">GlobalWindowFunction</span></a><span class="params">()</span><span class="result"> extends <a href="NonMergingWindowFunction.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.NonMergingWindowFunction">NonMergingWindowFunction</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@GlobalWindowFunctionextendsNonMergingWindowFunctionwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.NonMergingWindowFunction" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="NonMergingWindowFunctionextendsWindowFunction"></a> |
| <a id="NonMergingWindowFunction:NonMergingWindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NonMergingWindowFunction.html"><span class="name">NonMergingWindowFunction</span></a><span class="result"> extends <a href="WindowFunction.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.WindowFunction">WindowFunction</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@NonMergingWindowFunctionextendsWindowFunction" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.SessionWindowFunction" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SessionWindowFunctionextendsWindowFunctionwithProductwithSerializable"></a> |
| <a id="SessionWindowFunction:SessionWindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SessionWindowFunction.html"><span class="name">SessionWindowFunction</span></a><span class="params">(<span name="gap">gap: <span class="extype" name="java.time.Duration">Duration</span></span>)</span><span class="result"> extends <a href="WindowFunction.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.WindowFunction">WindowFunction</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@SessionWindowFunctionextendsWindowFunctionwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.SlidingWindowFunction" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SlidingWindowFunctionextendsNonMergingWindowFunctionwithProductwithSerializable"></a> |
| <a id="SlidingWindowFunction:SlidingWindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SlidingWindowFunction.html"><span class="name">SlidingWindowFunction</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="NonMergingWindowFunction.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.NonMergingWindowFunction">NonMergingWindowFunction</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@SlidingWindowFunctionextendsNonMergingWindowFunctionwithProductwithSerializable" 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.WindowFunction" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="WindowFunctionextendsAnyRef"></a> |
| <a id="WindowFunction:WindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="WindowFunction.html"><span class="name">WindowFunction</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@WindowFunctionextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.Windows" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="WindowsextendsProductwithSerializable"></a> |
| <a id="Windows:Windows"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Windows.html"><span class="name">Windows</span></a><span class="params">(<span name="windowFn">windowFn: <a href="WindowFunction.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.api.WindowFunction">WindowFunction</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 name="description">description: <span class="extype" name="scala.Predef.String">String</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@WindowsextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Defines how to apply window functions.</p><div class="fullcomment"><div class="comment cmt"><p>Defines how to apply window functions. |
| </p></div><dl class="paramcmts block"><dt class="param">windowFn</dt><dd class="cmt"><p>how to divide windows</p></dd><dt class="param">trigger</dt><dd class="cmt"><p>when to trigger window result</p></dd><dt class="param">accumulationMode</dt><dd class="cmt"><p>whether to accumulate results across windows</p></dd></dl></div> |
| </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.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.FixedWindows" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="FixedWindows"></a> |
| <a id="FixedWindows:FixedWindows"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="FixedWindows$.html"><span class="name">FixedWindows</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@FixedWindows" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.GlobalWindowFunction" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="GlobalWindowFunction"></a> |
| <a id="GlobalWindowFunction:GlobalWindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="GlobalWindowFunction$.html"><span class="name">GlobalWindowFunction</span></a><span class="result"> extends <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@GlobalWindowFunction" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.GlobalWindows" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="GlobalWindows"></a> |
| <a id="GlobalWindows:GlobalWindows"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="GlobalWindows$.html"><span class="name">GlobalWindows</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@GlobalWindows" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.SessionWindows" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SessionWindows"></a> |
| <a id="SessionWindows:SessionWindows"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SessionWindows$.html"><span class="name">SessionWindows</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@SessionWindows" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.SlidingWindows" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SlidingWindows"></a> |
| <a id="SlidingWindows:SlidingWindows"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SlidingWindows$.html"><span class="name">SlidingWindows</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@SlidingWindows" title="Permalink" target="_top"> |
| <img src="../../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.window.api.WindowFunction" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WindowFunction"></a> |
| <a id="WindowFunction:WindowFunction"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="WindowFunction$.html"><span class="name">WindowFunction</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../../index.html#org.apache.gearpump.streaming.dsl.window.api.package@WindowFunction" 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> |
