Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-summary.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-summary.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.metrics (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.metrics (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -82,19 +82,30 @@ </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">A MetricsRegistry allows its users to create new <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a>s and + have those metrics wired to specific metrics systems, such as JMX, provided by <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics">MetricsReporter</a></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive + metrics from the Samza framework and Samza jobs.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics">MetricsReporterFactory</a></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">Build a <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a></div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">A ReadableMetricsRegistry is a <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> that also + allows read access to the metrics for which it is responsible.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistryListener</a></td> @@ -114,41 +125,26 @@ <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></td> <td class="colLast"> -<div class="block">A counter is a metric that represents a cumulative value.</div> +<div class="block">A counter is a <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that represents a cumulative value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">A Gauge is a <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that wraps some instance of T in a thread-safe + reference and allows it to be set or retrieved.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></td> <td class="colLast"> -<div class="block">A metric visitor visits a metric, before metrics are flushed to a metrics stream.</div> +<div class="block">A MetricsVisitor can be used to process each metric in a <a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>ReadableMetricsRegistry</code></a>, + encapsulating the logic of what to be done with each metric in the counter and gauge methods.</div> </td> </tr> </tbody> </table> </li> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> -<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Enum</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics">DataType</a></td> -<td class="colLast"> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics">MetricsType</a></td> -<td class="colLast"> </td> -</tr> -</tbody> -</table> -</li> </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== -->
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-tree.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-tree.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.metrics Class Hierarchy (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.metrics Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.metrics Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.metrics Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -91,19 +91,6 @@ <li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporterFactory</span></a></li> <li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics"><span class="strong">ReadableMetricsRegistryListener</span></a></li> </ul> -<h2 title="Enum Hierarchy">Enum Hierarchy</h2> -<ul> -<li type="circle">java.lang.Object -<ul> -<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) -<ul> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">MetricsType</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">DataType</span></a></li> -</ul> -</li> -</ul> -</li> -</ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-frame.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-frame.html Thu Jul 24 05:05:00 2014 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> </head> <body> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-summary.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-summary.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -77,7 +77,7 @@ <tr class="altColor"> <td class="colFirst"><a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></td> <td class="colLast"> -<div class="block">Used to represent a Samza stream partition.</div> +<div class="block">A numbered, ordered partition of a stream.</div> </td> </tr> </tbody> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-tree.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-tree.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza Class Hierarchy (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -73,7 +73,7 @@ <ul> <li type="circle">java.lang.Object <ul> -<li type="circle">org.apache.samza.<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza"><span class="strong">Partition</span></a></li> +<li type="circle">org.apache.samza.<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza"><span class="strong">Partition</span></a> (implements java.lang.Comparable<T>)</li> <li type="circle">java.lang.Throwable (implements java.io.Serializable) <ul> <li type="circle">java.lang.Exception Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Deserializer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Deserializer.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Deserializer.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Deserializer.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>Deserializer (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>Deserializer (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deserializer (samza-api 0.7.0 API)"; + parent.document.title="Deserializer (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -85,7 +85,7 @@ <div class="description"> <ul class="blockList"> <li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object this deserializer should be implemented to deserialize.</dd></dl> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object implementations can read</dd></dl> <dl> <dt>All Known Subinterfaces:</dt> <dd><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><T></dd> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serde.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serde.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serde.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serde.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>Serde (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>Serde (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Serde (samza-api 0.7.0 API)"; + parent.document.title="Serde (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -85,6 +85,7 @@ <div class="description"> <ul class="blockList"> <li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object implementations can both read and write</dd></dl> <dl> <dt>All Superinterfaces:</dt> <dd><a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a><T>, <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T></dd> @@ -93,6 +94,9 @@ <br> <pre>public interface <span class="strong">Serde<T></span> extends <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T>, <a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a><T></pre> +<div class="block">A Serde is a convenience type that implements both the <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><code>Serializer</code></a> and + <a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><code>Deserializer</code></a> interfaces, allowing it to both read and write data + in its value type, T.</div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/SerdeFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/SerdeFactory.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/SerdeFactory.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/SerdeFactory.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SerdeFactory (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SerdeFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SerdeFactory (samza-api 0.7.0 API)"; + parent.document.title="SerdeFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -85,9 +85,11 @@ <div class="description"> <ul class="blockList"> <li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object this factory's output can both read and write</dd></dl> <hr> <br> <pre>public interface <span class="strong">SerdeFactory<T></span></pre> +<div class="block">Build an instance of <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><code>Serde</code></a></div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serializer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serializer.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serializer.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serializer.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>Serializer (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>Serializer (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Serializer (samza-api 0.7.0 API)"; + parent.document.title="Serializer (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -85,7 +85,7 @@ <div class="description"> <ul class="blockList"> <li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of object this serializer should be implemented to serialize.</dd></dl> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object implementations can write</dd></dl> <dl> <dt>All Known Subinterfaces:</dt> <dd><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><T></dd> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-frame.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-frame.html Thu Jul 24 05:05:00 2014 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.serializers (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-summary.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-summary.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.serializers (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.serializers (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -83,11 +83,17 @@ </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><T></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">A Serde is a convenience type that implements both the <a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><code>Serializer</code></a> and + <a href="../../../../org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><code>Deserializer</code></a> interfaces, allowing it to both read and write data + in its value type, T.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers">SerdeFactory</a><T></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">Build an instance of <a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><code>Serde</code></a></div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a><T></td> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-tree.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-tree.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.serializers Class Hierarchy (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.serializers Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.serializers Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.serializers Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngine.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngine.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngine.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngine.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 --> -<title>StorageEngine (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>StorageEngine (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="StorageEngine (samza-api 0.7.0 API)"; + parent.document.title="StorageEngine (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -90,7 +90,7 @@ <pre>public interface <span class="strong">StorageEngine</span></pre> <div class="block">A storage engine for managing state maintained by a stream processor. - This interface does not specify any query capabilities, which, of course, + <p>This interface does not specify any query capabilities, which, of course, would be query engine specific. Instead it just specifies the minimum functionality required to reload a storage engine from its changelog as well as basic lifecycle management.</div> @@ -120,7 +120,9 @@ </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StorageEngine.html#restore(java.util.Iterator)">restore</a></strong>(java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/storage/StorageEngine.html#restore(java.util.Iterator)">restore</a></strong>(java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> +<div class="block">Restore the content of this StorageEngine from the changelog.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> @@ -150,6 +152,10 @@ <li class="blockList"> <h4>restore</h4> <pre>void restore(java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</pre> +<div class="block">Restore the content of this StorageEngine from the changelog. Messages are provided + in one <code>Iterator</code> and not deserialized for efficiency, allowing the + implementation to optimize replay, if possible.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelopes</code> - </dd></dl> </li> </ul> <a name="flush()"> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 --> -<title>StorageEngineFactory (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>StorageEngineFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="StorageEngineFactory (samza-api 0.7.0 API)"; + parent.document.title="StorageEngineFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -151,7 +151,7 @@ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> changeLogSystemStreamPartition, <a href="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a> containerContext)</pre> <div class="block">Create an instance of the given storage engine.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storeName</code> - The name of the storage engine.</dd><dd><code>storeDir</code> - The directory of the storage engine.</dd><dd><code>keySerde</code> - The serializer to use for serializing keys when reading or writing to the store.</dd><dd><code>msgSerde</code> - The serializer to use for serializing messages when reading or writing to the store.</dd><dd><code>changeLogSystemStreamPartition</code> - Samza stream partition from which to receive the changelog from.</dd><dd><code>containerContext</code> - Information about the container in which the task is executing.</dd> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storeName</code> - The name of the storage engine.</dd><dd><code>storeDir</code> - The directory of the storage engine.</dd><dd><code>keySerde</code> - The serializer to use for serializing keys when reading or writing to the store.</dd><dd><code>msgSerde</code> - The serializer to use for serializing messages when reading or writing to the store.</dd><dd><code>collector</code> - MessageCollector the storage engine uses to persist changes.</dd><dd><code>registry</code> - MetricsRegistry to which to publish storage-engine specific metrics.</dd><dd><code>changeLogSystemStreamPartition</code> - Samza stream partition from which to receive the changelog.</dd><dd><code>containerContext</code> - Information about the container in which the task is executing.</dd> <dt><span class="strong">Returns:</span></dt><dd>The storage engine instance.</dd></dl> </li> </ul> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-frame.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-frame.html Thu Jul 24 05:05:00 2014 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.storage (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-summary.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-summary.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.storage (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.storage (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-tree.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-tree.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.storage Class Hierarchy (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.storage Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>IncomingMessageEnvelope (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>IncomingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="IncomingMessageEnvelope (samza-api 0.7.0 API)"; + parent.document.title="IncomingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>OutgoingMessageEnvelope (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OutgoingMessageEnvelope (samza-api 0.7.0 API)"; + parent.document.title="OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -97,8 +97,9 @@ <br> <pre>public class <span class="strong">OutgoingMessageEnvelope</span> extends java.lang.Object</pre> -<div class="block">This class represents a message envelope that is sent by a StreamTask. It can be thought of as a complement to the - IncomingMessageEnvelope class.</div> +<div class="block">An OutgoingMessageEnvelope is sent to a specified <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> via the appropriate <a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><code>SystemProducer</code></a> + from the user's <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>. StreamTasks consume from their input streams via their + process method and write to their output streams by sending OutgoingMessageEnvelopes via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a></div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemAdmin (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemAdmin (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemAdmin (samza-api 0.7.0 API)"; + parent.document.title="SystemAdmin (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -92,7 +92,7 @@ <hr> <br> <pre>public interface <span class="strong">SystemAdmin</span></pre> -<div class="block">An interface that's use to interact with the underlying system to fetch +<div class="block">Helper interface attached to an underlying system to fetch information about streams, partitions, offsets, etc. This interface is useful for providing utility methods that Samza needs in order to interact with a system.</div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemConsumer (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemConsumer (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemConsumer (samza-api 0.7.0 API)"; + parent.document.title="SystemConsumer (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -325,7 +325,7 @@ <div class="block">Poll the SystemConsumer to get any available messages from the underlying system. - If the underlying implementation does not take care to adhere to the + <p>If the underlying implementation does not take care to adhere to the timeout parameter, the SamzaContainer's performance will suffer drastically. Specifically, if poll blocks when it's not supposed to, it will block the entire main thread in SamzaContainer, and no messages will Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemFactory (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemFactory (samza-api 0.7.0 API)"; + parent.document.title="SystemFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -88,6 +88,8 @@ <hr> <br> <pre>public interface <span class="strong">SystemFactory</span></pre> +<div class="block">Build the <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> and <a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><code>SystemProducer</code></a> for + a particular system, as well as the accompanying <a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><code>SystemAdmin</code></a>.</div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemProducer (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemProducer (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemProducer (samza-api 0.7.0 API)"; + parent.document.title="SystemProducer (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -88,7 +88,9 @@ <hr> <br> <pre>public interface <span class="strong">SystemProducer</span></pre> -<div class="block">Used as a standard interface for all producers of messages from a specified Samza source.</div> +<div class="block">SystemProducers are how Samza writes messages from <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s to outside systems, + such as messaging systems like Kafka, or file systems. Implementations are responsible for accepting messages + and writing them to their backing systems.</div> </li> </ul> </div> @@ -109,7 +111,10 @@ </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush</a></strong>(java.lang.String source)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush</a></strong>(java.lang.String source)</code> +<div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those + messages and leave no messages remaining to be sent.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> @@ -126,11 +131,15 @@ </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#start()">start</a></strong>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#start()">start</a></strong>()</code> +<div class="block">Start the SystemProducer.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#stop()">stop</a></strong>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#stop()">stop</a></strong>()</code> +<div class="block">Stop the SystemProducer.</div> +</td> </tr> </table> </li> @@ -154,6 +163,7 @@ <li class="blockList"> <h4>start</h4> <pre>void start()</pre> +<div class="block">Start the SystemProducer. After this method finishes it should be ready to accept messages received from the send method.</div> </li> </ul> <a name="stop()"> @@ -163,6 +173,8 @@ <li class="blockList"> <h4>stop</h4> <pre>void stop()</pre> +<div class="block">Stop the SystemProducer. After this method finished, the system should have completed all necessary work, sent + any remaining messages and will not receive any new calls to the send method.</div> </li> </ul> <a name="register(java.lang.String)"> @@ -195,6 +207,9 @@ <li class="blockList"> <h4>flush</h4> <pre>void flush(java.lang.String source)</pre> +<div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those + messages and leave no messages remaining to be sent.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd></dl> </li> </ul> </li> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemStream (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemStream (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStream (samza-api 0.7.0 API)"; + parent.document.title="SystemStream (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -101,7 +101,11 @@ <br> <pre>public class <span class="strong">SystemStream</span> extends java.lang.Object</pre> -<div class="block">Used to represent a Samza stream.</div> +<div class="block">Streams in Samza consist of both the stream name and the system to which the stream belongs. + Systems are defined through the job config and have corresponding serdes, producers and + consumers in order to deserialize, send to and retrieve from them. A stream name is dependent + on its system, and may be the topic, queue name, file name, etc. as makes sense for a + particular system.</div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemStreamMetadata.OffsetType (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamMetadata.OffsetType (samza-api 0.7.0 API)"; + parent.document.title="SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.7.0 API)"; + parent.document.title="SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemStreamMetadata (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemStreamMetadata (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamMetadata (samza-api 0.7.0 API)"; + parent.document.title="SystemStreamMetadata (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemStreamPartition (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemStreamPartition (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamPartition (samza-api 0.7.0 API)"; + parent.document.title="SystemStreamPartition (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -98,11 +98,16 @@ <div class="description"> <ul class="blockList"> <li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>></dd> +</dl> <hr> <br> <pre>public class <span class="strong">SystemStreamPartition</span> -extends <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></pre> -<div class="block">Aggregate object representing a partition of a Samza stream.</div> +extends <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> +implements java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>></pre> +<div class="block">Aggregate object representing a both the <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> and <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza"><code>Partition</code></a>.</div> </li> </ul> </div> @@ -184,22 +189,26 @@ extends <a href="../../../../org/apache/ <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#compareTo(org.apache.samza.system.SystemStreamPartition)">compareTo</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> that)</code> </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#getPartition()">getPartition</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#getSystemStream()">getSystemStream</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#toString()">toString</a></strong>()</code> </td> </tr> @@ -349,7 +358,7 @@ extends <a href="../../../../org/apache/ <a name="toString()"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> @@ -359,6 +368,19 @@ extends <a href="../../../../org/apache/ </dl> </li> </ul> +<a name="compareTo(org.apache.samza.system.SystemStreamPartition)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> that)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>></code></dd> +</dl> +</li> +</ul> </li> </ul> </li> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>SystemStreamPartitionIterator (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>SystemStreamPartitionIterator (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamPartitionIterator (samza-api 0.7.0 API)"; + parent.document.title="SystemStreamPartitionIterator (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -102,6 +102,8 @@ <pre>public class <span class="strong">SystemStreamPartitionIterator</span> extends java.lang.Object implements java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></pre> +<div class="block"><code>Iterator</code> that wraps a <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> to iterate over + the messages the consumer provides for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 --> -<title>BaseMessageChooser (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>BaseMessageChooser (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BaseMessageChooser (samza-api 0.7.0 API)"; + parent.document.title="BaseMessageChooser (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>MessageChooser (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>MessageChooser (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MessageChooser (samza-api 0.7.0 API)"; + parent.document.title="MessageChooser (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -94,46 +94,46 @@ <pre>public interface <span class="strong">MessageChooser</span></pre> <div class="block">MessageChooser is an interface for programmatic fine-grain control over stream consumption. - - Consider the case of a Samza task is consuming multiple streams where some + + <p>Consider the case of a Samza task consuming multiple streams, where some streams may be from live systems that have stricter SLA requirements and must always be prioritized over other streams that may be from batch systems. MessageChooser allows developers to inject message prioritization logic into the SamzaContainer. - - In general, the MessageChooser can be used to prioritize certain systems, + + <p>In general, the MessageChooser can be used to prioritize certain systems, streams or partitions over others. It can also be used to throttle certain - partitions if it chooses not to return messages even though they are - available when choose is invoked. The MessageChooser can also throttle the - entire SamzaContainer by performing a blocking operation, such as - Thread.sleep. - - The manner in which MessageChooser is used is: - + partitions, by choosing not to return messages even though they are + available. The MessageChooser can also throttle the entire SamzaContainer by + performing a blocking operation, such as Thread.sleep. + + <p>The manner in which MessageChooser is used is: + <ul> - <li>SystemConsumers buffers messages from all SystemStreamPartitions as they + <li>SystemConsumers buffer messages from all SystemStreamPartitions as they become available.</li> <li>If MessageChooser has no messages for a given SystemStreamPartition, and - SystemConsumers has a message in its buffer for the SystemStreamPartition, + a SystemConsumer has a message in its buffer for the SystemStreamPartition, the MessageChooser will be updated once with the next message in the buffer.</li> <li>When SamzaContainer is ready to process another message, it calls - SystemConsumers.choose, which in-turn calls MessageChooser.choose.</li> + SystemConsumers.choose, which in turn calls <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a>.</li> </ul> - - Since the MessageChooser only receives one message at a time per - SystemStreamPartition, it can be used to order messages between different + + <p>Since the MessageChooser only receives one message at a time per + <a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>, it can be used to order messages between different SystemStreamPartitions, but it can't be used to re-order messages within a single SystemStreamPartition (a buffered sort). This must be done within a StreamTask. - - The contract between the MessageChooser and the SystemConsumers is: - + + <p>The contract between the MessageChooser and the SystemConsumers is: + <ul> - <li>Update can be called multiple times before choose is called.</li> - <li>A null return from MessageChooser.choose means no envelopes should be + <li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)"><code>update(IncomingMessageEnvelope)</code></a> can be called multiple times + before <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a> is called.</li> + <li>If <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a> returns null, that means no envelopes should be processed at the moment.</li> - <li>A MessageChooser may elect to return null when choose is called, even if - unprocessed messages have been given by the update method.</li> + <li>A MessageChooser may elect to return null when <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a> is + called, even if unprocessed messages have been given by the update method.</li> <li>A MessageChooser will not have any of its in-memory state restored in the event of a failure.</li> <li>Blocking operations (such as Thread.sleep) will block all processing in @@ -190,9 +190,7 @@ <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)">update</a></strong>(<a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code> -<div class="block">Notify the chooser that a new envelope is available for a processing.A - MessageChooser will receive, at most, one outstanding envelope per - system/stream/partition combination.</div> +<div class="block">Notify the chooser that a new envelope is available for a processing.</div> </td> </tr> </table> @@ -257,7 +255,7 @@ <li class="blockList"> <h4>update</h4> <pre>void update(<a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</pre> -<div class="block">Notify the chooser that a new envelope is available for a processing.A +<div class="block">Notify the chooser that a new envelope is available for a processing. A MessageChooser will receive, at most, one outstanding envelope per system/stream/partition combination. For example, if update is called for partition 7 of kafka.mystream, then update will not be called with an Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>MessageChooserFactory (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>MessageChooserFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MessageChooserFactory (samza-api 0.7.0 API)"; + parent.document.title="MessageChooserFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -88,6 +88,7 @@ <hr> <br> <pre>public interface <span class="strong">MessageChooserFactory</span></pre> +<div class="block">Build an instance of a <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html Thu Jul 24 05:05:00 2014 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.system.chooser (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.system.chooser (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.system.chooser (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.system.chooser (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.system.chooser (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.system.chooser (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -83,7 +83,9 @@ </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser">MessageChooserFactory</a></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">Build an instance of a <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div> +</td> </tr> </tbody> </table> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html Thu Jul 24 05:05:00 2014 @@ -2,15 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.system.chooser Class Hierarchy (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.system.chooser Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.system.chooser Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.system.chooser Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html Thu Jul 24 05:05:00 2014 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 --> -<title>org.apache.samza.system (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.system (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body>
