Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/MessageStream.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/MessageStream.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/MessageStream.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/MessageStream.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,449 @@ +<!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 (1.8.0_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>MessageStream (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="MessageStream (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/MessageStream.html" target="_top">Frames</a></li> +<li><a href="MessageStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.operators</div> +<h2 title="Interface MessageStream" class="title">Interface MessageStream<M></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>M</code> - type of messages in this stream</dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> +public interface <span class="typeNameLabel">MessageStream<M></span></pre> +<div class="block">Represents a stream of messages. + <p> + A <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> can be transformed into another <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> by applying the transforms in this API.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#filter-org.apache.samza.operators.functions.FilterFunction-">filter</a></span>(<a href="../../../../org/apache/samza/operators/functions/FilterFunction.html" title="interface in org.apache.samza.operators.functions">FilterFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> filterFn)</code> +<div class="block">Applies the provided function to messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> and returns the + transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><TM> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><TM></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#flatMap-org.apache.samza.operators.functions.FlatMapFunction-">flatMap</a></span>(<a href="../../../../org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions">FlatMapFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,TM> flatMapFn)</code> +<div class="block">Applies the provided 1:n function to transform a message in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> + to n messages in the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><K,OM,RM> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><RM></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#join-org.apache.samza.operators.MessageStream-org.apache.samza.operators.functions.JoinFunction-">join</a></span>(<a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><OM> otherStream, + <a href="../../../../org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions">JoinFunction</a><K,<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,OM,RM> joinFn)</code> +<div class="block">Joins this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> with another <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> using the provided pairwise <a href="../../../../org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions"><code>JoinFunction</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><TM> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><TM></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#map-org.apache.samza.operators.functions.MapFunction-">map</a></span>(<a href="../../../../org/apache/samza/operators/functions/MapFunction.html" title="interface in org.apache.samza.operators.functions">MapFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,TM> mapFn)</code> +<div class="block">Applies the provided 1:1 function to messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> and returns the + transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#merge-java.util.Collection-">merge</a></span>(java.util.Collection<<a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>>> otherStreams)</code> +<div class="block">Merge all <code>otherStreams</code> with this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><K> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#partitionBy-java.util.function.Function-">partitionBy</a></span>(java.util.function.Function<<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,K> parKeyExtractor)</code> +<div class="block">Send the input message to an output <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> and consume it as input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> again.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#sendTo-org.apache.samza.operators.OutputStream-">sendTo</a></span>(<a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> stream)</code> +<div class="block">Allows sending messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> to an output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#sink-org.apache.samza.operators.functions.SinkFunction-">sink</a></span>(<a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions">SinkFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> sinkFn)</code> +<div class="block">Allows sending messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> to an output using the provided <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><K,WV> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows">WindowPane</a><K,WV>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/MessageStream.html#window-org.apache.samza.operators.windows.Window-">window</a></span>(<a href="../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,K,WV> window)</code> +<div class="block">Groups the messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> according to the provided <a href="../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> semantics + (e.g.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="map-org.apache.samza.operators.functions.MapFunction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>map</h4> +<pre><TM> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><TM> map(<a href="../../../../org/apache/samza/operators/functions/MapFunction.html" title="interface in org.apache.samza.operators.functions">MapFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,TM> mapFn)</pre> +<div class="block">Applies the provided 1:1 function to messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> and returns the + transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>TM</code> - the type of messages in the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mapFn</code> - the function to transform a message to another message</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="flatMap-org.apache.samza.operators.functions.FlatMapFunction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flatMap</h4> +<pre><TM> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><TM> flatMap(<a href="../../../../org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions">FlatMapFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,TM> flatMapFn)</pre> +<div class="block">Applies the provided 1:n function to transform a message in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> + to n messages in the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>TM</code> - the type of messages in the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flatMapFn</code> - the function to transform a message to zero or more messages</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="filter-org.apache.samza.operators.functions.FilterFunction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filter</h4> +<pre><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> filter(<a href="../../../../org/apache/samza/operators/functions/FilterFunction.html" title="interface in org.apache.samza.operators.functions">FilterFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> filterFn)</pre> +<div class="block">Applies the provided function to messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> and returns the + transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>. + <p> + The <code>Function</code> is a predicate which determines whether a message in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> + should be retained in the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filterFn</code> - the predicate to filter messages from this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="sink-org.apache.samza.operators.functions.SinkFunction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sink</h4> +<pre>void sink(<a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions">SinkFunction</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> sinkFn)</pre> +<div class="block">Allows sending messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> to an output using the provided <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a>. + + NOTE: the output may not be a <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a>. It can be an external database, etc.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sinkFn</code> - the function to send messages in this stream to output</dd> +</dl> +</li> +</ul> +<a name="sendTo-org.apache.samza.operators.OutputStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendTo</h4> +<pre>void sendTo(<a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> stream)</pre> +<div class="block">Allows sending messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> to an output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>. + + NOTE: the <code>stream</code> has to be a <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - the output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="window-org.apache.samza.operators.windows.Window-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>window</h4> +<pre><K,WV> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows">WindowPane</a><K,WV>> window(<a href="../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,K,WV> window)</pre> +<div class="block">Groups the messages in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> according to the provided <a href="../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> semantics + (e.g. tumbling, sliding or session windows) and returns the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> of + <a href="../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>s. + <p> + Use the <a href="../../../../org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows"><code>Windows</code></a> helper methods to create the appropriate windows.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of key in the message in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>. If a key is specified, + panes are emitted per-key.</dd> +<dd><code>WV</code> - the type of value in the <a href="../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a> in the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>window</code> - the window to group and process messages from this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the transformed <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="join-org.apache.samza.operators.MessageStream-org.apache.samza.operators.functions.JoinFunction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>join</h4> +<pre><K,OM,RM> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><RM> join(<a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><OM> otherStream, + <a href="../../../../org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions">JoinFunction</a><K,<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,OM,RM> joinFn)</pre> +<div class="block">Joins this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> with another <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> using the provided pairwise <a href="../../../../org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions"><code>JoinFunction</code></a>. + <p> + We currently only support 2-way joins.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of join key</dd> +<dd><code>OM</code> - the type of messages in the other stream</dd> +<dd><code>RM</code> - the type of messages resulting from the <code>joinFn</code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>otherStream</code> - the other <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> to be joined with</dd> +<dd><code>joinFn</code> - the function to join messages from this and the other <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the joined <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="merge-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>merge</h4> +<pre><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> merge(java.util.Collection<<a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>>> otherStreams)</pre> +<div class="block">Merge all <code>otherStreams</code> with this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>. + <p> + The merging streams must have the same messages of type <code>M</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>otherStreams</code> - other <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s to be merged with this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the merged <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="partitionBy-java.util.function.Function-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>partitionBy</h4> +<pre><K> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> partitionBy(java.util.function.Function<<a href="../../../../org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>,K> parKeyExtractor)</pre> +<div class="block">Send the input message to an output <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> and consume it as input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> again. + + Note: this is an transform function only used in logic DAG. In a physical DAG, this is either translated to a NOOP function, or a <code>MessageStream#sendThrough</code> function.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of partition key</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parKeyExtractor</code> - a <code>Function</code> that extract the partition key from a message in this <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> object after the re-partition</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/MessageStream.html" target="_top">Frames</a></li> +<li><a href="MessageStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/OutputStream.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/OutputStream.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/OutputStream.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/OutputStream.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,234 @@ +<!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 (1.8.0_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>OutputStream (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="OutputStream (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/OutputStream.html" target="_top">Frames</a></li> +<li><a href="OutputStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.operators</div> +<h2 title="Interface OutputStream" class="title">Interface OutputStream<M></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>M</code> - The type of message to be send to this output stream</dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> +public interface <span class="typeNameLabel">OutputStream<M></span></pre> +<div class="block">The interface class defining the specific <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a> for a system <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><code>OutputStream</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions">SinkFunction</a><<a href="../../../../org/apache/samza/operators/OutputStream.html" title="type parameter in OutputStream">M</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/OutputStream.html#getSinkFunction--">getSinkFunction</a></span>()</code> +<div class="block">Returns the specific <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a> for this output stream.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSinkFunction--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSinkFunction</h4> +<pre><a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions">SinkFunction</a><<a href="../../../../org/apache/samza/operators/OutputStream.html" title="type parameter in OutputStream">M</a>> getSinkFunction()</pre> +<div class="block">Returns the specific <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a> for this output stream. The <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><code>OutputStream</code></a> is created + via <a href="../../../../org/apache/samza/operators/StreamGraph.html#createOutStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-"><code>StreamGraph.createOutStream(StreamSpec, Serde, Serde)</code></a> or <a href="../../../../org/apache/samza/operators/StreamGraph.html#createIntStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-"><code>StreamGraph.createIntStream(StreamSpec, Serde, Serde)</code></a>. + Hence, the proper types of serdes for key and value are instantiated and are used in the <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a> returned.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The pre-defined <a href="../../../../org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><code>SinkFunction</code></a> to apply proper serdes before sending the message to the output stream.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/OutputStream.html" target="_top">Frames</a></li> +<li><a href="OutputStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraph.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraph.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraph.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraph.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,366 @@ +<!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 (1.8.0_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>StreamGraph (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="StreamGraph (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/StreamGraphBuilder.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/StreamGraph.html" target="_top">Frames</a></li> +<li><a href="StreamGraph.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.operators</div> +<h2 title="Interface StreamGraph" class="title">Interface StreamGraph</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> +public interface <span class="typeNameLabel">StreamGraph</span></pre> +<div class="block">Job-level programming interface to create an operator DAG and run in various different runtime environments.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><K,V,M extends <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a><K,V>><br><a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><M></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraph.html#createInStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-">createInStream</a></span>(<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a> streamSpec, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><K> keySerde, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><V> msgSerde)</code> +<div class="block">Method to add an input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> from the system</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><K,V,M extends <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a><K,V>><br><a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a><M></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraph.html#createIntStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-">createIntStream</a></span>(<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a> streamSpec, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><K> keySerde, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><V> msgSerde)</code> +<div class="block">Method to add an intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> from the system</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><K,V,M extends <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a><K,V>><br><a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a><M></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraph.html#createOutStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-">createOutStream</a></span>(<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a> streamSpec, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><K> keySerde, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><V> msgSerde)</code> +<div class="block">Method to add an output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> from the system</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a>,<a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraph.html#getInStreams--">getInStreams</a></span>()</code> +<div class="block">Method to get the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a>,<a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraph.html#getOutStreams--">getOutStreams</a></span>()</code> +<div class="block">Method to get the <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><code>OutputStream</code></a>s</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraph.html#withContextManager-org.apache.samza.operators.ContextManager-">withContextManager</a></span>(<a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators">ContextManager</a> manager)</code> +<div class="block">Method to set the <a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators"><code>ContextManager</code></a> for this <a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a></div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createInStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createInStream</h4> +<pre><K,V,M extends <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a><K,V>> <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a><M> createInStream(<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a> streamSpec, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><K> keySerde, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><V> msgSerde)</pre> +<div class="block">Method to add an input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> from the system</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of key in the input message</dd> +<dd><code>V</code> - the type of message in the input message</dd> +<dd><code>M</code> - the type of <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> in the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamSpec</code> - the <a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators"><code>StreamSpec</code></a> describing the physical characteristics of the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dd><code>keySerde</code> - the serde used to serialize/deserialize the message key from the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dd><code>msgSerde</code> - the serde used to serialize/deserialize the message body from the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> object</dd> +</dl> +</li> +</ul> +<a name="createOutStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createOutStream</h4> +<pre><K,V,M extends <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a><K,V>> <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a><M> createOutStream(<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a> streamSpec, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><K> keySerde, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><V> msgSerde)</pre> +<div class="block">Method to add an output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> from the system</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of key in the output message</dd> +<dd><code>V</code> - the type of message in the output message</dd> +<dd><code>M</code> - the type of <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> in the output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamSpec</code> - the <a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators"><code>StreamSpec</code></a> describing the physical characteristics of the output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dd><code>keySerde</code> - the serde used to serialize/deserialize the message key from the output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dd><code>msgSerde</code> - the serde used to serialize/deserialize the message body from the output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the output <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> object</dd> +</dl> +</li> +</ul> +<a name="createIntStream-org.apache.samza.operators.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createIntStream</h4> +<pre><K,V,M extends <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a><K,V>> <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a><M> createIntStream(<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a> streamSpec, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><K> keySerde, + <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><V> msgSerde)</pre> +<div class="block">Method to add an intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> from the system</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of key in the intermediate message</dd> +<dd><code>V</code> - the type of message in the intermediate message</dd> +<dd><code>M</code> - the type of <a href="../../../../org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> in the intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamSpec</code> - the <a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators"><code>StreamSpec</code></a> describing the physical characteristics of the intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dd><code>keySerde</code> - the serde used to serialize/deserialize the message key from the intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dd><code>msgSerde</code> - the serde used to serialize/deserialize the message body from the intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the intermediate <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> object</dd> +</dl> +</li> +</ul> +<a name="getInStreams--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInStreams</h4> +<pre>java.util.Map<<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a>,<a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a>> getInStreams()</pre> +<div class="block">Method to get the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the input <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></dd> +</dl> +</li> +</ul> +<a name="getOutStreams--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutStreams</h4> +<pre>java.util.Map<<a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators">StreamSpec</a>,<a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a>> getOutStreams()</pre> +<div class="block">Method to get the <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><code>OutputStream</code></a>s</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the map of all <a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><code>OutputStream</code></a>s</dd> +</dl> +</li> +</ul> +<a name="withContextManager-org.apache.samza.operators.ContextManager-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>withContextManager</h4> +<pre><a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a> withContextManager(<a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators">ContextManager</a> manager)</pre> +<div class="block">Method to set the <a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators"><code>ContextManager</code></a> for this <a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>manager</code> - the <a href="../../../../org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators"><code>ContextManager</code></a> object</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this <a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a> object</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/StreamGraphBuilder.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/StreamGraph.html" target="_top">Frames</a></li> +<li><a href="StreamGraph.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraphBuilder.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraphBuilder.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraphBuilder.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/StreamGraphBuilder.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,233 @@ +<!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 (1.8.0_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>StreamGraphBuilder (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="StreamGraphBuilder (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/StreamGraphBuilder.html" target="_top">Frames</a></li> +<li><a href="StreamGraphBuilder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.operators</div> +<h2 title="Interface StreamGraphBuilder" class="title">Interface StreamGraphBuilder</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> +public interface <span class="typeNameLabel">StreamGraphBuilder</span></pre> +<div class="block">This interface defines a factory class that user will implement to create user-defined operator DAG in a <a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a> object.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/operators/StreamGraphBuilder.html#init-org.apache.samza.operators.StreamGraph-org.apache.samza.config.Config-">init</a></span>(<a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a> graph, + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> +<div class="block">Users are required to implement this abstract method to initialize the processing logic of the application, in terms + of a DAG of <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s and operators</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init-org.apache.samza.operators.StreamGraph-org.apache.samza.config.Config-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a> graph, + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> +<div class="block">Users are required to implement this abstract method to initialize the processing logic of the application, in terms + of a DAG of <a href="../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s and operators</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>graph</code> - an empty <a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a> object to be initialized</dd> +<dd><code>config</code> - the <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> of the application</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</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><a href="../../../../org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/operators/StreamSpec.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/operators/StreamGraphBuilder.html" target="_top">Frames</a></li> +<li><a href="StreamGraphBuilder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
