You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ma...@apache.org on 2014/06/19 03:14:18 UTC
svn commit: r1603693 [6/8] - in /incubator/samza/site: ./
learn/documentation/0.7.0/api/javadocs/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/checkpoint/
learn/documentation/0.7.0/api...
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>BlockingEnvelopeMap (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -106,7 +106,9 @@ implements <a href="../../../../org/apac
BlockingEnvelopeMap is a helper class for SystemConsumer implementations.
Samza's poll() requirements make implementing SystemConsumers somewhat
tricky. BlockingEnvelopeMap is provided to help other developers write
- SystemConsumers.
+ SystemConsumers. The intended audience is not those writing Samza jobs,
+ but rather those extending Samza to consume from new types of stream providers
+ and other systems.
</p>
<p>
@@ -183,11 +185,11 @@ implements <a href="../../../../org/apac
<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock,%20java.lang.String)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock, java.lang.String)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock,
java.lang.String metricsGroupName)</code> </td>
</tr>
@@ -220,7 +222,7 @@ implements <a href="../../../../org/apac
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#poll(java.util.Map,%20long)">poll</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.Integer> systemStreamPartitionAndMaxPerStream,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#poll(java.util.Map, long)">poll</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.Integer> systemStreamPartitionAndMaxPerStream,
long timeout)</code>
<div class="block">Poll the SystemConsumer to get any available messages from the underlying
system.</div>
@@ -228,24 +230,24 @@ implements <a href="../../../../org/apac
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.system.IncomingMessageEnvelope)">put</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition, org.apache.samza.system.IncomingMessageEnvelope)">put</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition,%20java.util.List)">putAll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition, java.util.List)">putAll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
java.lang.String offset)</code>
<div class="block">Register a SystemStreamPartition to this SystemConsumer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.Boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#setIsAtHead(org.apache.samza.system.SystemStreamPartition,%20boolean)">setIsAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#setIsAtHead(org.apache.samza.system.SystemStreamPartition, boolean)">setIsAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
boolean isAtHead)</code> </td>
</tr>
</table>
@@ -341,14 +343,14 @@ implements <a href="../../../../org/apac
<h4>register</h4>
<pre>public void register(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
java.lang.String offset)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">SystemConsumer</a></code></strong></div>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">SystemConsumer</a></code></strong></div>
<div class="block">Register a SystemStreamPartition to this SystemConsumer. The SystemConsumer
should try and read messages from all SystemStreamPartitions that are
registered to it. SystemStreamPartitions should only be registered before
start is called.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
+<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - The SystemStreamPartition object representing the Samza
SystemStreamPartition to receive messages from.</dd><dd><code>offset</code> - String representing the offset of the point in the stream to start
reading messages from. This is an inclusive parameter; if "7" were
@@ -374,18 +376,18 @@ implements <a href="../../../../org/apac
<pre>public java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> poll(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.Integer> systemStreamPartitionAndMaxPerStream,
long timeout)
throws java.lang.InterruptedException</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map,%20long)">SystemConsumer</a></code></strong></div>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map, long)">SystemConsumer</a></code></strong></div>
<div class="block">Poll the SystemConsumer to get any available messages from the underlying
system.
- If the underlying implementation does not take care to adhere to the
+ <p>If the underlying implementation does not take care to adhere to the
timeout parameter, the SamzaContainer's performance will suffer
drastically. Specifically, if poll blocks when it's not supposed to, it
will block the entire main thread in SamzaContainer, and no messages will
be processed while blocking is occurring.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map,%20long)">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
+<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map, long)">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartitionAndMaxPerStream</code> - A map from SystemStreamPartition to maximum number of messages to
return for the SystemStreamPartition. Polling with {stream1: 100,
stream2: 1000} tells the SystemConsumer that it can return between
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Clock (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,6 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">Clock</span></pre>
+<div class="block">Mockable interface for tracking time.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>NoOpMetricsRegistry (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -102,6 +102,8 @@
<pre>public class <span class="strong">NoOpMetricsRegistry</span>
extends java.lang.Object
implements <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></pre>
+<div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
+ recorded but a registry is still required.</div>
</li>
</ul>
</div>
@@ -139,24 +141,32 @@ implements <a href="../../../../org/apac
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group,
- <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String, org.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>
+<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></strong>(java.lang.String group,
- java.lang.String name)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">newCounter</a></strong>(java.lang.String group,
+ java.lang.String name)</code>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group,
- <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group,
+ <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code>
+<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></strong>(java.lang.String group,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">newGauge</a></strong>(java.lang.String group,
java.lang.String name,
- T value)</code> </td>
+ T value)</code>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
+</td>
</tr>
</table>
<ul class="blockList">
@@ -205,10 +215,13 @@ implements <a href="../../../../org/apac
<h4>newCounter</h4>
<pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group,
java.lang.String name)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">MetricsRegistry</a></code></strong></div>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>name</code> - Name of to-be-created Counter</dd>
+<dt><span class="strong">Returns:</span></dt><dd>New Counter instance</dd></dl>
</li>
</ul>
<a name="newCounter(java.lang.String, org.apache.samza.metrics.Counter)">
@@ -219,10 +232,13 @@ implements <a href="../../../../org/apac
<h4>newCounter</h4>
<pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, org.apache.samza.metrics.Counter)">MetricsRegistry</a></code></strong></div>
+<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, org.apache.samza.metrics.Counter)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>counter</code> - Existing Counter to register</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Counter that was registered</dd></dl>
</li>
</ul>
<a name="newGauge(java.lang.String,java.lang.String,java.lang.Object)">
@@ -236,10 +252,13 @@ implements <a href="../../../../org/apac
<pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group,
java.lang.String name,
T value)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">MetricsRegistry</a></code></strong></div>
+<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>name</code> - Name of to-be-created Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Gauge was created and registered</dd></dl>
</li>
</ul>
<a name="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">
@@ -250,10 +269,13 @@ implements <a href="../../../../org/apac
<h4>newGauge</h4>
<pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">MetricsRegistry</a></code></strong></div>
+<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-</dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>gauge</code> - Initial value for the Gauge</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Gauge was registered</dd></dl>
</li>
</ul>
</li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>SinglePartitionWithoutOffsetsSystemAdmin (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.util (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.util (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -76,7 +76,9 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block">Mockable interface for tracking time.</div>
+</td>
</tr>
</tbody>
</table>
@@ -98,7 +100,10 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></td>
-<td class="colLast"> </td>
+<td class="colLast">
+<div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
+ recorded but a registry is still required.</div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>org.apache.samza.util Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
<title>Overview List (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:18 PDT 2014 -->
<title>Overview (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:18 PDT 2014 -->
<title>Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
@@ -189,8 +189,6 @@
<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
<ul>
<li type="circle">org.apache.samza.job.<a href="org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">ApplicationStatus</span></a></li>
-<li type="circle">org.apache.samza.metrics.<a href="org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">DataType</span></a></li>
-<li type="circle">org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">MetricsType</span></a></li>
<li type="circle">org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">SystemStreamMetadata.OffsetType</span></a></li>
<li type="circle">org.apache.samza.task.<a href="org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">TaskCoordinator.RequestScope</span></a></li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html Thu Jun 19 01:14:15 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_60) on Tue Jun 17 22:49:30 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:18 PDT 2014 -->
<title>Serialized Form (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-17">
+<meta name="date" content="2014-06-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/container/state-management.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/container/state-management.html?rev=1603693&r1=1603692&r2=1603693&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/container/state-management.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/container/state-management.html Thu Jun 19 01:14:15 2014
@@ -284,34 +284,8 @@ stores.my-store.msg.serde=string
KeyValueIterator<K,V> all();
}
</code></pre></div>
-<p>Here is a list of additional configurations accepted by the key-value store, along with their default values:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text"># The number of writes to batch together
-stores.my-store.write.batch.size=500
-
-# The number of objects to keep in Samza's cache (in front of LevelDB).
-# This must be at least as large as write.batch.size.
-# A cache size of 0 disables all caching and batching.
-stores.my-store.object.cache.size=1000
-
-# The size of the off-heap leveldb block cache in bytes, per container.
-# If you have multiple tasks within one container, each task is given a
-# proportional share of this cache.
-stores.my-store.container.cache.size.bytes=104857600
-
-# The amount of memory leveldb uses for buffering writes before they are
-# written to disk, per container. If you have multiple tasks within one
-# container, each task is given a proportional share of this buffer.
-# This setting also determines the size of leveldb's segment files.
-stores.my-store.container.write.buffer.size.bytes=33554432
-
-# Enable block compression? (set compression=none to disable)
-stores.my-store.leveldb.compression=snappy
-
-# If compression is enabled, leveldb groups approximately this many
-# uncompressed bytes into one compressed block. You probably don't need
-# to change this unless you are a compulsive fiddler.
-stores.my-store.leveldb.block.size.bytes=4096
-</code></pre></div>
+<p>Additional configuration properties for the key-value store are documented in the <a href="../jobs/configuration-table.html#keyvalue">configuration reference</a>.</p>
+
<h3 id="implementing-common-use-cases-with-the-key-value-store">Implementing common use cases with the key-value store</h3>
<p>Earlier in this section we discussed some example use cases for stateful stream processing. Let’s look at how each of these could be implemented using a key-value storage engine such as Samza’s LevelDB.</p>