Modified: samza/site/learn/documentation/versioned/api/javadocs/index-all.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/versioned/api/javadocs/index-all.html?rev=1784679&r1=1784678&r2=1784679&view=diff ============================================================================== --- samza/site/learn/documentation/versioned/api/javadocs/index-all.html (original) +++ samza/site/learn/documentation/versioned/api/javadocs/index-all.html Tue Feb 28 01:45:28 2017 @@ -2,8 +2,8 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_74) on Mon Feb 27 17:42:11 PST 2017 --> -<title>Index (samza-api 0.12.0 API)</title> +<!-- Generated by javadoc (1.8.0_74) on Mon Feb 27 17:44:11 PST 2017 --> +<title>Index (samza-api 0.13.0-SNAPSHOT API)</title> <meta name="date" content="2017-02-27"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Index (samza-api 0.12.0 API)"; + parent.document.title="Index (samza-api 0.13.0-SNAPSHOT API)"; } } catch(err) { @@ -85,7 +85,7 @@ <dd> <div class="block">Creates a trigger that fires when any of the provided triggers fire.</div> </dd> -<dt><a href="org/apache/samza/operators/triggers/AnyTrigger.html" title="class in org.apache.samza.operators.triggers"><span class="typeNameLink">AnyTrigger</span></a><<a href="org/apache/samza/operators/triggers/AnyTrigger.html" title="type parameter in AnyTrigger">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Class in <a href="org/apache/samza/operators/triggers/package-summary.html">org.apache.samza.operators.triggers</a></dt> +<dt><a href="org/apache/samza/operators/triggers/AnyTrigger.html" title="class in org.apache.samza.operators.triggers"><span class="typeNameLink">AnyTrigger</span></a><<a href="org/apache/samza/operators/triggers/AnyTrigger.html" title="type parameter in AnyTrigger">M</a>> - Class in <a href="org/apache/samza/operators/triggers/package-summary.html">org.apache.samza.operators.triggers</a></dt> <dd> <div class="block">A <a href="org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a> fires as soon as any of its individual triggers has fired.</div> </dd> @@ -95,23 +95,23 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/FilterFunction.html#apply-M-">apply(M)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/FilterFunction.html" title="interface in org.apache.samza.operators.functions">FilterFunction</a></dt> <dd> -<div class="block">Returns a boolean indicating whether this <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> should be retained or filtered out.</div> +<div class="block">Returns a boolean indicating whether this message should be retained or filtered out.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/FlatMapFunction.html#apply-M-">apply(M)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions">FlatMapFunction</a></dt> <dd> -<div class="block">Transforms the provided <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> into a collection of 0 or more <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s.</div> +<div class="block">Transforms the provided message into a collection of 0 or more messages.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/JoinFunction.html#apply-M-JM-">apply(M, JM)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions">JoinFunction</a></dt> <dd> -<div class="block">Join the provided <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s and produces the joined <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>.</div> +<div class="block">Join the provided input messages and produces the joined messages.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/MapFunction.html#apply-M-">apply(M)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/MapFunction.html" title="interface in org.apache.samza.operators.functions">MapFunction</a></dt> <dd> -<div class="block">Transforms the provided <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> into another <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a></div> +<div class="block">Transforms the provided message into another message</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/SinkFunction.html#apply-M-org.apache.samza.task.MessageCollector-org.apache.samza.task.TaskCoordinator-">apply(M, MessageCollector, TaskCoordinator)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions">SinkFunction</a></dt> <dd> -<div class="block">Allows sending the provided <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> to an output <a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> using +<div class="block">Allows sending the provided message to an output <a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> using the provided <a href="org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>.</div> </dd> <dt><a href="org/apache/samza/task/AsyncStreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">AsyncStreamTask</span></a> - Interface in <a href="org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> @@ -298,9 +298,17 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#containsValue-java.lang.Object-">containsValue(Object)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> <dd> </dd> +<dt><a href="org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">ContextManager</span></a> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> +<dd> +<div class="block">Interface class defining methods to initialize and finalize the context used by the transformation functions.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#copyWithPartitionCount-int-">copyWithPartitionCount(int)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> +<div class="block">Copies this StreamSpec, but applies a new partitionCount.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/triggers/Triggers.html#count-long-">count(long)</a></span> - Static method in class org.apache.samza.operators.triggers.<a href="org/apache/samza/operators/triggers/Triggers.html" title="class in org.apache.samza.operators.triggers">Triggers</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a> that fires when the number of <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s in the pane +<div class="block">Creates a <a href="org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a> that fires when the number of messages in the pane reaches the specified count.</div> </dd> <dt><a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Counter</span></a> - Class in <a href="org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> @@ -311,20 +319,24 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsVisitor.html#counter-org.apache.samza.metrics.Counter-">counter(Counter)</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt> <dd> </dd> -<dt><a href="org/apache/samza/operators/triggers/CountTrigger.html" title="class in org.apache.samza.operators.triggers"><span class="typeNameLink">CountTrigger</span></a><<a href="org/apache/samza/operators/triggers/CountTrigger.html" title="type parameter in CountTrigger">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Class in <a href="org/apache/samza/operators/triggers/package-summary.html">org.apache.samza.operators.triggers</a></dt> +<dt><a href="org/apache/samza/operators/triggers/CountTrigger.html" title="class in org.apache.samza.operators.triggers"><span class="typeNameLink">CountTrigger</span></a><<a href="org/apache/samza/operators/triggers/CountTrigger.html" title="type parameter in CountTrigger">M</a>> - Class in <a href="org/apache/samza/operators/triggers/package-summary.html">org.apache.samza.operators.triggers</a></dt> <dd> <div class="block">A <a href="org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a> that fires when the number of messages in the <a href="org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a> reaches the specified count.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#createChangelogStream-java.lang.String-int-">createChangelogStream(String, int)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> <dd> -<div class="block">An API to create a change log stream</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 0.12.1, use <a href="org/apache/samza/system/SystemAdmin.html#createStream-org.apache.samza.system.StreamSpec-"><code>SystemAdmin.createStream(StreamSpec)</code></a></span></div> +</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html#createChangelogStream-java.lang.String-int-">createChangelogStream(String, int)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#createCoordinatorStream-java.lang.String-">createCoordinatorStream(String)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> <dd> -<div class="block">Create a stream for the job coordinator.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 0.12.1, use <a href="org/apache/samza/system/SystemAdmin.html#createStream-org.apache.samza.system.StreamSpec-"><code>SystemAdmin.createStream(StreamSpec)</code></a></span></div> +</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html#createCoordinatorStream-java.lang.String-">createCoordinatorStream(String)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dt> <dd> </dd> @@ -332,6 +344,22 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/task/StreamTaskFactory.html#createInstance--">createInstance()</a></span> - Method in interface org.apache.samza.task.<a href="org/apache/samza/task/StreamTaskFactory.html" title="interface in org.apache.samza.task">StreamTaskFactory</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/StreamGraph.html#createInStream-org.apache.samza.system.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-">createInStream(StreamSpec, Serde<K>, Serde<V>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/StreamGraph.html#createIntStream-org.apache.samza.system.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-">createIntStream(StreamSpec, Serde<K>, Serde<V>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/StreamGraph.html#createOutStream-org.apache.samza.system.StreamSpec-org.apache.samza.serializers.Serde-org.apache.samza.serializers.Serde-">createOutStream(StreamSpec, Serde<K>, Serde<V>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#createStream-org.apache.samza.system.StreamSpec-">createStream(StreamSpec)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> +<dd> +<div class="block">Create a stream described by the spec.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/Clock.html#currentTimeMillis--">currentTimeMillis()</a></span> - Method in interface org.apache.samza.util.<a href="org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a></dt> <dd> </dd> </dl> @@ -344,6 +372,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Counter.html#dec-long-">dec(long)</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExecutionEnvironment.html#DEFAULT_ENVIRONMENT_CLASS">DEFAULT_ENVIRONMENT_CLASS</a></span> - Static variable in interface org.apache.samza.system.<a href="org/apache/samza/system/ExecutionEnvironment.html" title="interface in org.apache.samza.system">ExecutionEnvironment</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.html#delete-K-">delete(K)</a></span> - Method in interface org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a></dt> <dd> <div class="block">Deletes the mapping for the specified <code>key</code> from this key-value store (if such mapping exists).</div> @@ -386,6 +416,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#entrySet--">entrySet()</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExecutionEnvironment.html#ENVIRONMENT_CONFIG">ENVIRONMENT_CONFIG</a></span> - Static variable in interface org.apache.samza.system.<a href="org/apache/samza/system/ExecutionEnvironment.html" title="interface in org.apache.samza.system">ExecutionEnvironment</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/Checkpoint.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> @@ -408,6 +440,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartition.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> <dd> </dd> +<dt><a href="org/apache/samza/system/ExecutionEnvironment.html" title="interface in org.apache.samza.system"><span class="typeNameLink">ExecutionEnvironment</span></a> - Interface in <a href="org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> +<dd> +<div class="block">Interface to be implemented by physical execution engine to deploy the config and jobs to run the <a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a></div> +</dd> <dt><a href="org/apache/samza/system/ExtendedSystemAdmin.html" title="interface in org.apache.samza.system"><span class="typeNameLink">ExtendedSystemAdmin</span></a> - Interface in <a href="org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> <dd> <div class="block">Interface extends the more generic SystemAdmin interface @@ -427,23 +463,27 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#filter-org.apache.samza.operators.functions.FilterFunction-">filter(FilterFunction<M>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> <dd> -<div class="block">Applies the provided <a href="org/apache/samza/operators/functions/FilterFunction.html" title="interface in org.apache.samza.operators.functions"><code>FilterFunction</code></a> to <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s in this <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> and returns the +<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> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartitionMatcher.html#filter-java.util.Set-org.apache.samza.config.Config-">filter(Set<SystemStreamPartition>, Config)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartitionMatcher.html" title="interface in org.apache.samza.system">SystemStreamPartitionMatcher</a></dt> <dd> </dd> -<dt><a href="org/apache/samza/operators/functions/FilterFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">FilterFunction</span></a><<a href="org/apache/samza/operators/functions/FilterFunction.html" title="type parameter in FilterFunction">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> +<dt><a href="org/apache/samza/operators/functions/FilterFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">FilterFunction</span></a><<a href="org/apache/samza/operators/functions/FilterFunction.html" title="type parameter in FilterFunction">M</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> -<div class="block">A function that specifies whether a <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> should be retained for further processing or filtered out.</div> +<div class="block">A function that specifies whether a message should be retained for further processing or filtered out.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/ContextManager.html#finalizeTaskContext--">finalizeTaskContext()</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators">ContextManager</a></dt> +<dd> +<div class="block">The finalize method to allow users to close resource initialized in <a href="org/apache/samza/operators/ContextManager.html#initTaskContext-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-"><code>ContextManager.initTaskContext(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)</code></a> method.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#flatMap-org.apache.samza.operators.functions.FlatMapFunction-">flatMap(FlatMapFunction<M, TM>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> <dd> -<div class="block">Applies the provided 1:n <a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions"><code>FlatMapFunction</code></a> to transform a <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> in this <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> - to n <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s in the transformed <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a></div> +<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> </dd> -<dt><a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">FlatMapFunction</span></a><<a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="type parameter in FlatMapFunction">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>,<a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="type parameter in FlatMapFunction">OM</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> +<dt><a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">FlatMapFunction</span></a><<a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="type parameter in FlatMapFunction">M</a>,<a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="type parameter in FlatMapFunction">OM</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> -<div class="block">A function that transforms a <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> into a collection of 0 or more <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s, +<div class="block">A function that transforms an input message into a collection of 0 or more messages, possibly of a different type.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.html#flush--">flush()</a></span> - Method in interface org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a></dt> @@ -463,6 +503,10 @@ <dd> <div class="block">Deserializes given serialized object from an array of bytes to its original form.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExecutionEnvironment.html#fromConfig-org.apache.samza.config.Config-">fromConfig(Config)</a></span> - Static method in interface org.apache.samza.system.<a href="org/apache/samza/system/ExecutionEnvironment.html" title="interface in org.apache.samza.system">ExecutionEnvironment</a></dt> +<dd> +<div class="block">Static method to load the non-standalone environment.</div> +</dd> </dl> <a name="I:G"> <!-- --> @@ -486,6 +530,8 @@ <dd> <div class="block">Gets the value associated with the specified <code>key</code>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#get-java.lang.String-">get(String)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemFactory.html#getAdmin-java.lang.String-org.apache.samza.config.Config-">getAdmin(String, Config)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.Extension.html#getAll-org.apache.samza.storage.kv.KeyValueStore-java.util.List-">getAll(KeyValueStore<K, V>, List<K>)</a></span> - Static method in class org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/KeyValueStore.Extension.html" title="class in org.apache.samza.storage.kv">KeyValueStore.Extension</a></dt> @@ -520,6 +566,8 @@ <dd> <div class="block">Build a specific Config.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getConfig--">getConfig()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemFactory.html#getConsumer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getConsumer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Counter.html#getCount--">getCount()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> @@ -558,6 +606,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getEventTimeExtractor--">getEventTimeExtractor()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/JoinFunction.html#getFirstKey-M-">getFirstKey(M)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions">JoinFunction</a></dt> +<dd> +<div class="block">Method to get the join key in the messages from the first input stream</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getFoldFunction--">getFoldFunction()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsAccessor.html#getGaugeValues-java.lang.String-java.lang.String-">getGaugeValues(String, String)</a></span> - Method in interface org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics">MetricsAccessor</a></dt> @@ -568,13 +620,19 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/ReadableMetricsRegistry.html#getGroups--">getGroups()</a></span> - Method in interface org.apache.samza.metrics.<a href="org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getId--">getId()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/StreamGraph.html#getInStreams--">getInStreams()</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a></dt> +<dd> +<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> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getInt-java.lang.String-int-">getInt(String, int)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getInt-java.lang.String-">getInt(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/StreamJobFactory.html#getJob-org.apache.samza.config.Config-">getJob(Config)</a></span> - Method in interface org.apache.samza.job.<a href="org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job">StreamJobFactory</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html#getKey--">getKey()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html" title="class in org.apache.samza.operators.data">IncomingSystemMessageEnvelope</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/InputMessageEnvelope.html#getKey--">getKey()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/InputMessageEnvelope.html" title="class in org.apache.samza.operators.data">InputMessageEnvelope</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/MessageEnvelope.html#getKey--">getKey()</a></span> - Method in interface org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a></dt> <dd> @@ -600,6 +658,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getList-java.lang.String-">getList(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExecutionEnvironment.html#getLocalEnvironment-org.apache.samza.config.Config-">getLocalEnvironment(Config)</a></span> - Static method in interface org.apache.samza.system.<a href="org/apache/samza/system/ExecutionEnvironment.html" title="interface in org.apache.samza.system">ExecutionEnvironment</a></dt> +<dd> +<div class="block">Static method to load the local standalone environment</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getLong-java.lang.String-long-">getLong(String, long)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getLong-java.lang.String-">getLong(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> @@ -612,7 +674,7 @@ <dd> <div class="block">Helper method to get the maximum offset</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html#getMessage--">getMessage()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html" title="class in org.apache.samza.operators.data">IncomingSystemMessageEnvelope</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/InputMessageEnvelope.html#getMessage--">getMessage()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/InputMessageEnvelope.html" title="class in org.apache.samza.operators.data">InputMessageEnvelope</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/MessageEnvelope.html#getMessage--">getMessage()</a></span> - Method in interface org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a></dt> <dd> @@ -656,7 +718,7 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/BlockingEnvelopeMap.html#getNumMessagesInQueue-org.apache.samza.system.SystemStreamPartition-">getNumMessagesInQueue(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html#getOffset--">getOffset()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html" title="class in org.apache.samza.operators.data">IncomingSystemMessageEnvelope</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/InputMessageEnvelope.html#getOffset--">getOffset()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/InputMessageEnvelope.html" title="class in org.apache.samza.operators.data">InputMessageEnvelope</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#getOffset--">getOffset()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> <dd> </dd> @@ -675,22 +737,42 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOldestOffset--">getOldestOffset()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getOrDefault-java.lang.String-java.lang.String-">getOrDefault(String, String)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/StreamGraph.html#getOutStreams--">getOutStreams()</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators">StreamGraph</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/WindowKey.html#getPaneId--">getPaneId()</a></span> - Method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartition.html#getPartition--">getPartition()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getPartitionCount--">getPartitionCount()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/Partition.html#getPartitionId--">getPartitionId()</a></span> - Method in class org.apache.samza.<a href="org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey--">getPartitionKey()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getPhysicalName--">getPhysicalName()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemFactory.html#getProducer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getProducer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/task/TaskContext.html#getSamzaContainerContext--">getSamzaContainerContext()</a></span> - Method in interface org.apache.samza.task.<a href="org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/JoinFunction.html#getSecondKey-JM-">getSecondKey(JM)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions">JoinFunction</a></dt> +<dd> +<div class="block">Method to get the join key in the messages from the second input stream</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/serializers/SerdeFactory.html#getSerde-java.lang.String-org.apache.samza.config.Config-">getSerde(String, Config)</a></span> - Method in interface org.apache.samza.serializers.<a href="org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers">SerdeFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getShort-java.lang.String-short-">getShort(String, short)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getShort-java.lang.String-">getShort(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/OutputStream.html#getSinkFunction--">getSinkFunction()</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators">OutputStream</a></dt> +<dd> +<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> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Snapshot.html#getSize--">getSize()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> <dd> <div class="block">Get the number of values in the collection</div> @@ -727,6 +809,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStream.html#getSystem--">getSystem()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getSystemName--">getSystemName()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream--">getSystemStream()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartition.html#getSystemStream--">getSystemStream()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> @@ -737,7 +821,7 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html#getSystemStreamMetadata-java.util.Set-">getSystemStreamMetadata(Set<String>)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html#getSystemStreamPartition--">getSystemStreamPartition()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html" title="class in org.apache.samza.operators.data">IncomingSystemMessageEnvelope</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/InputMessageEnvelope.html#getSystemStreamPartition--">getSystemStreamPartition()</a></span> - Method in class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/InputMessageEnvelope.html" title="class in org.apache.samza.operators.data">InputMessageEnvelope</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#getSystemStreamPartition--">getSystemStreamPartition()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> <dd> </dd> @@ -761,6 +845,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getUpcomingOffset--">getUpcomingOffset()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/task/TaskContext.html#getUserDefinedContext--">getUserDefinedContext()</a></span> - Method in interface org.apache.samza.task.<a href="org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></dt> +<dd> +<div class="block">Method to allow user to return customized context</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Gauge.html#getValue--">getValue()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/Entry.html#getValue--">getValue()</a></span> - Method in class org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a></dt> @@ -773,15 +861,13 @@ <dd> <div class="block">Return the entire list of values</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/WindowKey.html#getWindowId--">getWindowId()</a></span> - Method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#globalWindow-java.util.function.BiFunction-">globalWindow(BiFunction<M, WV, WV>)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s into a single global window.</div> +<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages into a single global window.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#globalWindow--">globalWindow()</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s into a single global window.</div> +<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages into a single global window.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html#group-java.util.Set-">group(Set<SystemStreamPartition>)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionGrouper</a></dt> <dd> </dd> @@ -848,25 +934,29 @@ <dd> <div class="block">Constructs a new IncomingMessageEnvelope from specified components.</div> </dd> -<dt><a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html" title="class in org.apache.samza.operators.data"><span class="typeNameLink">IncomingSystemMessageEnvelope</span></a> - Class in <a href="org/apache/samza/operators/data/package-summary.html">org.apache.samza.operators.data</a></dt> -<dd> -<div class="block">A <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> that provides additional information about its input <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a> - and its <a href="org/apache/samza/operators/data/Offset.html" title="interface in org.apache.samza.operators.data"><code>Offset</code></a> within the <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div> -</dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html#IncomingSystemMessageEnvelope-org.apache.samza.system.IncomingMessageEnvelope-">IncomingSystemMessageEnvelope(IncomingMessageEnvelope)</a></span> - Constructor for class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/IncomingSystemMessageEnvelope.html" title="class in org.apache.samza.operators.data">IncomingSystemMessageEnvelope</a></dt> -<dd> -<div class="block">Creates an <code>IncomingSystemMessageEnvelope</code> from the <a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>.</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incPoll--">incPoll()</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsValidator.html#init-org.apache.samza.config.Config-">init(Config)</a></span> - Method in interface org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsValidator.html" title="interface in org.apache.samza.metrics">MetricsValidator</a></dt> <dd> <div class="block">Initialize with config.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/InitableFunction.html#init-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">init(Config, TaskContext)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a></dt> +<dd> +<div class="block">Interface method to initialize the context for a specific message transformation function.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/StreamGraphBuilder.html#init-org.apache.samza.operators.StreamGraph-org.apache.samza.config.Config-">init(StreamGraph, Config)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/StreamGraphBuilder.html" title="interface in org.apache.samza.operators">StreamGraphBuilder</a></dt> +<dd> +<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> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/task/InitableTask.html#init-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">init(Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task">InitableTask</a></dt> <dd> <div class="block">Called by TaskRunner each time an implementing task is created.</div> </dd> +<dt><a href="org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">InitableFunction</span></a> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> +<dd> +<div class="block">interface defined to initalize the context of message transformation functions</div> +</dd> <dt><a href="org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">InitableTask</span></a> - Interface in <a href="org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> <dd> <div class="block">Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks @@ -874,6 +964,19 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#initMetrics-org.apache.samza.system.SystemStreamPartition-">initMetrics(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/ContextManager.html#initTaskContext-org.apache.samza.config.Config-org.apache.samza.task.TaskContext-">initTaskContext(Config, TaskContext)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/ContextManager.html" title="interface in org.apache.samza.operators">ContextManager</a></dt> +<dd> +<div class="block">The initialization method to create shared context for the whole task in Samza.</div> +</dd> +<dt><a href="org/apache/samza/operators/data/InputMessageEnvelope.html" title="class in org.apache.samza.operators.data"><span class="typeNameLink">InputMessageEnvelope</span></a> - Class in <a href="org/apache/samza/operators/data/package-summary.html">org.apache.samza.operators.data</a></dt> +<dd> +<div class="block">A <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> that provides additional information about its input <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a> + and its <a href="org/apache/samza/operators/data/Offset.html" title="interface in org.apache.samza.operators.data"><code>Offset</code></a> within the <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/data/InputMessageEnvelope.html#InputMessageEnvelope-org.apache.samza.system.IncomingMessageEnvelope-">InputMessageEnvelope(IncomingMessageEnvelope)</a></span> - Constructor for class org.apache.samza.operators.data.<a href="org/apache/samza/operators/data/InputMessageEnvelope.html" title="class in org.apache.samza.operators.data">InputMessageEnvelope</a></dt> +<dd> +<div class="block">Creates an <code>InputMessageEnvelope</code> from the <a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>.</div> +</dd> <dt><a href="org/apache/samza/annotation/InterfaceStability.html" title="class in org.apache.samza.annotation"><span class="typeNameLink">InterfaceStability</span></a> - Class in <a href="org/apache/samza/annotation/package-summary.html">org.apache.samza.annotation</a></dt> <dd> <div class="block">Annotation to inform users of how much to rely on a particular package, @@ -919,14 +1022,14 @@ </a> <h2 class="title">J</h2> <dl> -<dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#join-org.apache.samza.operators.MessageStream-org.apache.samza.operators.functions.JoinFunction-">join(MessageStream<OM>, JoinFunction<M, OM, RM>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#join-org.apache.samza.operators.MessageStream-org.apache.samza.operators.functions.JoinFunction-">join(MessageStream<OM>, JoinFunction<K, M, OM, RM>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> <dd> <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> </dd> -<dt><a href="org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">JoinFunction</span></a><<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>,<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">JM</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>,<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">RM</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Interface in <a href="org/apache/samza/operato rs/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> +<dt><a href="org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">JoinFunction</span></a><<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">K</a>,<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">M</a>,<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">JM</a>,<a href="org/apache/samza/operators/functions/JoinFunction.html" title="type parameter in JoinFunction">RM</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> -<div class="block">A function that joins <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s from two <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s and produces - a joined <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>.</div> +<div class="block">A function that joins messages from two <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s and produces + a joined message.</div> </dd> </dl> <a name="I:K"> @@ -936,29 +1039,29 @@ <dl> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#keyedGlobalWindow-java.util.function.Function-java.util.function.BiFunction-">keyedGlobalWindow(Function<M, K>, BiFunction<M, WV, WV>)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Returns a global <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s using the provided keyFn.</div> +<div class="block">Returns a global <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages using the provided keyFn.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#keyedGlobalWindow-java.util.function.Function-">keyedGlobalWindow(Function<M, K>)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Returns a global <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s using the provided keyFn.</div> +<div class="block">Returns a global <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages using the provided keyFn.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#keyedSessionWindow-java.util.function.Function-java.time.Duration-java.util.function.BiFunction-">keyedSessionWindow(Function<M, K>, Duration, BiFunction<M, WV, WV>)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s into sessions per-key based on the provided <code>sessionGap</code> +<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages into sessions per-key based on the provided <code>sessionGap</code> and applies the provided fold function to them.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#keyedSessionWindow-java.util.function.Function-java.time.Duration-">keyedSessionWindow(Function<M, K>, Duration)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s into sessions per-key based on the provided <code>sessionGap</code>.</div> +<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages into sessions per-key based on the provided <code>sessionGap</code>.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#keyedTumblingWindow-java.util.function.Function-java.time.Duration-java.util.function.BiFunction-">keyedTumblingWindow(Function<M, K>, Duration, BiFunction<M, WV, WV>)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s into fixed-size, non-overlapping processing +<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages into fixed-size, non-overlapping processing time based windows based on the provided keyFn and applies the provided fold function to them.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/Windows.html#keyedTumblingWindow-java.util.function.Function-java.time.Duration-">keyedTumblingWindow(Function<M, K>, Duration)</a></span> - Static method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows">Windows</a></dt> <dd> -<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s into fixed-size, non-overlapping +<div class="block">Creates a <a href="org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> that groups incoming messages into fixed-size, non-overlapping processing time based windows using the provided keyFn.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#keySet--">keySet()</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> @@ -999,7 +1102,7 @@ <dl> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#map-org.apache.samza.operators.functions.MapFunction-">map(MapFunction<M, TM>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> <dd> -<div class="block">Applies the provided 1:1 <a href="org/apache/samza/operators/functions/MapFunction.html" title="interface in org.apache.samza.operators.functions"><code>MapFunction</code></a> to <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s in this <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> and returns the +<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> </dd> <dt><a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config"><span class="typeNameLink">MapConfig</span></a> - Class in <a href="org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> @@ -1012,9 +1115,9 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#MapConfig-java.util.List-">MapConfig(List<Map<String, String>>)</a></span> - Constructor for class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> <dd> </dd> -<dt><a href="org/apache/samza/operators/functions/MapFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">MapFunction</span></a><<a href="org/apache/samza/operators/functions/MapFunction.html" title="type parameter in MapFunction">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>,<a href="org/apache/samza/operators/functions/MapFunction.html" title="type parameter in MapFunction">OM</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> +<dt><a href="org/apache/samza/operators/functions/MapFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">MapFunction</span></a><<a href="org/apache/samza/operators/functions/MapFunction.html" title="type parameter in MapFunction">M</a>,<a href="org/apache/samza/operators/functions/MapFunction.html" title="type parameter in MapFunction">OM</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> -<div class="block">A function that transforms a <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> into another <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>, possibly of a different type.</div> +<div class="block">A function that transforms an input message into another message, possibly of a different type.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#merge-java.util.Collection-">merge(Collection<MessageStream<M>>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> <dd> @@ -1035,11 +1138,11 @@ </dd> <dt><a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><span class="typeNameLink">MessageEnvelope</span></a><<a href="org/apache/samza/operators/data/MessageEnvelope.html" title="type parameter in MessageEnvelope">K</a>,<a href="org/apache/samza/operators/data/MessageEnvelope.html" title="type parameter in MessageEnvelope">M</a>> - Interface in <a href="org/apache/samza/operators/data/package-summary.html">org.apache.samza.operators.data</a></dt> <dd> -<div class="block">An entry in the input/output <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s.</div> +<div class="block">An entry in the input/output <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s</div> </dd> -<dt><a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">MessageStream</span></a><<a href="org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> +<dt><a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">MessageStream</span></a><<a href="org/apache/samza/operators/MessageStream.html" title="type parameter in MessageStream">M</a>> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> <dd> -<div class="block">Represents a stream of <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s.</div> +<div class="block">Represents a stream of messages.</div> </dd> <dt><a href="org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Metric</span></a> - Interface in <a href="org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> <dd> @@ -1230,6 +1333,10 @@ <dd> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> </dd> +<dt><a href="org/apache/samza/operators/OutputStream.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">OutputStream</span></a><<a href="org/apache/samza/operators/OutputStream.html" title="type parameter in OutputStream">M</a>> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> +<dd> +<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> +</dd> </dl> <a name="I:P"> <!-- --> @@ -1246,6 +1353,10 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartition.html#partition">partition</a></span> - Variable in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#partitionBy-java.util.function.Function-">partitionBy(Function<M, K>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> +<dd> +<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> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemConsumer.html#poll-java.util.Set-long-">poll(Set<SystemStreamPartition>, long)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></dt> <dd> <div class="block">Poll the SystemConsumer to get any available messages from the underlying @@ -1352,6 +1463,10 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/ConfigRewriter.html#rewrite-java.lang.String-org.apache.samza.config.Config-">rewrite(String, Config)</a></span> - Method in interface org.apache.samza.config.<a href="org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config">ConfigRewriter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExecutionEnvironment.html#run-org.apache.samza.operators.StreamGraphBuilder-org.apache.samza.config.Config-">run(StreamGraphBuilder, Config)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/ExecutionEnvironment.html" title="interface in org.apache.samza.system">ExecutionEnvironment</a></dt> +<dd> +<div class="block">Method to be invoked to deploy and run the actual Samza jobs to execute <a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><code>StreamGraph</code></a></div> +</dd> </dl> <a name="I:S"> <!-- --> @@ -1391,6 +1506,10 @@ <dd> <div class="block">Sends message envelope out onto specified stream.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#sendTo-org.apache.samza.operators.OutputStream-">sendTo(OutputStream<M>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> +<dd> +<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> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#SENSITIVE_MASK">SENSITIVE_MASK</a></span> - Static variable in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#SENSITIVE_PREFIX">SENSITIVE_PREFIX</a></span> - Static variable in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> @@ -1464,12 +1583,11 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/MessageStream.html#sink-org.apache.samza.operators.functions.SinkFunction-">sink(SinkFunction<M>)</a></span> - Method in interface org.apache.samza.operators.<a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators">MessageStream</a></dt> <dd> -<div class="block">Allows sending <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a>s 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/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> 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> +<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> </dd> -<dt><a href="org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">SinkFunction</span></a><<a href="org/apache/samza/operators/functions/SinkFunction.html" title="type parameter in SinkFunction">M</a> extends <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data">MessageEnvelope</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> +<dt><a href="org/apache/samza/operators/functions/SinkFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">SinkFunction</span></a><<a href="org/apache/samza/operators/functions/SinkFunction.html" title="type parameter in SinkFunction">M</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> -<div class="block">A function that allows sending a <a href="org/apache/samza/operators/data/MessageEnvelope.html" title="interface in org.apache.samza.operators.data"><code>MessageEnvelope</code></a> to an output system.</div> +<div class="block">A function that allows sending a message to an output system.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#size--">size()</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> <dd> </dd> @@ -1563,6 +1681,14 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStream.html#stream">stream</a></span> - Variable in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt> <dd> </dd> +<dt><a href="org/apache/samza/operators/StreamGraph.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">StreamGraph</span></a> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> +<dd> +<div class="block">Job-level programming interface to create an operator DAG and run in various different runtime environments.</div> +</dd> +<dt><a href="org/apache/samza/operators/StreamGraphBuilder.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">StreamGraphBuilder</span></a> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> +<dd> +<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> +</dd> <dt><a href="org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="typeNameLink">StreamJob</span></a> - Interface in <a href="org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt> <dd> <div class="block">A StreamJob runs Samza <a href="org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s in its specific environment.</div> @@ -1571,10 +1697,18 @@ <dd> <div class="block">Build a <a href="org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a></div> </dd> -<dt><a href="org/apache/samza/operators/StreamOperatorTask.html" title="interface in org.apache.samza.operators"><span class="typeNameLink">StreamOperatorTask</span></a> - Interface in <a href="org/apache/samza/operators/package-summary.html">org.apache.samza.operators</a></dt> +<dt><a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system"><span class="typeNameLink">StreamSpec</span></a> - Class in <a href="org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> <dd> -<div class="block">A <a href="org/apache/samza/operators/StreamOperatorTask.html" title="interface in org.apache.samza.operators"><code>StreamOperatorTask</code></a> is the basic interface to implement for processing <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>s.</div> +<div class="block">StreamSpec is a blueprint for creating, validating, or simply describing a stream in the runtime environment.</div> </dd>
[... 141 lines stripped ...]
