You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ya...@apache.org on 2014/07/24 07:05:03 UTC
svn commit: r1612998 [4/6] - in /incubator/samza/site: ./
learn/documentation/0.7.0/ learn/documentation/0.7.0/api/
learn/documentation/0.7.0/api/javadocs/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/
learn/documentation/0.7.0/api/javadocs/...
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/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/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/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 (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>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="org.apache.samza.system (samza-api 0.7.0 API)";
+ parent.document.title="org.apache.samza.system (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -77,7 +77,7 @@
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></td>
<td class="colLast">
-<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.</div>
</td>
</tr>
@@ -91,12 +91,16 @@
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<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>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></td>
<td class="colLast">
-<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.</div>
</td>
</tr>
</tbody>
@@ -120,13 +124,14 @@
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></td>
<td class="colLast">
-<div class="block">This class represents a message envelope that is sent by a StreamTask.</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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></td>
<td class="colLast">
-<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.</div>
</td>
</tr>
<tr class="rowColor">
@@ -145,12 +150,15 @@
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></td>
<td class="colLast">
-<div class="block">Aggregate object representing a partition of a Samza stream.</div>
+<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<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>
+</td>
</tr>
</tbody>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/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/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/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 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 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 Class Hierarchy (samza-api 0.7.0 API)";
+ parent.document.title="org.apache.samza.system Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -77,7 +77,7 @@
<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">OutgoingMessageEnvelope</span></a></li>
<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">SystemStream</span></a>
<ul>
-<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartition</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartition</span></a> (implements java.lang.Comparable<T>)</li>
</ul>
</li>
<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamMetadata</span></a></li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.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>ClosableTask (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>ClosableTask (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="ClosableTask (samza-api 0.7.0 API)";
+ parent.document.title="ClosableTask (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,6 +88,10 @@
<hr>
<br>
<pre>public interface <span class="strong">ClosableTask</span></pre>
+<div class="block">A ClosableTask augments <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, allowing the method implementer to specify
+ code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics,
+ clean or close resources, etc. The close method is not guaranteed to be called in event of crash or hard kill
+ of the process.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.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>InitableTask (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>InitableTask (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="InitableTask (samza-api 0.7.0 API)";
+ parent.document.title="InitableTask (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.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>MessageCollector (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>MessageCollector (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="MessageCollector (samza-api 0.7.0 API)";
+ parent.document.title="MessageCollector (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.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>StreamTask (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>StreamTask (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="StreamTask (samza-api 0.7.0 API)";
+ parent.document.title="StreamTask (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,8 +88,17 @@
<hr>
<br>
<pre>public interface <span class="strong">StreamTask</span></pre>
-<div class="block">Used as a standard interface for all user processing tasks. Receives messages from a partition of a specified input
- stream.</div>
+<div class="block">A StreamTask is the basic class on which Samza jobs are implemented. Developers writing Samza jobs begin by
+ implementing this class, which processes messages from the job's input streams and writes messages out to
+ streams via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>. A StreamTask may be augmented by
+ implementing other interfaces, such as <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a>, <a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><code>WindowableTask</code></a>,
+ or <a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><code>ClosableTask</code></a>.
+ <p>
+ The methods of StreamTasks and associated other tasks are guaranteed to be called in a single-threaded fashion;
+ no extra synchronization is necessary on the part of the class implementer. References to instances of
+ <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>s,<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>s, and
+ <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><code>TaskCoordinator</code></a> should not be held onto between calls; there is no guarantee that
+ these will not be invalidated or otherwise used by the framework.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.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>TaskContext (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>TaskContext (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="TaskContext (samza-api 0.7.0 API)";
+ parent.document.title="TaskContext (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,6 +88,8 @@
<hr>
<br>
<pre>public interface <span class="strong">TaskContext</span></pre>
+<div class="block">A TaskContext provides resources about the <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during
+ initialization in an <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a> and during calls to <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a>s.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.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>TaskCoordinator.RequestScope (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>TaskCoordinator.RequestScope (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="TaskCoordinator.RequestScope (samza-api 0.7.0 API)";
+ parent.document.title="TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.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>TaskCoordinator (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>TaskCoordinator (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="TaskCoordinator (samza-api 0.7.0 API)";
+ parent.document.title="TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,6 +88,13 @@
<hr>
<br>
<pre>public interface <span class="strong">TaskCoordinator</span></pre>
+<div class="block">TaskCoordinators are provided to the process methods of <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations
+ to allow the user code to request actions from the Samza framework, including committing the current checkpoints
+ to configured <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within
+ a container.
+ <p>
+ This interface may evolve over time.
+ </p></div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.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>TaskLifecycleListener (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>TaskLifecycleListener (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="TaskLifecycleListener (samza-api 0.7.0 API)";
+ parent.document.title="TaskLifecycleListener (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.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>TaskLifecycleListenerFactory (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>TaskLifecycleListenerFactory (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="TaskLifecycleListenerFactory (samza-api 0.7.0 API)";
+ parent.document.title="TaskLifecycleListenerFactory (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,6 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">TaskLifecycleListenerFactory</span></pre>
+<div class="block">Build a <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a></div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.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>WindowableTask (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>WindowableTask (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="WindowableTask (samza-api 0.7.0 API)";
+ parent.document.title="WindowableTask (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,7 +88,10 @@
<hr>
<br>
<pre>public interface <span class="strong">WindowableTask</span></pre>
-<div class="block">Used as a standard interface to allow user processing tasks to operate on specified time intervals, or "windows".</div>
+<div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
+ a specified time interval (via configuration). This can be used to implement direct time-based windowing or,
+ with a frequent window interval, windowing based on some other condition which is checked during the call to
+ window. The window method will be called even if no messages are received for a particular StreamTask.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/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.task (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.task (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/task/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/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.task (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.task (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.task (samza-api 0.7.0 API)";
+ parent.document.title="org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -76,7 +76,11 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task">ClosableTask</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">A ClosableTask augments <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, allowing the method implementer to specify
+ code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics,
+ clean or close resources, etc.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task">InitableTask</a></td>
@@ -94,16 +98,24 @@
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task">StreamTask</a></td>
<td class="colLast">
-<div class="block">Used as a standard interface for all user processing tasks.</div>
+<div class="block">A StreamTask is the basic class on which Samza jobs are implemented.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">A TaskContext provides resources about the <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during
+ initialization in an <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a> and during calls to <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a>s.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">TaskCoordinators are provided to the process methods of <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations
+ to allow the user code to request actions from the Samza framework, including committing the current checkpoints
+ to configured <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within
+ a container.</div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></td>
@@ -114,12 +126,15 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task">TaskLifecycleListenerFactory</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Build a <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a></div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task">WindowableTask</a></td>
<td class="colLast">
-<div class="block">Used as a standard interface to allow user processing tasks to operate on specified time intervals, or "windows".</div>
+<div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
+ a specified time interval (via configuration).</div>
</td>
</tr>
</tbody>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/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.task 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.task 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.task Class Hierarchy (samza-api 0.7.0 API)";
+ parent.document.title="org.apache.samza.task Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.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>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (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>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (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="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.7.0 API)";
+ parent.document.title="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.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>BlockingEnvelopeMap.BufferGauge (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>BlockingEnvelopeMap.BufferGauge (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="BlockingEnvelopeMap.BufferGauge (samza-api 0.7.0 API)";
+ parent.document.title="BlockingEnvelopeMap.BufferGauge (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.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>BlockingEnvelopeMap (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>BlockingEnvelopeMap (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="BlockingEnvelopeMap (samza-api 0.7.0 API)";
+ parent.document.title="BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -106,7 +106,9 @@ implements <a href="../../../../org/apac
BlockingEnvelopeMap is a helper class for SystemConsumer implementations.
Samza's poll() requirements make implementing SystemConsumers somewhat
tricky. BlockingEnvelopeMap is provided to help other developers write
- SystemConsumers.
+ SystemConsumers. The intended audience is not those writing Samza jobs,
+ but rather those extending Samza to consume from new types of stream providers
+ and other systems.
</p>
<p>
@@ -378,7 +380,7 @@ implements <a href="../../../../org/apac
<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/util/Clock.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.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>Clock (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>Clock (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="Clock (samza-api 0.7.0 API)";
+ parent.document.title="Clock (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -88,6 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">Clock</span></pre>
+<div class="block">Mockable interface for tracking time.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.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>NoOpMetricsRegistry (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>NoOpMetricsRegistry (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="NoOpMetricsRegistry (samza-api 0.7.0 API)";
+ parent.document.title="NoOpMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -102,6 +102,8 @@
<pre>public class <span class="strong">NoOpMetricsRegistry</span>
extends java.lang.Object
implements <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></pre>
+<div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
+ recorded but a registry is still required.</div>
</li>
</ul>
</div>
@@ -140,23 +142,31 @@ implements <a href="../../../../org/apac
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group,
- <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code> </td>
+ <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code>
+<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></strong>(java.lang.String group,
- java.lang.String name)</code> </td>
+ java.lang.String name)</code>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group,
- <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code> </td>
+ <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code>
+<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></strong>(java.lang.String group,
java.lang.String name,
- T value)</code> </td>
+ T value)</code>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
+</td>
</tr>
</table>
<ul class="blockList">
@@ -205,10 +215,13 @@ implements <a href="../../../../org/apac
<h4>newCounter</h4>
<pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group,
java.lang.String name)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">MetricsRegistry</a></code></strong></div>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>name</code> - Name of to-be-created Counter</dd>
+<dt><span class="strong">Returns:</span></dt><dd>New Counter instance</dd></dl>
</li>
</ul>
<a name="newCounter(java.lang.String, org.apache.samza.metrics.Counter)">
@@ -219,10 +232,13 @@ implements <a href="../../../../org/apac
<h4>newCounter</h4>
<pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">MetricsRegistry</a></code></strong></div>
+<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>counter</code> - Existing Counter to register</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Counter that was registered</dd></dl>
</li>
</ul>
<a name="newGauge(java.lang.String,java.lang.String,java.lang.Object)">
@@ -236,10 +252,13 @@ implements <a href="../../../../org/apac
<pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group,
java.lang.String name,
T value)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">MetricsRegistry</a></code></strong></div>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>name</code> - Name of to-be-created Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Gauge was created and registered</dd></dl>
</li>
</ul>
<a name="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">
@@ -250,10 +269,13 @@ implements <a href="../../../../org/apac
<h4>newGauge</h4>
<pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">MetricsRegistry</a></code></strong></div>
+<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>gauge</code> - Initial value for the Gauge</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Gauge was registered</dd></dl>
</li>
</ul>
</li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.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>SinglePartitionWithoutOffsetsSystemAdmin (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>SinglePartitionWithoutOffsetsSystemAdmin (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="SinglePartitionWithoutOffsetsSystemAdmin (samza-api 0.7.0 API)";
+ parent.document.title="SinglePartitionWithoutOffsetsSystemAdmin (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/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.util (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.util (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/util/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/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.util (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.util (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.util (samza-api 0.7.0 API)";
+ parent.document.title="org.apache.samza.util (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -76,7 +76,9 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Mockable interface for tracking time.</div>
+</td>
</tr>
</tbody>
</table>
@@ -98,7 +100,10 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
+ recorded but a registry is still required.</div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/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.util 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.util 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.util Class Hierarchy (samza-api 0.7.0 API)";
+ parent.document.title="org.apache.samza.util Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-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>Overview List (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>Overview List (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/overview-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-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>Overview (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:30 PDT 2014 -->
+<title>Overview (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="Overview (samza-api 0.7.0 API)";
+ parent.document.title="Overview (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -62,7 +62,7 @@
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
-<h1 class="title">samza-api 0.7.0 API</h1>
+<h1 class="title">samza-api 0.8.0-SNAPSHOT API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-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>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:30 PDT 2014 -->
+<title>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="Class Hierarchy (samza-api 0.7.0 API)";
+ parent.document.title="Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -104,12 +104,12 @@
<li type="circle">org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="strong">MetricsVisitor</span></a></li>
<li type="circle">org.apache.samza.util.<a href="org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="strong">NoOpMetricsRegistry</span></a> (implements org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a>)</li>
<li type="circle">org.apache.samza.system.<a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">OutgoingMessageEnvelope</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></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">org.apache.samza.container.<a href="org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container"><span class="strong">SamzaContainerContext</span></a></li>
<li type="circle">org.apache.samza.util.<a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util"><span class="strong">SinglePartitionWithoutOffsetsSystemAdmin</span></a> (implements org.apache.samza.system.<a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a>)</li>
<li type="circle">org.apache.samza.system.<a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">SystemStream</span></a>
<ul>
-<li type="circle">org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartition</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartition</span></a> (implements java.lang.Comparable<T>)</li>
</ul>
</li>
<li type="circle">org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamMetadata</span></a></li>
@@ -189,8 +189,6 @@
<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
<ul>
<li type="circle">org.apache.samza.job.<a href="org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">ApplicationStatus</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>
-<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.system.<a href="org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">SystemStreamMetadata.OffsetType</span></a></li>
<li type="circle">org.apache.samza.task.<a href="org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">TaskCoordinator.RequestScope</span></a></li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.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>Serialized Form (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:30 PDT 2014 -->
+<title>Serialized Form (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="Serialized Form (samza-api 0.7.0 API)";
+ parent.document.title="Serialized Form (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/overview.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/overview.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/overview.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/overview.html Thu Jul 24 05:05:00 2014
@@ -125,7 +125,7 @@
<p>When writing a stream processor for Samza, you must implement the <a href="javadocs/org/apache/samza/task/StreamTask.html">StreamTask</a> interface:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kn">package</span> <span class="n">com</span><span class="o">.</span><span class="na">example</span><span class="o">.</span><span class="na">samza</span><span class="o">;</span>
+<div class="highlight"><pre><code class="java"><span class="kn">package</span> <span class="n">com</span><span class="o">.</span><span class="na">example</span><span class="o">.</span><span class="na">samza</span><span class="o">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">MyTaskClass</span> <span class="kd">implements</span> <span class="n">StreamTask</span> <span class="o">{</span>
@@ -140,7 +140,7 @@
<p>In your job’s configuration you can tell Samza which streams you want to consume. An incomplete example could look like this (see the <a href="../jobs/configuration.html">configuration documentation</a> for more detail):</p>
-<div class="highlight"><pre><code class="language-jproperties" data-lang="jproperties"><span class="c"># This is the class above, which Samza will instantiate when the job is run</span>
+<div class="highlight"><pre><code class="jproperties"><span class="c"># This is the class above, which Samza will instantiate when the job is run</span>
<span class="na">task.class</span><span class="o">=</span><span class="s">com.example.samza.MyTaskClass</span>
<span class="c"># Define a system called "kafka" (you can give it any name, and you can define</span>
@@ -158,7 +158,7 @@
<p>For each message that Samza receives from the task’s input streams, the <em>process</em> method is called. The <a href="javadocs/org/apache/samza/system/IncomingMessageEnvelope.html">envelope</a> contains three things of importance: the message, the key, and the stream that the message came from.</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="cm">/** Every message that is delivered to a StreamTask is wrapped</span>
+<div class="highlight"><pre><code class="java"><span class="cm">/** Every message that is delivered to a StreamTask is wrapped</span>
<span class="cm"> * in an IncomingMessageEnvelope, which contains metadata about</span>
<span class="cm"> * the origin of the message. */</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">IncomingMessageEnvelope</span> <span class="o">{</span>
@@ -184,7 +184,7 @@
<p>The API looks like this:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="cm">/** A triple of system name, stream name and partition. */</span>
+<div class="highlight"><pre><code class="java"><span class="cm">/** A triple of system name, stream name and partition. */</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">SystemStreamPartition</span> <span class="kd">extends</span> <span class="n">SystemStream</span> <span class="o">{</span>
<span class="cm">/** The name of the system which provides this stream. It is</span>
@@ -202,7 +202,7 @@
<p>What about sending messages? If you take a look at the process() method in StreamTask, you’ll see that you get a <a href="javadocs/org/apache/samza/task/MessageCollector.html">MessageCollector</a>.</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="cm">/** When a task wishes to send a message, it uses this interface. */</span>
+<div class="highlight"><pre><code class="java"><span class="cm">/** When a task wishes to send a message, it uses this interface. */</span>
<span class="kd">public</span> <span class="kd">interface</span> <span class="nc">MessageCollector</span> <span class="o">{</span>
<span class="kt">void</span> <span class="nf">send</span><span class="o">(</span><span class="n">OutgoingMessageEnvelope</span> <span class="n">envelope</span><span class="o">);</span>
<span class="o">}</span></code></pre></div>
@@ -213,7 +213,7 @@
<p>For example, here’s a simple task that splits each input message into words, and emits each word as a separate message:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SplitStringIntoWords</span> <span class="kd">implements</span> <span class="n">StreamTask</span> <span class="o">{</span>
+<div class="highlight"><pre><code class="java"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SplitStringIntoWords</span> <span class="kd">implements</span> <span class="n">StreamTask</span> <span class="o">{</span>
<span class="c1">// Send outgoing messages to a stream called "words"</span>
<span class="c1">// in the "kafka" system.</span>
@@ -228,7 +228,7 @@
<span class="k">for</span> <span class="o">(</span><span class="n">String</span> <span class="n">word</span> <span class="o">:</span> <span class="n">message</span><span class="o">.</span><span class="na">split</span><span class="o">(</span><span class="s">" "</span><span class="o">))</span> <span class="o">{</span>
<span class="c1">// Use the word as the key, and 1 as the value.</span>
<span class="c1">// A second task can add the 1's to get the word count.</span>
- <span class="n">collector</span><span class="o">.</span><span class="na">send</span><span class="o">(</span><span class="k">new</span> <span class="nf">OutgoingMessageEnvelope</span><span class="o">(</span><span class="n">OUTPUT_STREAM</span><span class="o">,</span> <span class="n">word</span><span class="o">,</span> <span class="mi">1</span><span class="o">));</span>
+ <span class="n">collector</span><span class="o">.</span><span class="na">send</span><span class="o">(</span><span class="k">new</span> <span class="n">OutgoingMessageEnvelope</span><span class="o">(</span><span class="n">OUTPUT_STREAM</span><span class="o">,</span> <span class="n">word</span><span class="o">,</span> <span class="mi">1</span><span class="o">));</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span></code></pre></div>