You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ma...@apache.org on 2014/06/19 03:14:18 UTC
svn commit: r1603693 [3/8] - in /incubator/samza/site: ./
learn/documentation/0.7.0/api/javadocs/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/
learn/documentation/0.7.0/api...
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index.html Thu Jun 19 01:14:15 2014
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc on Wed Jun 18 18:05:18 PDT 2014 -->
<title>samza-api 0.7.0 API</title>
<script type="text/javascript">
targetPage = "" + window.location.search;
@@ -11,12 +11,6 @@
if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage)))
targetPage = "undefined";
function validURL(url) {
- try {
- url = decodeURIComponent(url);
- }
- catch (error) {
- return false;
- }
var pos = url.indexOf(".html");
if (pos == -1 || pos != url.length - 5)
return false;
@@ -28,8 +22,7 @@
if ('a' <= ch && ch <= 'z' ||
'A' <= ch && ch <= 'Z' ||
ch == '$' ||
- ch == '_' ||
- ch.charCodeAt(0) > 127) {
+ ch == '_') {
allowNumber = true;
allowSep = true;
} else if ('0' <= ch && ch <= '9'
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/Partition.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/Partition.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/Partition.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/Partition.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Partition (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
@@ -97,7 +97,7 @@
<br>
<pre>public class <span class="strong">Partition</span>
extends java.lang.Object</pre>
-<div class="block">Used to represent a Samza stream partition.</div>
+<div class="block">A numbered, ordered partition of a stream.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/SamzaException.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/SamzaException.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/SamzaException.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/SamzaException.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>SamzaException (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
@@ -146,7 +146,7 @@ extends java.lang.RuntimeException</pre>
<td class="colOne"><code><strong><a href="../../../org/apache/samza/SamzaException.html#SamzaException(java.lang.String)">SamzaException</a></strong>(java.lang.String s)</code> </td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../org/apache/samza/SamzaException.html#SamzaException(java.lang.String,%20java.lang.Throwable)">SamzaException</a></strong>(java.lang.String s,
+<td class="colOne"><code><strong><a href="../../../org/apache/samza/SamzaException.html#SamzaException(java.lang.String, java.lang.Throwable)">SamzaException</a></strong>(java.lang.String s,
java.lang.Throwable t)</code> </td>
</tr>
<tr class="rowColor">
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/Checkpoint.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/Checkpoint.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/Checkpoint.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/Checkpoint.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:29 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Checkpoint (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -97,7 +97,9 @@
<br>
<pre>public class <span class="strong">Checkpoint</span>
extends java.lang.Object</pre>
-<div class="block">Used to represent a checkpoint in the running of a Samza system.</div>
+<div class="block">A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each.
+ It is used to restore a <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, either as part of a job restart or as part
+ of restarting a failed container within a running job.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManager.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManager.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManager.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManager.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:29 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>CheckpointManager (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,7 +88,8 @@
<hr>
<br>
<pre>public interface <span class="strong">CheckpointManager</span></pre>
-<div class="block">Used as a standard interface for writing out checkpoints for a specified partition.</div>
+<div class="block">CheckpointManagers read and write <a href="../../../../org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><code>Checkpoint</code></a> to some
+ implementation-specific location.</div>
</li>
</ul>
</div>
@@ -129,7 +130,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html#writeCheckpoint(org.apache.samza.Partition,%20org.apache.samza.checkpoint.Checkpoint)">writeCheckpoint</a></strong>(<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html#writeCheckpoint(org.apache.samza.Partition, org.apache.samza.checkpoint.Checkpoint)">writeCheckpoint</a></strong>(<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition,
<a href="../../../../org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a> checkpoint)</code>
<div class="block">Writes a checkpoint based on the current state of a Samza stream partition.</div>
</td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManagerFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManagerFactory.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManagerFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManagerFactory.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:29 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>CheckpointManagerFactory (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,6 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">CheckpointManagerFactory</span></pre>
+<div class="block">Build a <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>.</div>
</li>
</ul>
</div>
@@ -108,7 +109,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint">CheckpointManager</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/checkpoint/CheckpointManagerFactory.html#getCheckpointManager(org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getCheckpointManager</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/checkpoint/CheckpointManagerFactory.html#getCheckpointManager(org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)">getCheckpointManager</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</code> </td>
</tr>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-frame.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-frame.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.checkpoint (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/checkpoint/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-summary.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-summary.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.checkpoint (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -77,12 +77,15 @@
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint">CheckpointManager</a></td>
<td class="colLast">
-<div class="block">Used as a standard interface for writing out checkpoints for a specified partition.</div>
+<div class="block">CheckpointManagers read and write <a href="../../../../org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><code>Checkpoint</code></a> to some
+ implementation-specific location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint">CheckpointManagerFactory</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Build a <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>.</div>
+</td>
</tr>
</tbody>
</table>
@@ -98,7 +101,7 @@
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></td>
<td class="colLast">
-<div class="block">Used to represent a checkpoint in the running of a Samza system.</div>
+<div class="block">A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each.</div>
</td>
</tr>
</tbody>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-tree.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-tree.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.checkpoint Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/config/Config.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/Config.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/Config.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/Config.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Config (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -106,6 +106,7 @@
<pre>public abstract class <span class="strong">Config</span>
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.String></pre>
+<div class="block">Store and retrieve named, typed values as configuration for classes implementing this interface.</div>
</li>
</ul>
</div>
@@ -162,7 +163,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#get(java.lang.String,%20java.lang.String)">get</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#get(java.lang.String, java.lang.String)">get</a></strong>(java.lang.String k,
java.lang.String defaultString)</code> </td>
</tr>
<tr class="altColor">
@@ -171,7 +172,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String,%20boolean)">getBoolean</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String, boolean)">getBoolean</a></strong>(java.lang.String k,
boolean defaultValue)</code> </td>
</tr>
<tr class="altColor">
@@ -184,28 +185,28 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.util.Date)">getDate</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.util.Date)">getDate</a></strong>(java.lang.String k,
java.util.Date defaultValue)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat)">getDate</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.text.SimpleDateFormat)">getDate</a></strong>(java.lang.String k,
java.text.SimpleDateFormat format)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat,%20java.util.Date)">getDate</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.text.SimpleDateFormat, java.util.Date)">getDate</a></strong>(java.lang.String k,
java.text.SimpleDateFormat format,
java.util.Date defaultValue)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String)">getDate</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.lang.String)">getDate</a></strong>(java.lang.String k,
java.lang.String format)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String,%20java.util.Date)">getDate</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.lang.String, java.util.Date)">getDate</a></strong>(java.lang.String k,
java.lang.String format,
java.util.Date defaultValue)</code> </td>
</tr>
@@ -215,7 +216,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String,%20double)">getDouble</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String, double)">getDouble</a></strong>(java.lang.String k,
double defaultValue)</code> </td>
</tr>
<tr class="rowColor">
@@ -224,7 +225,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String,%20int)">getInt</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String, int)">getInt</a></strong>(java.lang.String k,
int defaultValue)</code> </td>
</tr>
<tr class="rowColor">
@@ -233,7 +234,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<java.lang.String></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String,%20java.util.List)">getList</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String, java.util.List)">getList</a></strong>(java.lang.String k,
java.util.List<java.lang.String> defaultValue)</code> </td>
</tr>
<tr class="rowColor">
@@ -242,7 +243,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String,%20long)">getLong</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String, long)">getLong</a></strong>(java.lang.String k,
long defaultValue)</code> </td>
</tr>
<tr class="rowColor">
@@ -255,12 +256,12 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String,%20short)">getShort</a></strong>(java.lang.String k,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String, short)">getShort</a></strong>(java.lang.String k,
short defaultValue)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#put(java.lang.String,%20java.lang.String)">put</a></strong>(java.lang.String key,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#put(java.lang.String, java.lang.String)">put</a></strong>(java.lang.String key,
java.lang.String value)</code> </td>
</tr>
<tr class="rowColor">
@@ -277,7 +278,7 @@ implements java.util.Map<java.lang.St
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String,%20boolean)">subset</a></strong>(java.lang.String prefix,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String, boolean)">subset</a></strong>(java.lang.String prefix,
boolean stripPrefix)</code> </td>
</tr>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigException.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigException.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigException.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigException.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>ConfigException (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -121,6 +121,7 @@
<br>
<pre>public class <span class="strong">ConfigException</span>
extends <a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza">SamzaException</a></pre>
+<div class="block">Specific <a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza"><code>SamzaException</code></a>s thrown from <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.samza.config.ConfigException">Serialized Form</a></dd></dl>
</li>
</ul>
@@ -143,7 +144,7 @@ extends <a href="../../../../org/apache/
<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String)">ConfigException</a></strong>(java.lang.String msg)</code> </td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String,%20java.lang.Throwable)">ConfigException</a></strong>(java.lang.String msg,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String, java.lang.Throwable)">ConfigException</a></strong>(java.lang.String msg,
java.lang.Throwable e)</code> </td>
</tr>
<tr class="altColor">
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigFactory.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigFactory.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>ConfigFactory (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,6 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">ConfigFactory</span></pre>
+<div class="block">Build a <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div>
</li>
</ul>
</div>
@@ -108,7 +109,9 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/ConfigFactory.html#getConfig(java.net.URI)">getConfig</a></strong>(java.net.URI configUri)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/ConfigFactory.html#getConfig(java.net.URI)">getConfig</a></strong>(java.net.URI configUri)</code>
+<div class="block">Build a specific Config.</div>
+</td>
</tr>
</table>
</li>
@@ -132,6 +135,9 @@
<li class="blockList">
<h4>getConfig</h4>
<pre><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> getConfig(java.net.URI configUri)</pre>
+<div class="block">Build a specific Config.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configUri</code> - Resource containing information necessary for this Config.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Newly constructed Config.</dd></dl>
</li>
</ul>
</li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigRewriter.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigRewriter.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigRewriter.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigRewriter.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>ConfigRewriter (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,7 +88,8 @@
<hr>
<br>
<pre>public interface <span class="strong">ConfigRewriter</span></pre>
-<div class="block">Re-write the job's config before the job is submitted.</div>
+<div class="block">A ConfigRewriter receives the job's config during job startup and may re-write it to provide new configs,
+ remove existing configs or audit and verify the config is correct or permitted.</div>
</li>
</ul>
</div>
@@ -109,7 +110,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/ConfigRewriter.html#rewrite(java.lang.String,%20org.apache.samza.config.Config)">rewrite</a></strong>(java.lang.String name,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/ConfigRewriter.html#rewrite(java.lang.String, org.apache.samza.config.Config)">rewrite</a></strong>(java.lang.String name,
<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td>
</tr>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/MapConfig.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/MapConfig.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/MapConfig.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/MapConfig.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>MapConfig (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -106,6 +106,7 @@
<br>
<pre>public class <span class="strong">MapConfig</span>
extends <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></pre>
+<div class="block">A <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> backed by a Java <code>Map</code></div>
</li>
</ul>
</div>
@@ -212,7 +213,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Methods inherited from class org.apache.samza.config.<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></h3>
-<code><a href="../../../../org/apache/samza/config/Config.html#clear()">clear</a>, <a href="../../../../org/apache/samza/config/Config.html#get(java.lang.String,%20java.lang.String)">get</a>, <a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String,%20boolean)">getBoolean</a>, <a href="../../../../org/apache/samza/config/Config.html#getClass(java.lang.String)">getClass</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.util.Date)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat,%20java.util.Date)">getDate</a>, <a hr
ef="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String,%20java.util.Date)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String)">getDouble</a>, <a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String,%20double)">getDouble</a>, <a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String)">getInt</a>, <a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String,%20int)">getInt</a>, <a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String)">getList</a>, <a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String,%20java.util.List)">getList</a>, <a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String)">getLong</a>, <a href="../../../../org/apache/
samza/config/Config.html#getLong(java.lang.String,%20long)">getLong</a>, <a href="../../../../org/apache/samza/config/Config.html#getNewInstance(java.lang.String)">getNewInstance</a>, <a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String)">getShort</a>, <a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String,%20short)">getShort</a>, <a href="../../../../org/apache/samza/config/Config.html#put(java.lang.String,%20java.lang.String)">put</a>, <a href="../../../../org/apache/samza/config/Config.html#putAll(java.util.Map)">putAll</a>, <a href="../../../../org/apache/samza/config/Config.html#remove(java.lang.Object)">remove</a>, <a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String)">subset</a>, <a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String,%20boolean)">subset</a></code></li>
+<code><a href="../../../../org/apache/samza/config/Config.html#clear()">clear</a>, <a href="../../../../org/apache/samza/config/Config.html#get(java.lang.String, java.lang.String)">get</a>, <a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String, boolean)">getBoolean</a>, <a href="../../../../org/apache/samza/config/Config.html#getClass(java.lang.String)">getClass</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.util.Date)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.text.SimpleDateFormat)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.text.SimpleDateFormat, java.util.Date)">getDate</a>, <a href="../../..
/../org/apache/samza/config/Config.html#getDate(java.lang.String, java.lang.String)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String, java.lang.String, java.util.Date)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String)">getDouble</a>, <a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String, double)">getDouble</a>, <a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String)">getInt</a>, <a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String, int)">getInt</a>, <a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String)">getList</a>, <a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String, java.util.List)">getList</a>, <a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String)">getLong</a>, <a href="../../../../org/apache/samza/config/Config.html
#getLong(java.lang.String, long)">getLong</a>, <a href="../../../../org/apache/samza/config/Config.html#getNewInstance(java.lang.String)">getNewInstance</a>, <a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String)">getShort</a>, <a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String, short)">getShort</a>, <a href="../../../../org/apache/samza/config/Config.html#put(java.lang.String, java.lang.String)">put</a>, <a href="../../../../org/apache/samza/config/Config.html#putAll(java.util.Map)">putAll</a>, <a href="../../../../org/apache/samza/config/Config.html#remove(java.lang.Object)">remove</a>, <a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String)">subset</a>, <a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String, boolean)">subset</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-frame.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-frame.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.config (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/config/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-summary.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-summary.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.config (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -76,12 +76,15 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config">ConfigFactory</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Build a <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config">ConfigRewriter</a></td>
<td class="colLast">
-<div class="block">Re-write the job's config before the job is submitted.</div>
+<div class="block">A ConfigRewriter receives the job's config during job startup and may re-write it to provide new configs,
+ remove existing configs or audit and verify the config is correct or permitted.</div>
</td>
</tr>
</tbody>
@@ -97,11 +100,15 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Store and retrieve named, typed values as configuration for classes implementing this interface.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">A <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> backed by a Java <code>Map</code></div>
+</td>
</tr>
</tbody>
</table>
@@ -116,7 +123,9 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Specific <a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza"><code>SamzaException</code></a>s thrown from <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div>
+</td>
</tr>
</tbody>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-tree.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-tree.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.config Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/container/SamzaContainerContext.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/SamzaContainerContext.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/SamzaContainerContext.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/SamzaContainerContext.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:29 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>SamzaContainerContext (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -97,6 +97,7 @@
<br>
<pre>public class <span class="strong">SamzaContainerContext</span>
extends java.lang.Object</pre>
+<div class="block">A SamzaContainerContext maintains per-container information for the tasks it executes.</div>
</li>
</ul>
</div>
@@ -142,7 +143,7 @@ extends java.lang.Object</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/container/SamzaContainerContext.html#SamzaContainerContext(java.lang.String,%20org.apache.samza.config.Config,%20java.util.Collection)">SamzaContainerContext</a></strong>(java.lang.String name,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/container/SamzaContainerContext.html#SamzaContainerContext(java.lang.String, org.apache.samza.config.Config, java.util.Collection)">SamzaContainerContext</a></strong>(java.lang.String name,
<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
java.util.Collection<<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>> partitions)</code>
<div class="block">An immutable context object that can passed to tasks to give them information
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-frame.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-frame.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.container (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/container/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-summary.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-summary.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.container (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -76,7 +76,9 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">A SamzaContainerContext maintains per-container information for the tasks it executes.</div>
+</td>
</tr>
</tbody>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-tree.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-tree.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.container Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/job/ApplicationStatus.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/ApplicationStatus.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/ApplicationStatus.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/ApplicationStatus.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>ApplicationStatus (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -106,6 +106,7 @@
<br>
<pre>public enum <span class="strong">ApplicationStatus</span>
extends java.lang.Enum<<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a>></pre>
+<div class="block">Status of a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a> during and after its run.</div>
</li>
</ul>
</div>
@@ -254,7 +255,8 @@ over the constants as follows:
for (ApplicationStatus c : ApplicationStatus.values())
System.out.println(c);
</pre></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
+the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
@@ -271,7 +273,8 @@ not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
+<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
+with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
</li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/CommandBuilder.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/CommandBuilder.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/CommandBuilder.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/CommandBuilder.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>CommandBuilder (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -97,6 +97,8 @@
<br>
<pre>public abstract class <span class="strong">CommandBuilder</span>
extends java.lang.Object</pre>
+<div class="block">CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework,
+ such as YARN or the LocalJobRunner.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJob.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJob.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJob.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJob.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>StreamJob (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,6 +88,10 @@
<hr>
<br>
<pre>public interface <span class="strong">StreamJob</span></pre>
+<div class="block">A StreamJob runs Samza <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s in its specific environment.
+ Users generally do not need to implement a StreamJob themselves, rather it is a framework-level
+ interface meant for those extending Samza itself. This class, and its accompanying factory,
+ allow Samza to run on other service providers besides YARN and LocalJob, such as Mesos or Sun Grid Engine.</div>
</li>
</ul>
</div>
@@ -108,24 +112,34 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#getStatus()">getStatus</a></strong>()</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#getStatus()">getStatus</a></strong>()</code>
+<div class="block">Get current <a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#kill()">kill</a></strong>()</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#kill()">kill</a></strong>()</code>
+<div class="block">Kill this job immediately.</div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#submit()">submit</a></strong>()</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#submit()">submit</a></strong>()</code>
+<div class="block">Submit this job to be run.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#waitForFinish(long)">waitForFinish</a></strong>(long timeoutMs)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#waitForFinish(long)">waitForFinish</a></strong>(long timeoutMs)</code>
+<div class="block">Block on this job until either it finishes or reaches its timeout value</div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#waitForStatus(org.apache.samza.job.ApplicationStatus,%20long)">waitForStatus</a></strong>(<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> status,
- long timeoutMs)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#waitForStatus(org.apache.samza.job.ApplicationStatus, long)">waitForStatus</a></strong>(<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> status,
+ long timeoutMs)</code>
+<div class="block">Block on this job until either it transitions to the specified status or reaches it timeout value</div>
+</td>
</tr>
</table>
</li>
@@ -149,6 +163,8 @@
<li class="blockList">
<h4>submit</h4>
<pre><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a> submit()</pre>
+<div class="block">Submit this job to be run.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>An instance of this job after it has been submitted.</dd></dl>
</li>
</ul>
<a name="kill()">
@@ -158,6 +174,8 @@
<li class="blockList">
<h4>kill</h4>
<pre><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a> kill()</pre>
+<div class="block">Kill this job immediately.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>An instance of this job after it has been killed.</dd></dl>
</li>
</ul>
<a name="waitForFinish(long)">
@@ -167,6 +185,9 @@
<li class="blockList">
<h4>waitForFinish</h4>
<pre><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> waitForFinish(long timeoutMs)</pre>
+<div class="block">Block on this job until either it finishes or reaches its timeout value</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMs</code> - How many milliseconds to wait before returning, assuming the job has not yet finished</dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job after finishing or timing out</dd></dl>
</li>
</ul>
<a name="waitForStatus(org.apache.samza.job.ApplicationStatus, long)">
@@ -177,6 +198,9 @@
<h4>waitForStatus</h4>
<pre><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> waitForStatus(<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> status,
long timeoutMs)</pre>
+<div class="block">Block on this job until either it transitions to the specified status or reaches it timeout value</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>status</code> - Target <a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> to wait upon</dd><dd><code>timeoutMs</code> - How many milliseconds to wait before returning, assuming the job has not transitioned to the specified value</dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job after finishing or reaching target state</dd></dl>
</li>
</ul>
<a name="getStatus()">
@@ -186,6 +210,8 @@
<li class="blockList">
<h4>getStatus</h4>
<pre><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> getStatus()</pre>
+<div class="block">Get current <a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Current job status</dd></dl>
</li>
</ul>
</li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJobFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJobFactory.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJobFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJobFactory.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>StreamJobFactory (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,6 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">StreamJobFactory</span></pre>
+<div class="block">Build a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a></div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-frame.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-frame.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.job (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/job/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-summary.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-summary.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.job (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -76,11 +76,15 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">A StreamJob runs Samza <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s in its specific environment.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job">StreamJobFactory</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Build a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a></div>
+</td>
</tr>
</tbody>
</table>
@@ -95,7 +99,10 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework,
+ such as YARN or the LocalJobRunner.</div>
+</td>
</tr>
</tbody>
</table>
@@ -110,7 +117,9 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Status of a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a> during and after its run.</div>
+</td>
</tr>
</tbody>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-tree.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-tree.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.job Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<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/metrics/Counter.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Counter.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Counter.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Counter.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Counter (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -36,7 +36,7 @@
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
-<li><a href="../../../../org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/samza/metrics/Counter.html" target="_top">Frames</a></li>
@@ -102,7 +102,8 @@
<pre>public class <span class="strong">Counter</span>
extends java.lang.Object
implements <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></pre>
-<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.
+ For example, the number of messages processed since the container was started.</div>
</li>
</ul>
</div>
@@ -341,7 +342,7 @@ implements <a href="../../../../org/apac
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
-<li><a href="../../../../org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/samza/metrics/Counter.html" target="_top">Frames</a></li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Gauge.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Gauge.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Gauge.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Gauge.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Gauge (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -35,7 +35,7 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
@@ -93,6 +93,7 @@
<div class="description">
<ul class="blockList">
<li class="blockList">
+<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Instance to be wrapped in the gauge for metering.</dd></dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></dd>
@@ -106,6 +107,9 @@
<pre>public class <span class="strong">Gauge<T></span>
extends java.lang.Object
implements <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></pre>
+<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. Gauages record specific values over time.
+ For example, the current length of a queue or the size of a buffer.</div>
</li>
</ul>
</div>
@@ -124,7 +128,7 @@ implements <a href="../../../../org/apac
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#Gauge(java.lang.String,%20T)">Gauge</a></strong>(java.lang.String name,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#Gauge(java.lang.String, T)">Gauge</a></strong>(java.lang.String name,
<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> value)</code> </td>
</tr>
</table>
@@ -144,7 +148,7 @@ implements <a href="../../../../org/apac
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet</a></strong>(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> expected,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T, T)">compareAndSet</a></strong>(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> expected,
<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</code> </td>
</tr>
<tr class="rowColor">
@@ -301,7 +305,7 @@ implements <a href="../../../../org/apac
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Metric.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Metric.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Metric.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Metric.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Metric (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>