You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ya...@apache.org on 2014/07/24 07:05:03 UTC
svn commit: r1612998 [1/6] - in /incubator/samza/site: ./
learn/documentation/0.7.0/ learn/documentation/0.7.0/api/
learn/documentation/0.7.0/api/javadocs/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/
learn/documentation/0.7.0/api/javadocs/...
Author: yanfang
Date: Thu Jul 24 05:05:00 2014
New Revision: 1612998
URL: http://svn.apache.org/r1612998
Log:
add spark streaming comparison
Added:
incubator/samza/site/learn/documentation/0.7.0/comparisons/spark-streaming.html
Modified:
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-noframe.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/constant-values.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/deprecated-list.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/help-doc.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index-all.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/Partition.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/SamzaException.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/Checkpoint.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManager.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/CheckpointManagerFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/Config.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigException.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/ConfigRewriter.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/MapConfig.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/config/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/SamzaContainerContext.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/container/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/ApplicationStatus.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/CommandBuilder.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJob.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/StreamJobFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/job/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Counter.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Gauge.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/Metric.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporter.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/MetricsVisitor.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistry.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/ReadableMetricsRegistryListener.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/metrics/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Deserializer.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serde.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/SerdeFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/Serializer.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/serializers/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngine.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/StorageEngineFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/storage/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html
incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html
incubator/samza/site/learn/documentation/0.7.0/api/overview.html
incubator/samza/site/learn/documentation/0.7.0/comparisons/storm.html
incubator/samza/site/learn/documentation/0.7.0/container/checkpointing.html
incubator/samza/site/learn/documentation/0.7.0/container/event-loop.html
incubator/samza/site/learn/documentation/0.7.0/container/jmx.html
incubator/samza/site/learn/documentation/0.7.0/container/metrics.html
incubator/samza/site/learn/documentation/0.7.0/container/samza-container.html
incubator/samza/site/learn/documentation/0.7.0/container/serialization.html
incubator/samza/site/learn/documentation/0.7.0/container/state-management.html
incubator/samza/site/learn/documentation/0.7.0/container/streams.html
incubator/samza/site/learn/documentation/0.7.0/container/windowing.html
incubator/samza/site/learn/documentation/0.7.0/index.html
incubator/samza/site/learn/documentation/0.7.0/introduction/architecture.html
incubator/samza/site/learn/documentation/0.7.0/jobs/configuration-table.html
incubator/samza/site/learn/documentation/0.7.0/jobs/configuration.html
incubator/samza/site/learn/documentation/0.7.0/jobs/job-runner.html
incubator/samza/site/learn/documentation/0.7.0/jobs/logging.html
incubator/samza/site/learn/documentation/0.7.0/jobs/reprocessing.html
incubator/samza/site/learn/documentation/0.7.0/jobs/yarn-jobs.html
incubator/samza/site/learn/documentation/0.7.0/operations/kafka.html
incubator/samza/site/learn/tutorials/0.7.0/deploy-samza-job-from-hdfs.html
incubator/samza/site/learn/tutorials/0.7.0/remote-debugging-samza.html
incubator/samza/site/learn/tutorials/0.7.0/run-hello-samza-without-internet.html
incubator/samza/site/learn/tutorials/0.7.0/run-in-multi-node-yarn.html
incubator/samza/site/sitemap.xml
incubator/samza/site/startup/download/index.html
incubator/samza/site/startup/hello-samza/0.7.0/index.html
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-frame.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-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>All Classes (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-07-09">
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:30 PDT 2014 -->
+<title>All Classes (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,7 +25,6 @@
<li><a href="org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config" target="classFrame"><i>ConfigFactory</i></a></li>
<li><a href="org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config" target="classFrame"><i>ConfigRewriter</i></a></li>
<li><a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics" target="classFrame">Counter</a></li>
-<li><a href="org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics" target="classFrame">DataType</a></li>
<li><a href="org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Deserializer</i></a></li>
<li><a href="org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics" target="classFrame">Gauge</a></li>
<li><a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system" target="classFrame">IncomingMessageEnvelope</a></li>
@@ -38,7 +37,6 @@
<li><a href="org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsRegistry</i></a></li>
<li><a href="org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsReporter</i></a></li>
<li><a href="org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsReporterFactory</i></a></li>
-<li><a href="org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics" target="classFrame">MetricsType</a></li>
<li><a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics" target="classFrame">MetricsVisitor</a></li>
<li><a href="org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util" target="classFrame">NoOpMetricsRegistry</a></li>
<li><a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system" target="classFrame">OutgoingMessageEnvelope</a></li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-noframe.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-noframe.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-noframe.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/allclasses-noframe.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>All Classes (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-07-09">
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:30 PDT 2014 -->
+<title>All Classes (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,7 +25,6 @@
<li><a href="org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><i>ConfigFactory</i></a></li>
<li><a href="org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><i>ConfigRewriter</i></a></li>
<li><a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></li>
-<li><a href="org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics">DataType</a></li>
<li><a href="org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><i>Deserializer</i></a></li>
<li><a href="org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></li>
<li><a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></li>
@@ -38,7 +37,6 @@
<li><a href="org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><i>MetricsRegistry</i></a></li>
<li><a href="org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><i>MetricsReporter</i></a></li>
<li><a href="org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><i>MetricsReporterFactory</i></a></li>
-<li><a href="org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics">MetricsType</a></li>
<li><a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></li>
<li><a href="org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></li>
<li><a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/constant-values.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/constant-values.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/constant-values.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/constant-values.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>Constant Field Values (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>Constant Field Values (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="Constant Field Values (samza-api 0.7.0 API)";
+ parent.document.title="Constant Field Values (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/deprecated-list.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/deprecated-list.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/deprecated-list.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/deprecated-list.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>Deprecated List (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-07-09">
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:30 PDT 2014 -->
+<title>Deprecated List (samza-api 0.8.0-SNAPSHOT API)</title>
+<meta name="date" content="2014-07-23">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Deprecated List (samza-api 0.7.0 API)";
+ parent.document.title="Deprecated List (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/help-doc.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/help-doc.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/help-doc.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/help-doc.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>API Help (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-07-09">
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:30 PDT 2014 -->
+<title>API Help (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="API Help (samza-api 0.7.0 API)";
+ parent.document.title="API Help (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index-all.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index-all.html?rev=1612998&r1=1612997&r2=1612998&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index-all.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/index-all.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>Index (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-07-09">
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:30 PDT 2014 -->
+<title>Index (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="Index (samza-api 0.7.0 API)";
+ parent.document.title="Index (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -79,7 +79,9 @@
<div class="block">Called after a message is processed by a task.</div>
</dd>
<dt><a href="./org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">ApplicationStatus</span></a> - Enum in <a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
</dl>
<a name="_B_">
<!-- -->
@@ -148,7 +150,7 @@
<dl>
<dt><a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><span class="strong">Checkpoint</span></a> - Class in <a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt>
<dd>
-<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>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/checkpoint/Checkpoint.html#Checkpoint(java.util.Map)">Checkpoint(Map<SystemStream, String>)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt>
<dd>
@@ -156,10 +158,13 @@
</dd>
<dt><a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><span class="strong">CheckpointManager</span></a> - Interface in <a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt>
<dd>
-<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>
</dd>
<dt><a href="./org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint"><span class="strong">CheckpointManagerFactory</span></a> - Interface in <a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/chooser/MessageChooser.html#choose()">choose()</a></span> - Method in interface org.apache.samza.system.chooser.<a href="./org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></dt>
<dd>
<div class="block">The choose method is invoked when the SamzaContainer is ready to process a
@@ -170,13 +175,22 @@
<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#clear()">clear()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt>
<dd> </dd>
<dt><a href="./org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Clock</span></a> - Interface in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Mockable interface for tracking time.</div>
+</dd>
<dt><a href="./org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="strong">ClosableTask</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A ClosableTask augments <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, allowing the method implementer to specify
+ code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics,
+ clean or close resources, etc.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/task/ClosableTask.html#close()">close()</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task">ClosableTask</a></dt>
<dd> </dd>
<dt><a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job"><span class="strong">CommandBuilder</span></a> - Class in <a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#CommandBuilder()">CommandBuilder()</a></span> - Constructor for class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)">commit(TaskCoordinator.RequestScope)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></dt>
@@ -186,8 +200,14 @@
</dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet(T, T)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt>
<dd> </dd>
-<dt><a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><span class="strong">Config</span></a> - Class in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt>
+<dt><span class="strong"><a href="./org/apache/samza/Partition.html#compareTo(org.apache.samza.Partition)">compareTo(Partition)</a></span> - Method in class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt>
<dd> </dd>
+<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#compareTo(org.apache.samza.system.SystemStreamPartition)">compareTo(SystemStreamPartition)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><span class="strong">Config</span></a> - Class in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt>
+<dd>
+<div class="block">Store and retrieve named, typed values as configuration for classes implementing this interface.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#Config()">Config()</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/container/SamzaContainerContext.html#config">config</a></span> - Variable in class org.apache.samza.container.<a href="./org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a></dt>
@@ -195,7 +215,9 @@
<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#config">config</a></span> - Variable in class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt>
<dd> </dd>
<dt><a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">ConfigException</span></a> - Exception in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/config/ConfigException.html#ConfigException(java.lang.Throwable)">ConfigException(Throwable)</a></span> - Constructor for exception org.apache.samza.config.<a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String)">ConfigException(String)</a></span> - Constructor for exception org.apache.samza.config.<a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></dt>
@@ -203,10 +225,13 @@
<dt><span class="strong"><a href="./org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String,%20java.lang.Throwable)">ConfigException(String, Throwable)</a></span> - Constructor for exception org.apache.samza.config.<a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></dt>
<dd> </dd>
<dt><a href="./org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">ConfigFactory</span></a> - Interface in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><a href="./org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">ConfigRewriter</span></a> - Interface in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt>
<dd>
-<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>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#containsKey(java.lang.Object)">containsKey(Object)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt>
<dd> </dd>
@@ -214,7 +239,7 @@
<dd> </dd>
<dt><a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Counter</span></a> - Class in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
<dd>
-<div class="block">A counter is a metric that represents a cumulative value.</div>
+<div class="block">A counter is a <a href="./org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that represents a cumulative value.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#Counter(java.lang.String)">Counter(String)</a></span> - Constructor for class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt>
<dd> </dd>
@@ -228,8 +253,6 @@
</a>
<h2 class="title">D</h2>
<dl>
-<dt><a href="./org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">DataType</span></a> - Enum in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#dec()">dec()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#dec(long)">dec(long)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt>
@@ -276,7 +299,10 @@
<div class="block">Flush any cached messages</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush(String)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those
+ messages and leave no messages remaining to be sent.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/serializers/Deserializer.html#fromBytes(byte[])">fromBytes(byte[])</a></span> - Method in interface org.apache.samza.serializers.<a href="./org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a></dt>
<dd>
<div class="block">Deserializes given serialized object from an array of bytes to its original form.</div>
@@ -288,7 +314,10 @@
<h2 class="title">G</h2>
<dl>
<dt><a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Gauge</span></a><<a href="./org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a>> - Class in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A Gauge is a <a href="./org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that wraps some instance of T in a thread-safe
+ reference and allows it to be set or retrieved.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#Gauge(java.lang.String,%20T)">Gauge(String, T)</a></span> - Constructor for class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsVisitor.html#gauge(org.apache.samza.metrics.Gauge)">gauge(Gauge<T>)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt>
@@ -310,7 +339,9 @@
<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getClass(java.lang.String)">getClass(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/config/ConfigFactory.html#getConfig(java.net.URI)">getConfig(URI)</a></span> - Method in interface org.apache.samza.config.<a href="./org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config">ConfigFactory</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Build a specific Config.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemFactory.html#getConsumer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getConsumer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#getCount()">getCount()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt>
@@ -411,7 +442,9 @@
<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getShort(java.lang.String)">getShort(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#getStatus()">getStatus()</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/storage/StorageEngineFactory.html#getStorageEngine(java.lang.String,%20java.io.File,%20org.apache.samza.serializers.Serde,%20org.apache.samza.serializers.Serde,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.container.SamzaContainerContext)">getStorageEngine(String, File, Serde<K>, Serde<V>, MessageCollector, MetricsRegistry, SystemStreamPartition, SamzaContainerContext)</a></span> - Method in interface org.apache.samza.storage.<a href="./org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage">StorageEngineFactory</a></dt>
<dd>
<div class="block">Create an instance of the given storage engine.</div>
@@ -521,7 +554,9 @@
<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#keySet()">keySet()</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#kill()">kill()</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Kill this job immediately.</div>
+</dd>
</dl>
<a name="_L_">
<!-- -->
@@ -537,7 +572,9 @@
<h2 class="title">M</h2>
<dl>
<dt><a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config"><span class="strong">MapConfig</span></a> - Class in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#MapConfig()">MapConfig()</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#MapConfig(java.util.Map)">MapConfig(Map<String, String>)</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt>
@@ -550,7 +587,9 @@
stream consumption.</div>
</dd>
<dt><a href="./org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="strong">MessageChooserFactory</span></a> - Interface in <a href="./org/apache/samza/system/chooser/package-summary.html">org.apache.samza.system.chooser</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Build an instance of a <a href="./org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div>
+</dd>
<dt><a href="./org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">MessageCollector</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
<dd>
<div class="block">Used as an interface for the means of sending message envelopes to an output stream.</div>
@@ -560,16 +599,23 @@
<div class="block">Metric class that allows metric visitors to visit it to get its information.</div>
</dd>
<dt><a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsRegistry</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A MetricsRegistry allows its users to create new <a href="./org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a>s and
+ have those metrics wired to specific metrics systems, such as JMX, provided by <a href="./org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s.</div>
+</dd>
<dt><a href="./org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporter</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><a href="./org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporterFactory</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
-<dt><a href="./org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">MetricsType</span></a> - Enum in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="strong">MetricsVisitor</span></a> - Class in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
<dd>
-<div class="block">A metric visitor visits a metric, before metrics are flushed to a metrics stream.</div>
+<div class="block">A MetricsVisitor can be used to process each metric in a <a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>ReadableMetricsRegistry</code></a>,
+ encapsulating the logic of what to be done with each metric in the counter and gauge methods.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsVisitor.html#MetricsVisitor()">MetricsVisitor()</a></span> - Constructor for class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt>
<dd> </dd>
@@ -586,17 +632,25 @@
<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue()">newBlockingQueue()</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter(String, String)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter(String, Counter)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter(String, String)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter(String, Counter)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge(String, String, T)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge(String, Gauge<T>)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge(String, String, T)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge(String, Gauge<T>)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt>
@@ -604,7 +658,10 @@
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html#next()">next()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt>
<dd> </dd>
<dt><a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="strong">NoOpMetricsRegistry</span></a> - Class in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt>
-<dd> </dd>
+<dd>
+<div class="block"><a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
+ recorded but a registry is still required.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#NoOpMetricsRegistry()">NoOpMetricsRegistry()</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt>
<dd> </dd>
</dl>
@@ -643,7 +700,8 @@
<dd> </dd>
<dt><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">OutgoingMessageEnvelope</span></a> - Class in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
<dd>
-<div class="block">This class represents a message envelope that is sent by a StreamTask.</div>
+<div class="block">An OutgoingMessageEnvelope is sent to a specified <a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> via the appropriate <a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><code>SystemProducer</code></a>
+ from the user's <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.String,%20java.lang.String,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object)">OutgoingMessageEnvelope(SystemStream, String, String, Object, Object, Object)</a></span> - Constructor for class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt>
<dd>
@@ -669,7 +727,7 @@
<dl>
<dt><a href="./org/apache/samza/Partition.html" title="class in org.apache.samza"><span class="strong">Partition</span></a> - Class in <a href="./org/apache/samza/package-summary.html">org.apache.samza</a></dt>
<dd>
-<div class="block">Used to represent a Samza stream partition.</div>
+<div class="block">A numbered, ordered partition of a stream.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/Partition.html#Partition(int)">Partition(int)</a></span> - Constructor for class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt>
<dd>
@@ -705,7 +763,10 @@
<h2 class="title">R</h2>
<dl>
<dt><a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">ReadableMetricsRegistry</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
-<dd> </dd>
+<dd>
+<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>
+</dd>
<dt><a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics"><span class="strong">ReadableMetricsRegistryListener</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/checkpoint/CheckpointManager.html#readLastCheckpoint(org.apache.samza.Partition)">readLastCheckpoint(Partition)</a></span> - Method in interface org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint">CheckpointManager</a></dt>
@@ -740,7 +801,9 @@
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html#remove()">remove()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/storage/StorageEngine.html#restore(java.util.Iterator)">restore(Iterator<IncomingMessageEnvelope>)</a></span> - Method in interface org.apache.samza.storage.<a href="./org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Restore the content of this StorageEngine from the changelog.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/config/ConfigRewriter.html#rewrite(java.lang.String,%20org.apache.samza.config.Config)">rewrite(String, Config)</a></span> - Method in interface org.apache.samza.config.<a href="./org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config">ConfigRewriter</a></dt>
<dd> </dd>
</dl>
@@ -750,7 +813,9 @@
<h2 class="title">S</h2>
<dl>
<dt><a href="./org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container"><span class="strong">SamzaContainerContext</span></a> - Class in <a href="./org/apache/samza/container/package-summary.html">org.apache.samza.container</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A SamzaContainerContext maintains per-container information for the tasks it executes.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/container/SamzaContainerContext.html#SamzaContainerContext(java.lang.String,%20org.apache.samza.config.Config,%20java.util.Collection)">SamzaContainerContext(String, Config, Collection<Partition>)</a></span> - Constructor for class org.apache.samza.container.<a href="./org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a></dt>
<dd>
<div class="block">An immutable context object that can passed to tasks to give them information
@@ -777,9 +842,15 @@
<div class="block">Sends message envelope out onto specified stream.</div>
</dd>
<dt><a href="./org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Serde</span></a><<a href="./org/apache/samza/serializers/Serde.html" title="type parameter in Serde">T</a>> - Interface in <a href="./org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A Serde is a convenience type that implements both the <a href="./org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><code>Serializer</code></a> and
+ <a href="./org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><code>Deserializer</code></a> interfaces, allowing it to both read and write data
+ in its value type, T.</div>
+</dd>
<dt><a href="./org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><span class="strong">SerdeFactory</span></a><<a href="./org/apache/samza/serializers/SerdeFactory.html" title="type parameter in SerdeFactory">T</a>> - Interface in <a href="./org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Build an instance of <a href="./org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><code>Serde</code></a></div>
+</dd>
<dt><a href="./org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Serializer</span></a><<a href="./org/apache/samza/serializers/Serializer.html" title="type parameter in Serializer">T</a>> - Interface in <a href="./org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a></dt>
<dd>
<div class="block">A standard interface for Samza compatible serializers, used for serializing objects to bytes.</div>
@@ -827,7 +898,9 @@
to begin serving messages when poll is invoked.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemProducer.html#start()">start()</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Start the SystemProducer.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/checkpoint/CheckpointManager.html#stop()">stop()</a></span> - Method in interface org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint">CheckpointManager</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsReporter.html#stop()">stop()</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics">MetricsReporter</a></dt>
@@ -848,7 +921,9 @@
and shut down everything.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemProducer.html#stop()">stop()</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Stop the SystemProducer.</div>
+</dd>
<dt><a href="./org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><span class="strong">StorageEngine</span></a> - Interface in <a href="./org/apache/samza/storage/package-summary.html">org.apache.samza.storage</a></dt>
<dd>
<div class="block">A storage engine for managing state maintained by a stream processor.</div>
@@ -861,15 +936,21 @@
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStream.html#stream">stream</a></span> - Variable in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt>
<dd> </dd>
<dt><a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="strong">StreamJob</span></a> - Interface in <a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A StreamJob runs Samza <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s in its specific environment.</div>
+</dd>
<dt><a href="./org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job"><span class="strong">StreamJobFactory</span></a> - Interface in <a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Build a <a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a></div>
+</dd>
<dt><a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">StreamTask</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
<dd>
-<div class="block">Used as a standard interface for all user processing tasks.</div>
+<div class="block">A StreamTask is the basic class on which Samza jobs are implemented.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#submit()">submit()</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Submit this job to be run.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#subset(java.lang.String)">subset(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#subset(java.lang.String,%20boolean)">subset(String, boolean)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt>
@@ -878,7 +959,7 @@
<dd> </dd>
<dt><a href="./org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">SystemAdmin</span></a> - Interface in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
<dd>
-<div class="block">An interface that's use to interact with the underlying system to fetch
+<div class="block">Helper interface attached to an underlying system to fetch
information about streams, partitions, offsets, etc.</div>
</dd>
<dt><a href="./org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">SystemConsumer</span></a> - Interface in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
@@ -888,14 +969,18 @@
wishes to integrate with Samza.</div>
</dd>
<dt><a href="./org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">SystemFactory</span></a> - Interface in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Build the <a href="./org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> and <a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><code>SystemProducer</code></a> for
+ a particular system, as well as the accompanying <a href="./org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><code>SystemAdmin</code></a>.</div>
+</dd>
<dt><a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">SystemProducer</span></a> - Interface in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
<dd>
-<div class="block">Used as a standard interface for all producers of messages from a specified Samza source.</div>
+<div class="block">SystemProducers are how Samza writes messages from <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s to outside systems,
+ such as messaging systems like Kafka, or file systems.</div>
</dd>
<dt><a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">SystemStream</span></a> - Class in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
<dd>
-<div class="block">Used to represent a Samza stream.</div>
+<div class="block">Streams in Samza consist of both the stream name and the system to which the stream belongs.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStream.html#SystemStream(java.lang.String,%20java.lang.String)">SystemStream(String, String)</a></span> - Constructor for class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt>
<dd>
@@ -925,7 +1010,7 @@
<dd> </dd>
<dt><a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartition</span></a> - Class in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
<dd>
-<div class="block">Aggregate object representing a partition of a Samza stream.</div>
+<div class="block">Aggregate object representing a both the <a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> and <a href="./org/apache/samza/Partition.html" title="class in org.apache.samza"><code>Partition</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(java.lang.String,%20java.lang.String,%20org.apache.samza.Partition)">SystemStreamPartition(String, String, Partition)</a></span> - Constructor for class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt>
<dd>
@@ -940,7 +1025,10 @@
<div class="block">Constructs a Samza stream partition object based upon another Samza stream and a specified partition.</div>
</dd>
<dt><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartitionIterator</span></a> - Class in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt>
-<dd> </dd>
+<dd>
+<div class="block"><code>Iterator</code> that wraps a <a href="./org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> to iterate over
+ the messages the consumer provides for the specified <a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer,%20org.apache.samza.system.SystemStreamPartition)">SystemStreamPartitionIterator(SystemConsumer, SystemStreamPartition)</a></span> - Constructor for class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer,%20org.apache.samza.system.SystemStreamPartition,%20int)">SystemStreamPartitionIterator(SystemConsumer, SystemStreamPartition, int)</a></span> - Constructor for class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt>
@@ -954,9 +1042,17 @@
<h2 class="title">T</h2>
<dl>
<dt><a href="./org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">TaskContext</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">A TaskContext provides resources about the <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during
+ initialization in an <a href="./org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a> and during calls to <a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a>s.</div>
+</dd>
<dt><a href="./org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">TaskCoordinator</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">TaskCoordinators are provided to the process methods of <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations
+ to allow the user code to request actions from the Samza framework, including committing the current checkpoints
+ to configured <a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within
+ a container.</div>
+</dd>
<dt><a href="./org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">TaskCoordinator.RequestScope</span></a> - Enum in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
<dd>
<div class="block">A task can make requests to the Samza framework while processing messages, such as
@@ -969,7 +1065,9 @@
in a given container (JVM/process).</div>
</dd>
<dt><a href="./org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">TaskLifecycleListenerFactory</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Build a <a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a></div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/serializers/Serializer.html#toBytes(T)">toBytes(T)</a></span> - Method in interface org.apache.samza.serializers.<a href="./org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers">Serializer</a></dt>
<dd>
<div class="block">Serializes given object to an array of bytes.</div>
@@ -982,12 +1080,8 @@
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#toString()">toString()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt>
<dd> </dd>
-<dt><span class="strong"><a href="./org/apache/samza/metrics/DataType.html#toString()">toString()</a></span> - Method in enum org.apache.samza.metrics.<a href="./org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics">DataType</a></dt>
-<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#toString()">toString()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt>
<dd> </dd>
-<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsType.html#toString()">toString()</a></span> - Method in enum org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics">MetricsType</a></dt>
-<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/Partition.html#toString()">toString()</a></span> - Method in class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#toString()">toString()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt>
@@ -1012,9 +1106,7 @@
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)">update(IncomingMessageEnvelope)</a></span> - Method in interface org.apache.samza.system.chooser.<a href="./org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></dt>
<dd>
-<div class="block">Notify the chooser that a new envelope is available for a processing.A
- MessageChooser will receive, at most, one outstanding envelope per
- system/stream/partition combination.</div>
+<div class="block">Notify the chooser that a new envelope is available for a processing.</div>
</dd>
</dl>
<a name="_V_">
@@ -1026,14 +1118,6 @@
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
-<dt><span class="strong"><a href="./org/apache/samza/metrics/DataType.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.samza.metrics.<a href="./org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics">DataType</a></dt>
-<dd>
-<div class="block">Returns the enum constant of this type with the specified name.</div>
-</dd>
-<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsType.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics">MetricsType</a></dt>
-<dd>
-<div class="block">Returns the enum constant of this type with the specified name.</div>
-</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.OffsetType.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
@@ -1049,16 +1133,6 @@
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
-<dt><span class="strong"><a href="./org/apache/samza/metrics/DataType.html#values()">values()</a></span> - Static method in enum org.apache.samza.metrics.<a href="./org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics">DataType</a></dt>
-<dd>
-<div class="block">Returns an array containing the constants of this enum type, in
-the order they are declared.</div>
-</dd>
-<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsType.html#values()">values()</a></span> - Static method in enum org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics">MetricsType</a></dt>
-<dd>
-<div class="block">Returns an array containing the constants of this enum type, in
-the order they are declared.</div>
-</dd>
<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.OffsetType.html#values()">values()</a></span> - Static method in enum org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
@@ -1084,16 +1158,21 @@ the order they are declared.</div>
<h2 class="title">W</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#waitForFinish(long)">waitForFinish(long)</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Block on this job until either it finishes or reaches its timeout value</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#waitForStatus(org.apache.samza.job.ApplicationStatus,%20long)">waitForStatus(ApplicationStatus, long)</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Block on this job until either it transitions to the specified status or reaches it timeout value</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">window(MessageCollector, TaskCoordinator)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task">WindowableTask</a></dt>
<dd>
<div class="block">Called by TaskRunner for each implementing task at the end of every specified window.</div>
</dd>
<dt><a href="./org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="strong">WindowableTask</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt>
<dd>
-<div class="block">Used as a standard interface to allow user processing tasks to operate on specified time intervals, or "windows".</div>
+<div class="block">Add-on interface to <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
+ a specified time interval (via configuration).</div>
</dd>
<dt><span class="strong"><a href="./org/apache/samza/checkpoint/CheckpointManager.html#writeCheckpoint(org.apache.samza.Partition,%20org.apache.samza.checkpoint.Checkpoint)">writeCheckpoint(Partition, Checkpoint)</a></span> - Method in interface org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint">CheckpointManager</a></dt>
<dd>
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=1612998&r1=1612997&r2=1612998&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 Jul 24 05:05:00 2014
@@ -2,8 +2,8 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc on Wed Jul 09 09:32:50 PDT 2014 -->
-<title>samza-api 0.7.0 API</title>
+<!-- Generated by javadoc on Wed Jul 23 22:03:30 PDT 2014 -->
+<title>samza-api 0.8.0-SNAPSHOT API</title>
<script type="text/javascript">
targetPage = "" + window.location.search;
if (targetPage != "" && targetPage != "undefined")
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=1612998&r1=1612997&r2=1612998&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 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>Partition (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>Partition (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="Partition (samza-api 0.7.0 API)";
+ parent.document.title="Partition (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>
@@ -93,11 +93,16 @@
<div class="description">
<ul class="blockList">
<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.lang.Comparable<<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>></dd>
+</dl>
<hr>
<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>
+extends java.lang.Object
+implements java.lang.Comparable<<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>></pre>
+<div class="block">A numbered, ordered partition of a stream.</div>
</li>
</ul>
</div>
@@ -136,18 +141,22 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/samza/Partition.html#compareTo(org.apache.samza.Partition)">compareTo</a></strong>(<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> that)</code> </td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/samza/Partition.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/samza/Partition.html#getPartitionId()">getPartitionId</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/samza/Partition.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/samza/Partition.html#toString()">toString</a></strong>()</code> </td>
</tr>
@@ -230,7 +239,7 @@ extends java.lang.Object</pre>
<a name="toString()">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
@@ -240,6 +249,19 @@ extends java.lang.Object</pre>
</dl>
</li>
</ul>
+<a name="compareTo(org.apache.samza.Partition)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>compareTo</h4>
+<pre>public int compareTo(<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> that)</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>></code></dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>
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=1612998&r1=1612997&r2=1612998&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 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>SamzaException (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>SamzaException (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="SamzaException (samza-api 0.7.0 API)";
+ parent.document.title="SamzaException (samza-api 0.8.0-SNAPSHOT API)";
}
//-->
</script>