blob: f4940be7ac460a37222cebe376427643ea9a7e56 [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>sink - org.apache.gearpump.streaming.sink</title>
<meta name="description" content="sink - org.apache.gearpump.streaming.sink" />
<meta name="keywords" content="sink org.apache.gearpump.streaming.sink" />
<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.sink.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></p>
<h1>sink</h1><span class="permalink">
<a href="../../../../../index.html#org.apache.gearpump.streaming.sink.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">sink</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.sink.DataSink" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
<a id="DataSinkextendsSerializable"></a>
<a id="DataSink:DataSink"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="DataSink.html"><span class="name">DataSink</span></a><span class="result"> extends <span class="extype" name="java.io.Serializable">Serializable</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.gearpump.streaming.sink.package@DataSinkextendsSerializable" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Interface to implement custom data sink where result of a DAG is typically written
a DataSink could be a data store like HBase or simply a console</p><div class="fullcomment"><div class="comment cmt"><p>Interface to implement custom data sink where result of a DAG is typically written
a DataSink could be a data store like HBase or simply a console</p><p>An example would be like:</p><pre><span class="kw">class</span> ConsoleSink <span class="kw">extends</span> DataSink[<span class="std">String</span>] {
<span class="kw">def</span> open(context: TaskContext): <span class="std">Unit</span> = {}
<span class="kw">def</span> write(s: <span class="std">String</span>): <span class="std">Unit</span> = {
<span class="std">Console</span>.println(s)
}
<span class="kw">def</span> close(): <span class="std">Unit</span> = {}
}</pre><p>Subclass is required to be serializable
</p></div></div>
</li><li name="org.apache.gearpump.streaming.sink.DataSinkTask" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="DataSinkTaskextendsTask"></a>
<a id="DataSinkTask:DataSinkTask"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="DataSinkTask.html"><span class="name">DataSinkTask</span></a><span class="result"> extends <a href="../task/Task.html" class="extype" name="org.apache.gearpump.streaming.task.Task">Task</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.gearpump.streaming.sink.package@DataSinkTaskextendsTask" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">General task that runs any <a href="DataSink.html" class="extype" name="org.apache.gearpump.streaming.sink.DataSink">DataSink</a>
</p>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="org.apache.gearpump.streaming.sink.DataSinkProcessor" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="DataSinkProcessor"></a>
<a id="DataSinkProcessor:DataSinkProcessor"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="DataSinkProcessor$.html"><span class="name">DataSinkProcessor</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.gearpump.streaming.sink.package@DataSinkProcessor" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Utility that helps user to create a DAG ending in <a href="DataSink.html" class="extype" name="org.apache.gearpump.streaming.sink.DataSink">DataSink</a>
user should pass in a <a href="DataSink.html" class="extype" name="org.apache.gearpump.streaming.sink.DataSink">DataSink</a>.</p><div class="fullcomment"><div class="comment cmt"><p>Utility that helps user to create a DAG ending in <a href="DataSink.html" class="extype" name="org.apache.gearpump.streaming.sink.DataSink">DataSink</a>
user should pass in a <a href="DataSink.html" class="extype" name="org.apache.gearpump.streaming.sink.DataSink">DataSink</a>.</p><p>here is an example to build a DAG that does word count and write to KafkaSink</p><pre><span class="kw">val</span> split = Processor[Split](<span class="num">1</span>)
<span class="kw">val</span> sum = Processor[Sum](<span class="num">1</span>)
<span class="kw">val</span> sink = <span class="kw">new</span> KafkaSink()
<span class="kw">val</span> sinkProcessor = DataSinkProcessor(sink, <span class="num">1</span>)
<span class="kw">val</span> dag = split ~&gt; sum ~&gt; sink</pre></div></div>
</li><li name="org.apache.gearpump.streaming.sink.DataSinkTask" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="DataSinkTask"></a>
<a id="DataSinkTask:DataSinkTask"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="DataSinkTask$.html"><span class="name">DataSinkTask</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.gearpump.streaming.sink.package@DataSinkTask" 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>