| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>plan - org.apache.gearpump.streaming.dsl.plan</title> |
| <meta name="description" content="plan - org.apache.gearpump.streaming.dsl.plan" /> |
| <meta name="keywords" content="plan org.apache.gearpump.streaming.dsl.plan" /> |
| <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.plan.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></p> |
| <h1>plan</h1><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.dsl.plan.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">plan</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.plan.ChainableOp" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ChainableOp[IN,OUT]extendsOpwithProductwithSerializable"></a> |
| <a id="ChainableOp[IN,OUT]:ChainableOp[IN,OUT]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="ChainableOp.html"><span class="name">ChainableOp</span></a><span class="tparams">[<span name="IN">IN</span>, <span name="OUT">OUT</span>]</span><span class="params">(<span name="fn">fn: <a href="functions/FunctionRunner.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.functions.FunctionRunner">FunctionRunner</a>[<span class="extype" name="org.apache.gearpump.streaming.dsl.plan.ChainableOp.IN">IN</span>, <span class="extype" name="org.apache.gearpump.streaming.dsl.plan.ChainableOp.OUT">OUT</span>]</span>, <span name="userConfig">userConfig: <a href="../../../cluster/UserConfig.html" class="extype" name="org.apache.gearpump.cluster.UserConfig">UserConfig</a> = <span class="symbol"><span class="name"><a href="../../../../../package.html">UserConfig.empty</a></span></span></span>)</span><span class="result"> extends <a href="Op.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.Op">Op</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.plan.package@ChainableOp[IN,OUT]extendsOpwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This represents operations that can be chained together |
| (e.g.</p><div class="fullcomment"><div class="comment cmt"><p>This represents operations that can be chained together |
| (e.g. flatMap, map, filter, reduce) and further chained |
| to another Op to be used |
| </p></div></div> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.DataSinkOp" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DataSinkOpextendsOpwithProductwithSerializable"></a> |
| <a id="DataSinkOp:DataSinkOp"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataSinkOp.html"><span class="name">DataSinkOp</span></a><span class="params">(<span name="dataSink">dataSink: <a href="../../sink/DataSink.html" class="extype" name="org.apache.gearpump.streaming.sink.DataSink">DataSink</a></span>, <span name="parallelism">parallelism: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">1</span></span>, <span name="userConfig">userConfig: <a href="../../../cluster/UserConfig.html" class="extype" name="org.apache.gearpump.cluster.UserConfig">UserConfig</a> = <span class="symbol"><span class="name"><a href="../../../../../package.html">UserConfig.empty</a></span></span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">"sink"</span></span>)</span><span class="result"> extends <a href="Op.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.Op">Op</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.plan.package@DataSinkOpextendsOpwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This represents a DataSink.</p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.DataSourceOp" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DataSourceOpextendsOpwithProductwithSerializable"></a> |
| <a id="DataSourceOp:DataSourceOp"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataSourceOp.html"><span class="name">DataSourceOp</span></a><span class="params">(<span name="dataSource">dataSource: <a href="../../source/DataSource.html" class="extype" name="org.apache.gearpump.streaming.source.DataSource">DataSource</a></span>, <span name="parallelism">parallelism: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">1</span></span>, <span name="userConfig">userConfig: <a href="../../../cluster/UserConfig.html" class="extype" name="org.apache.gearpump.cluster.UserConfig">UserConfig</a> = <span class="symbol"><span class="name"><a href="../../../../../package.html">UserConfig.empty</a></span></span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">"source"</span></span>)</span><span class="result"> extends <a href="Op.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.Op">Op</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.plan.package@DataSourceOpextendsOpwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This represents a DataSource.</p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.GroupByOp" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="GroupByOp[IN,GROUP]extendsOpwithProductwithSerializable"></a> |
| <a id="GroupByOp[IN,GROUP]:GroupByOp[IN,GROUP]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="GroupByOp.html"><span class="name">GroupByOp</span></a><span class="tparams">[<span name="IN">IN</span>, <span name="GROUP">GROUP</span>]</span><span class="params">(<span name="groupBy">groupBy: <a href="../window/impl/GroupAlsoByWindow.html" class="extype" name="org.apache.gearpump.streaming.dsl.window.impl.GroupAlsoByWindow">GroupAlsoByWindow</a>[<span class="extype" name="org.apache.gearpump.streaming.dsl.plan.GroupByOp.IN">IN</span>, <span class="extype" name="org.apache.gearpump.streaming.dsl.plan.GroupByOp.GROUP">GROUP</span>]</span>, <span name="parallelism">parallelism: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">1</span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol">"groupBy"</span></span>, <span name="userConfig">userConfig: <a href="../../../cluster/UserConfig.html" class="extype" name="org.apache.gearpump.cluster.UserConfig">UserConfig</a> = <span class="symbol"><span class="name"><a href="../../../../../package.html">UserConfig.empty</a></span></span></span>)</span><span class="result"> extends <a href="Op.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.Op">Op</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.plan.package@GroupByOp[IN,GROUP]extendsOpwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This represents a Processor with window aggregation |
| </p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.MergeOp" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MergeOpextendsOpwithProductwithSerializable"></a> |
| <a id="MergeOp:MergeOp"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="MergeOp.html"><span class="name">MergeOp</span></a><span class="params">(<span name="description">description: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="userConfig">userConfig: <a href="../../../cluster/UserConfig.html" class="extype" name="org.apache.gearpump.cluster.UserConfig">UserConfig</a> = <span class="symbol"><span class="name"><a href="../../../../../package.html">UserConfig.empty</a></span></span></span>)</span><span class="result"> extends <a href="Op.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.Op">Op</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.plan.package@MergeOpextendsOpwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This represents a Processor transforming merged streams |
| </p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.Op" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="OpextendsAnyRef"></a> |
| <a id="Op:Op"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">sealed </span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="Op.html"><span class="name">Op</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.plan.package@OpextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This is a vertex on the logical plan.</p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.OpChainException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="OpChainExceptionextendsRuntimeException"></a> |
| <a id="OpChainException:OpChainException"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="OpChainException.html"><span class="name">OpChainException</span></a><span class="result"> extends <span class="extype" name="scala.RuntimeException">RuntimeException</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.dsl.plan.package@OpChainExceptionextendsRuntimeException" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Runtime exception thrown on chaining.</p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.OpEdge" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="OpEdgeextendsAnyRef"></a> |
| <a id="OpEdge:OpEdge"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="OpEdge.html"><span class="name">OpEdge</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.plan.package@OpEdgeextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This is an edge on the logical plan.</p> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.Planner" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="PlannerextendsAnyRef"></a> |
| <a id="Planner:Planner"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Planner.html"><span class="name">Planner</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.plan.package@PlannerextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.ProcessorOp" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ProcessorOp[T<:org.apache.gearpump.streaming.task.Task]extendsOpwithProductwithSerializable"></a> |
| <a id="ProcessorOp[T<:Task]:ProcessorOp[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="ProcessorOp.html"><span class="name">ProcessorOp</span></a><span class="tparams">[<span name="T">T <: <a href="../../task/Task.html" class="extype" name="org.apache.gearpump.streaming.task.Task">Task</a></span>]</span><span class="params">(<span name="processor">processor: <span class="extype" name="scala.Predef.Class">Class</span>[<span class="extype" name="org.apache.gearpump.streaming.dsl.plan.ProcessorOp.T">T</span>]</span>, <span name="parallelism">parallelism: <span class="extype" name="scala.Int">Int</span></span>, <span name="userConfig">userConfig: <a href="../../../cluster/UserConfig.html" class="extype" name="org.apache.gearpump.cluster.UserConfig">UserConfig</a></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Op.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.Op">Op</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.plan.package@ProcessorOp[T<:org.apache.gearpump.streaming.task.Task]extendsOpwithProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This represents a low level Processor.</p> |
| </li></ol> |
| </div> |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Value Members</h3> |
| <ol><li name="org.apache.gearpump.streaming.dsl.plan.Direct" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="Direct"></a> |
| <a id="Direct:Direct"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Direct$.html"><span class="name">Direct</span></a><span class="result"> extends <a href="OpEdge.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.OpEdge">OpEdge</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.plan.package@Direct" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">The upstream OP and downstream OP doesn't require network data shuffle.</p><div class="fullcomment"><div class="comment cmt"><p>The upstream OP and downstream OP doesn't require network data shuffle. |
| e.g. ChainableOp |
| </p></div></div> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.Shuffle" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="Shuffle"></a> |
| <a id="Shuffle:Shuffle"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Shuffle$.html"><span class="name">Shuffle</span></a><span class="result"> extends <a href="OpEdge.html" class="extype" name="org.apache.gearpump.streaming.dsl.plan.OpEdge">OpEdge</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.plan.package@Shuffle" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">The upstream OP and downstream OP DOES require network data shuffle.</p><div class="fullcomment"><div class="comment cmt"><p>The upstream OP and downstream OP DOES require network data shuffle. |
| e.g. GroupByOp |
| </p></div></div> |
| </li><li name="org.apache.gearpump.streaming.dsl.plan.functions" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="functions"></a> |
| <a id="functions:functions"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="functions/package.html"><span class="name">functions</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.dsl.plan.package@functions" 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> |