Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/OutgoingMessageEnvelope.html" target="_top">Frames</a></li> -<li><a href="OutgoingMessageEnvelope.html" target="_top">No Frames</a></li> +<li><a href="OutgoingMessageEnvelope.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -62,17 +75,17 @@ <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -95,7 +108,7 @@ <li class="blockList"> <hr> <br> -<pre>public class <span class="strong">OutgoingMessageEnvelope</span> +<pre>public class <span class="typeNameLabel">OutgoingMessageEnvelope</span> extends java.lang.Object</pre> <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>. StreamTasks consume from their input streams via their @@ -108,30 +121,30 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> +<li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.Object-">OutgoingMessageEnvelope</a></span>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, java.lang.Object message)</code> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.Object,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.Object-java.lang.Object-">OutgoingMessageEnvelope</a></span>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, java.lang.Object key, java.lang.Object message)</code> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.Object-java.lang.Object-java.lang.Object-">OutgoingMessageEnvelope</a></span>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, java.lang.Object partitionKey, java.lang.Object key, java.lang.Object message)</code> @@ -139,7 +152,7 @@ extends java.lang.Object</pre> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><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</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.String-java.lang.String-java.lang.Object-java.lang.Object-java.lang.Object-">OutgoingMessageEnvelope</a></span>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, java.lang.String keySerializerName, java.lang.String messageSerializerName, java.lang.Object partitionKey, @@ -153,55 +166,55 @@ extends java.lang.Object</pre> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKey()">getKey</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKey--">getKey</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName()">getKeySerializerName</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName--">getKeySerializerName</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage()">getMessage</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage--">getMessage</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName()">getMessageSerializerName</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName--">getMessageSerializerName</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey()">getPartitionKey</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey--">getPartitionKey</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream()">getSystemStream</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream--">getSystemStream</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode()">hashCode</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode--">hashCode</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#toString()">toString</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#toString--">toString</a></span>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -217,74 +230,97 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> +<li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)"> +<a name="OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.String-java.lang.String-java.lang.Object-java.lang.Object-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>OutgoingMessageEnvelope</h4> <pre>public OutgoingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, - java.lang.String keySerializerName, - java.lang.String messageSerializerName, - java.lang.Object partitionKey, - java.lang.Object key, - java.lang.Object message)</pre> + java.lang.String keySerializerName, + java.lang.String messageSerializerName, + java.lang.Object partitionKey, + java.lang.Object key, + java.lang.Object message)</pre> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>keySerializerName</code> - String representing the serializer used for serializing this envelope's key.</dd><dd><code>messageSerializerName</code> - String representing the serializer used for serializing this envelope's message.</dd><dd><code>partitionKey</code> - A key representing which partition of the systemStream to send this envelope on.</dd><dd><code>key</code> - A deserialized key to be used for the message.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd> +<dd><code>keySerializerName</code> - String representing the serializer used for serializing this envelope's key.</dd> +<dd><code>messageSerializerName</code> - String representing the serializer used for serializing this envelope's message.</dd> +<dd><code>partitionKey</code> - A key representing which partition of the systemStream to send this envelope on.</dd> +<dd><code>key</code> - A deserialized key to be used for the message.</dd> +<dd><code>message</code> - A deserialized message to be sent in this envelope.</dd> +</dl> </li> </ul> -<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object, java.lang.Object)"> +<a name="OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.Object-java.lang.Object-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>OutgoingMessageEnvelope</h4> <pre>public OutgoingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, - java.lang.Object partitionKey, - java.lang.Object key, - java.lang.Object message)</pre> + java.lang.Object partitionKey, + java.lang.Object key, + java.lang.Object message)</pre> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>partitionKey</code> - A key representing which partition of the systemStream to send this envelope on.</dd><dd><code>key</code> - A deserialized key to be used for the message.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd> +<dd><code>partitionKey</code> - A key representing which partition of the systemStream to send this envelope on.</dd> +<dd><code>key</code> - A deserialized key to be used for the message.</dd> +<dd><code>message</code> - A deserialized message to be sent in this envelope.</dd> +</dl> </li> </ul> -<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object)"> +<a name="OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.Object-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>OutgoingMessageEnvelope</h4> <pre>public OutgoingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, - java.lang.Object key, - java.lang.Object message)</pre> + java.lang.Object key, + java.lang.Object message)</pre> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>key</code> - A deserialized key to be used for the message.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd> +<dd><code>key</code> - A deserialized key to be used for the message.</dd> +<dd><code>message</code> - A deserialized message to be sent in this envelope.</dd> +</dl> </li> </ul> -<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object)"> +<a name="OutgoingMessageEnvelope-org.apache.samza.system.SystemStream-java.lang.Object-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>OutgoingMessageEnvelope</h4> <pre>public OutgoingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, - java.lang.Object message)</pre> + java.lang.Object message)</pre> <div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd> +<dd><code>message</code> - A deserialized message to be sent in this envelope.</dd> +</dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getSystemStream()"> +<a name="getSystemStream--"> <!-- --> </a> <ul class="blockList"> @@ -293,7 +329,7 @@ extends java.lang.Object</pre> <pre>public <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> getSystemStream()</pre> </li> </ul> -<a name="getKeySerializerName()"> +<a name="getKeySerializerName--"> <!-- --> </a> <ul class="blockList"> @@ -302,7 +338,7 @@ extends java.lang.Object</pre> <pre>public java.lang.String getKeySerializerName()</pre> </li> </ul> -<a name="getMessageSerializerName()"> +<a name="getMessageSerializerName--"> <!-- --> </a> <ul class="blockList"> @@ -311,7 +347,7 @@ extends java.lang.Object</pre> <pre>public java.lang.String getMessageSerializerName()</pre> </li> </ul> -<a name="getPartitionKey()"> +<a name="getPartitionKey--"> <!-- --> </a> <ul class="blockList"> @@ -320,7 +356,7 @@ extends java.lang.Object</pre> <pre>public java.lang.Object getPartitionKey()</pre> </li> </ul> -<a name="getKey()"> +<a name="getKey--"> <!-- --> </a> <ul class="blockList"> @@ -329,7 +365,7 @@ extends java.lang.Object</pre> <pre>public java.lang.Object getKey()</pre> </li> </ul> -<a name="getMessage()"> +<a name="getMessage--"> <!-- --> </a> <ul class="blockList"> @@ -338,7 +374,7 @@ extends java.lang.Object</pre> <pre>public java.lang.Object getMessage()</pre> </li> </ul> -<a name="hashCode()"> +<a name="hashCode--"> <!-- --> </a> <ul class="blockList"> @@ -346,12 +382,12 @@ extends java.lang.Object</pre> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> -<a name="equals(java.lang.Object)"> +<a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> @@ -359,12 +395,12 @@ extends java.lang.Object</pre> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> -<a name="toString()"> +<a name="toString--"> <!-- --> </a> <ul class="blockListLast"> @@ -372,7 +408,7 @@ extends java.lang.Object</pre> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> @@ -385,9 +421,11 @@ extends java.lang.Object</pre> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -402,15 +440,15 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/OutgoingMessageEnvelope.html" target="_top">Frames</a></li> -<li><a href="OutgoingMessageEnvelope.html" target="_top">No Frames</a></li> +<li><a href="OutgoingMessageEnvelope.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -429,17 +467,17 @@ extends java.lang.Object</pre> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemAdmin (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemAdmin (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemAdmin (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/SystemAdmin.html" target="_top">Frames</a></li> -<li><a href="SystemAdmin.html" target="_top">No Frames</a></li> +<li><a href="SystemAdmin.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -91,7 +104,7 @@ </dl> <hr> <br> -<pre>public interface <span class="strong">SystemAdmin</span></pre> +<pre>public interface <span class="typeNameLabel">SystemAdmin</span></pre> <div class="block">Helper interface attached to an underlying system to fetch information about streams, partitions, offsets, etc. This interface is useful for providing utility methods that Samza needs in order to interact with a @@ -104,26 +117,26 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#getOffsetsAfter(java.util.Map)">getOffsetsAfter</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> offsets)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemAdmin.html#getOffsetsAfter-java.util.Map-">getOffsetsAfter</a></span>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> offsets)</code> <div class="block">Fetches the offsets for the messages immediately after the supplied offsets for a group of SystemStreamPartitions.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a>></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#getSystemStreamMetadata(java.util.Set)">getSystemStreamMetadata</a></strong>(java.util.Set<java.lang.String> streamNames)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemAdmin.html#getSystemStreamMetadata-java.util.Set-">getSystemStreamMetadata</a></span>(java.util.Set<java.lang.String> streamNames)</code> <div class="block">Fetch metadata from a system for a set of streams.</div> </td> </tr> @@ -138,11 +151,11 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getOffsetsAfter(java.util.Map)"> +<a name="getOffsetsAfter-java.util.Map-"> <!-- --> </a> <ul class="blockList"> @@ -151,12 +164,16 @@ <pre>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> getOffsetsAfter(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> offsets)</pre> <div class="block">Fetches the offsets for the messages immediately after the supplied offsets for a group of SystemStreamPartitions.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsets</code> - Map from SystemStreamPartition to current offsets.</dd> -<dt><span class="strong">Returns:</span></dt><dd>Map from SystemStreamPartition to offsets immediately after the - current offsets.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>offsets</code> - Map from SystemStreamPartition to current offsets.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Map from SystemStreamPartition to offsets immediately after the + current offsets.</dd> +</dl> </li> </ul> -<a name="getSystemStreamMetadata(java.util.Set)"> +<a name="getSystemStreamMetadata-java.util.Set-"> <!-- --> </a> <ul class="blockListLast"> @@ -164,9 +181,13 @@ <h4>getSystemStreamMetadata</h4> <pre>java.util.Map<java.lang.String,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a>> getSystemStreamMetadata(java.util.Set<java.lang.String> streamNames)</pre> <div class="block">Fetch metadata from a system for a set of streams.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamNames</code> - The streams to to fetch metadata for.</dd> -<dt><span class="strong">Returns:</span></dt><dd>A map from stream name to SystemStreamMetadata for each stream - requested in the parameter set.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamNames</code> - The streams to to fetch metadata for.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map from stream name to SystemStreamMetadata for each stream + requested in the parameter set.</dd> +</dl> </li> </ul> </li> @@ -177,9 +198,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -194,15 +217,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/SystemAdmin.html" target="_top">Frames</a></li> -<li><a href="SystemAdmin.html" target="_top">No Frames</a></li> +<li><a href="SystemAdmin.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -222,16 +245,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemConsumer (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemConsumer (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemConsumer (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/SystemConsumer.html" target="_top">Frames</a></li> -<li><a href="SystemConsumer.html" target="_top">No Frames</a></li> +<li><a href="SystemConsumer.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -61,18 +74,18 @@ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#field_summary">Field</a> | </li> +<li><a href="#field.summary">Field</a> | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field_detail">Field</a> | </li> +<li><a href="#field.detail">Field</a> | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -91,7 +104,7 @@ </dl> <hr> <br> -<pre>public interface <span class="strong">SystemConsumer</span></pre> +<pre>public interface <span class="typeNameLabel">SystemConsumer</span></pre> <div class="block"><p> SystemConsumer is the interface that must be implemented by any system that wishes to integrate with Samza. Examples of systems that one might want to @@ -115,10 +128,10 @@ <li>Start will be called before stop.</li> <li>Register will be called one or more times before start.</li> <li>Register won't be called twice for the same SystemStreamPartition.</li> - <li>If timeout < 0, poll will block unless all SystemStreamPartition are at + <li>If timeout < 0, poll will block unless all SystemStreamPartition are at "head" (the underlying system has been checked, and returned an empty set). If at head, an empty list is returned.</li> - <li>If timeout >= 0, poll will return any messages that are currently + <li>If timeout >= 0, poll will return any messages that are currently available for any of the SystemStreamPartitions specified. If no new messages are available, it will wait up to timeout milliseconds for messages from any SystemStreamPartition to become available. It will return an empty list if @@ -169,11 +182,11 @@ <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="field_summary"> +<li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -181,7 +194,7 @@ </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></strong></code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></span></code> <div class="block">A constant that can be used in the poll method's timeout parameter to denote that the poll invocation should block until at least one message is available for one of the SystemStreamPartitions supplied, or until all @@ -194,41 +207,41 @@ </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> -<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/system/SystemConsumer.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> systemStreamPartitions, +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,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><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll-java.util.Set-long-">poll</a></span>(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, long timeout)</code> <div class="block">Poll the SystemConsumer to get any available messages from the underlying system.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.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><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">register</a></span>(<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="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#start()">start</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#start--">start</a></span>()</code> <div class="block">Tells the SystemConsumer to connect to the underlying system, and prepare to begin serving messages when poll is invoked.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#stop()">stop</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#stop--">stop</a></span>()</code> <div class="block">Tells the SystemConsumer to close all connections, release all resource, and shut down everything.</div> </td> @@ -244,7 +257,7 @@ <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="field_detail"> +<li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> @@ -260,18 +273,21 @@ available for one of the SystemStreamPartitions supplied, or until all SystemStreamPartitions supplied are at head (have no new messages available since the last poll invocation was made for each SystemStreamPartition).</div> -<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.samza.system.SystemConsumer.BLOCK_ON_OUTSTANDING_MESSAGES">Constant Field Values</a></dd></dl> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.samza.system.SystemConsumer.BLOCK_ON_OUTSTANDING_MESSAGES">Constant Field Values</a></dd> +</dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="start()"> +<a name="start--"> <!-- --> </a> <ul class="blockList"> @@ -282,7 +298,7 @@ to begin serving messages when poll is invoked.</div> </li> </ul> -<a name="stop()"> +<a name="stop--"> <!-- --> </a> <ul class="blockList"> @@ -294,63 +310,77 @@ stop is called.</div> </li> </ul> -<a name="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)"> +<a name="register-org.apache.samza.system.SystemStreamPartition-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre>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> + java.lang.String offset)</pre> <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><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 +<dl> +<dt><span class="paramLabel">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 specified, the first message for the system/stream/partition to be - consumed and returned would be a message whose offset is "7".</dd></dl> + consumed and returned would be a message whose offset is "7".</dd> +</dl> </li> </ul> -<a name="poll(java.util.Map, long)"> +<a name="poll-java.util.Set-long-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>poll</h4> -<pre>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> systemStreamPartitions, - long timeout) - throws java.lang.InterruptedException</pre> +<pre>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>>> poll(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, + long timeout) + throws java.lang.InterruptedException</pre> <div class="block">Poll the SystemConsumer to get any available messages from the underlying system. - <p>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><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartitions</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 - 0 and 100 messages (inclusive) for stream1, and between 0 and 1000 - messages for stream2. If SystemConsumer has messages available for - other registered SystemStreamPartitions, but they are not in the - systemStreamPartitions map in a given poll invocation, they can't + be processed while blocking is occurring. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>systemStreamPartitions</code> - A set of SystemStreamPartition to poll for new messages. If + SystemConsumer has messages available for other registered + SystemStreamPartitions, but they are not in the + systemStreamPartitions set in a given poll invocation, they can't be returned. It is illegal to pass in SystemStreamPartitions that - have not been registered with the SystemConsumer first.</dd><dd><code>timeout</code> - If timeout < 0, poll will block unless all SystemStreamPartition + have not been registered with the SystemConsumer first.</dd> +<dd><code>timeout</code> - If timeout < 0, poll will block unless all SystemStreamPartition are at "head" (the underlying system has been checked, and - returned an empty set). If at head, an empty list is returned. If - timeout >= 0, poll will return any messages that are currently + returned an empty set). If at head, an empty map is returned. If + timeout >= 0, poll will return any messages that are currently available for any of the SystemStreamPartitions specified. If no new messages are available, it will wait up to timeout milliseconds for messages from any SystemStreamPartition to become - available. It will return an empty list if the timeout is hit, and + available. It will return an empty map if the timeout is hit, and no new messages are available.</dd> -<dt><span class="strong">Returns:</span></dt><dd>A list of zero or more IncomingMessageEnvelopes for the - SystemStreamPartitions that were supplied during the invocation.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code>java.lang.InterruptedException</code></dd></dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map from SystemStreamPartitions to any available + IncomingMessageEnvelopes for the SystemStreamPartitions. If no + messages are available for a SystemStreamPartition that was + supplied in the polling set, the map will not contain a key for the + SystemStreamPartition. Will return an empty map, not null, if no + new messages are available for any SystemStreamPartitions in the + input set.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - Thrown when a blocking poll has been interrupted by another + thread.</dd> +</dl> </li> </ul> </li> @@ -361,9 +391,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -378,15 +410,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/SystemConsumer.html" target="_top">Frames</a></li> -<li><a href="SystemConsumer.html" target="_top">No Frames</a></li> +<li><a href="SystemConsumer.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -404,18 +436,18 @@ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#field_summary">Field</a> | </li> +<li><a href="#field.summary">Field</a> | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field_detail">Field</a> | </li> +<li><a href="#field.detail">Field</a> | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemFactory (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemFactory (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemFactory (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/SystemFactory.html" target="_top">Frames</a></li> -<li><a href="SystemFactory.html" target="_top">No Frames</a></li> +<li><a href="SystemFactory.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -87,7 +100,7 @@ <li class="blockList"> <hr> <br> -<pre>public interface <span class="strong">SystemFactory</span></pre> +<pre>public interface <span class="typeNameLabel">SystemFactory</span></pre> <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> </li> @@ -98,30 +111,30 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getAdmin(java.lang.String,%20org.apache.samza.config.Config)">getAdmin</a></strong>(java.lang.String systemName, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemFactory.html#getAdmin-java.lang.String-org.apache.samza.config.Config-">getAdmin</a></span>(java.lang.String systemName, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getConsumer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getConsumer</a></strong>(java.lang.String systemName, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemFactory.html#getConsumer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getConsumer</a></span>(java.lang.String systemName, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getProducer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getProducer</a></strong>(java.lang.String systemName, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemFactory.html#getProducer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getProducer</a></span>(java.lang.String systemName, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</code> </td> </tr> @@ -136,40 +149,40 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getConsumer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)"> +<a name="getConsumer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getConsumer</h4> <pre><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> getConsumer(java.lang.String systemName, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</pre> + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, + <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</pre> </li> </ul> -<a name="getProducer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)"> +<a name="getProducer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getProducer</h4> <pre><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a> getProducer(java.lang.String systemName, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</pre> + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, + <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</pre> </li> </ul> -<a name="getAdmin(java.lang.String, org.apache.samza.config.Config)"> +<a name="getAdmin-java.lang.String-org.apache.samza.config.Config-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getAdmin</h4> <pre><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a> getAdmin(java.lang.String systemName, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> </li> </ul> </li> @@ -180,9 +193,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -197,15 +212,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/system/SystemFactory.html" target="_top">Frames</a></li> -<li><a href="SystemFactory.html" target="_top">No Frames</a></li> +<li><a href="SystemFactory.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -225,16 +240,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
