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=1612998&r1=1612997&r2=1612998&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 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>Checkpoint (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>Checkpoint (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="Checkpoint (samza-api 0.7.0 API)"; + parent.document.title="Checkpoint (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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>CheckpointManager (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>CheckpointManager (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="CheckpointManager (samza-api 0.7.0 API)"; + parent.document.title="CheckpointManager (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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>CheckpointManagerFactory (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>CheckpointManagerFactory (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="CheckpointManagerFactory (samza-api 0.7.0 API)"; + parent.document.title="CheckpointManagerFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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.checkpoint (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.checkpoint (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/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=1612998&r1=1612997&r2=1612998&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 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.checkpoint (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.checkpoint (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.checkpoint (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.checkpoint (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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.checkpoint 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.checkpoint 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.checkpoint Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.checkpoint Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> 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=1612998&r1=1612997&r2=1612998&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 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>Config (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>Config (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="Config (samza-api 0.7.0 API)"; + parent.document.title="Config (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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>ConfigException (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>ConfigException (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="ConfigException (samza-api 0.7.0 API)"; + parent.document.title="ConfigException (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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>ConfigFactory (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>ConfigFactory (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="ConfigFactory (samza-api 0.7.0 API)"; + parent.document.title="ConfigFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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>ConfigRewriter (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>ConfigRewriter (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="ConfigRewriter (samza-api 0.7.0 API)"; + parent.document.title="ConfigRewriter (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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>MapConfig (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>MapConfig (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="MapConfig (samza-api 0.7.0 API)"; + parent.document.title="MapConfig (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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.config (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.config (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/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=1612998&r1=1612997&r2=1612998&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 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.config (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.config (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.config (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.config (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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.config 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.config 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.config Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.config Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> 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=1612998&r1=1612997&r2=1612998&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 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>SamzaContainerContext (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>SamzaContainerContext (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="SamzaContainerContext (samza-api 0.7.0 API)"; + parent.document.title="SamzaContainerContext (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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.container (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.container (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/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=1612998&r1=1612997&r2=1612998&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 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.container (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.container (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.container (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.container (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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.container 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.container 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.container Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.container Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> 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=1612998&r1=1612997&r2=1612998&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 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>ApplicationStatus (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>ApplicationStatus (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="ApplicationStatus (samza-api 0.7.0 API)"; + parent.document.title="ApplicationStatus (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> 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=1612998&r1=1612997&r2=1612998&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 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>CommandBuilder (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>CommandBuilder (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="CommandBuilder (samza-api 0.7.0 API)"; + parent.document.title="CommandBuilder (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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>StreamJob (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>StreamJob (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="StreamJob (samza-api 0.7.0 API)"; + parent.document.title="StreamJob (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> + 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=1612998&r1=1612997&r2=1612998&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 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>StreamJobFactory (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>StreamJobFactory (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="StreamJobFactory (samza-api 0.7.0 API)"; + parent.document.title="StreamJobFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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.job (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.job (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/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=1612998&r1=1612997&r2=1612998&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 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.job (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.job (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.job (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.job (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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.job 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.job 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.job Class Hierarchy (samza-api 0.7.0 API)"; + parent.document.title="org.apache.samza.job Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> 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=1612998&r1=1612997&r2=1612998&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 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>Counter (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>Counter (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="Counter (samza-api 0.7.0 API)"; + parent.document.title="Counter (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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=1612998&r1=1612997&r2=1612998&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 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>Gauge (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>Gauge (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="Gauge (samza-api 0.7.0 API)"; + parent.document.title="Gauge (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -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> @@ -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=1612998&r1=1612997&r2=1612998&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 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>Metric (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>Metric (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="Metric (samza-api 0.7.0 API)"; + parent.document.title="Metric (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsRegistry.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>MetricsRegistry (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>MetricsRegistry (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="MetricsRegistry (samza-api 0.7.0 API)"; + parent.document.title="MetricsRegistry (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -96,6 +96,13 @@ <hr> <br> <pre>public interface <span class="strong">MetricsRegistry</span></pre> +<div class="block">A MetricsRegistry allows its users to create new <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a>s and + have those metrics wired to specific metrics systems, such as JMX, provided by <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s. + Those implementing Samza jobs use the MetricsRegistry to register metrics, which then handle + the details of getting those metrics to each defined MetricsReporter. + + Users are free to define their metrics into groups as needed for their jobs. <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s + will likely use the group field to group the user-defined metrics together.</div> </li> </ul> </div> @@ -117,23 +124,31 @@ <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/metrics/MetricsRegistry.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/metrics/MetricsRegistry.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/metrics/MetricsRegistry.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> value)</code> </td> + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> value)</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/metrics/MetricsRegistry.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> </li> @@ -158,6 +173,9 @@ <h4>newCounter</h4> <pre><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">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><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)"> @@ -168,6 +186,9 @@ <h4>newCounter</h4> <pre><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">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><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)"> @@ -181,6 +202,9 @@ <pre><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">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><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)"> @@ -191,6 +215,9 @@ <h4>newGauge</h4> <pre><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> value)</pre> +<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><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>value</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/metrics/MetricsReporter.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporter.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporter.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporter.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>MetricsReporter (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>MetricsReporter (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="MetricsReporter (samza-api 0.7.0 API)"; + parent.document.title="MetricsReporter (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -88,6 +88,8 @@ <hr> <br> <pre>public interface <span class="strong">MetricsReporter</span></pre> +<div class="block">A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive + metrics from the Samza framework and Samza jobs.</div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.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>MetricsReporterFactory (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>MetricsReporterFactory (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="MetricsReporterFactory (samza-api 0.7.0 API)"; + parent.document.title="MetricsReporterFactory (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -36,7 +36,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsVisitor.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/MetricsReporterFactory.html" target="_top">Frames</a></li> @@ -88,6 +88,7 @@ <hr> <br> <pre>public interface <span class="strong">MetricsReporterFactory</span></pre> +<div class="block">Build a <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a></div> </li> </ul> </div> @@ -164,7 +165,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsVisitor.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/MetricsReporterFactory.html" target="_top">Frames</a></li> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsVisitor.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsVisitor.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsVisitor.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsVisitor.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>MetricsVisitor (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>MetricsVisitor (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="MetricsVisitor (samza-api 0.7.0 API)"; + parent.document.title="MetricsVisitor (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -35,7 +35,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -97,7 +97,9 @@ <br> <pre>public abstract class <span class="strong">MetricsVisitor</span> extends java.lang.Object</pre> -<div class="block">A metric visitor visits a metric, before metrics are flushed to a metrics stream.</div> +<div class="block">A MetricsVisitor can be used to process each metric in a <a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>ReadableMetricsRegistry</code></a>, + encapsulating the logic of what to be done with each metric in the counter and gauge methods. This makes it easy + to quickly process all of the metrics in a registry.</div> </li> </ul> </div> @@ -236,7 +238,7 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.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/ReadableMetricsRegistry.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistry.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistry.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistry.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>ReadableMetricsRegistry (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>ReadableMetricsRegistry (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="ReadableMetricsRegistry (samza-api 0.7.0 API)"; + parent.document.title="ReadableMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -93,6 +93,8 @@ <br> <pre>public interface <span class="strong">ReadableMetricsRegistry</span> extends <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></pre> +<div class="block">A ReadableMetricsRegistry is a <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> that also + allows read access to the metrics for which it is responsible.</div> </li> </ul> </div> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistryListener.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistryListener.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistryListener.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistryListener.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>ReadableMetricsRegistryListener (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>ReadableMetricsRegistryListener (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="ReadableMetricsRegistryListener (samza-api 0.7.0 API)"; + parent.document.title="ReadableMetricsRegistryListener (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-frame.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/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.metrics (samza-api 0.7.0 API)</title> -<meta name="date" content="2014-07-09"> +<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<title>org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-07-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> @@ -25,11 +25,6 @@ <li><a href="Gauge.html" title="class in org.apache.samza.metrics" target="classFrame">Gauge</a></li> <li><a href="MetricsVisitor.html" title="class in org.apache.samza.metrics" target="classFrame">MetricsVisitor</a></li> </ul> -<h2 title="Enums">Enums</h2> -<ul title="Enums"> -<li><a href="DataType.html" title="enum in org.apache.samza.metrics" target="classFrame">DataType</a></li> -<li><a href="MetricsType.html" title="enum in org.apache.samza.metrics" target="classFrame">MetricsType</a></li> -</ul> </div> </body> </html>
