Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html?rev=1721446&r1=1721445&r2=1721446&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html Tue Dec 22 19:03:17 2015 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_45) on Sun Jul 12 17:16:16 PDT 2015 --> -<title>OutgoingMessageEnvelope (samza-api 0.10.0-SNAPSHOT API)</title> -<meta name="date" content="2015-07-12"> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Dec 22 11:02:11 PST 2015 --> +<title>OutgoingMessageEnvelope (samza-api 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2015-12-22"> <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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OutgoingMessageEnvelope (samza-api 0.10.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OutgoingMessageEnvelope (samza-api 0.10.1-SNAPSHOT API)"; } //--> -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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -75,17 +62,17 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -108,7 +95,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <span class="typeNameLabel">OutgoingMessageEnvelope</span> +<pre>public class <span class="strong">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 @@ -121,30 +108,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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="overviewSummary" 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><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, +<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, 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><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, +<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, 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><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, +<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, java.lang.Object partitionKey, java.lang.Object key, java.lang.Object message)</code> @@ -152,7 +139,7 @@ extends java.lang.Object</pre> </td> </tr> <tr class="rowColor"> -<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, +<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, java.lang.String keySerializerName, java.lang.String messageSerializerName, java.lang.Object partitionKey, @@ -166,55 +153,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="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> +<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> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</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> +<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> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKey--">getKey</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKey()">getKey</a></strong>()</code> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName--">getKeySerializerName</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName()">getKeySerializerName</a></strong>()</code> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage--">getMessage</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage()">getMessage</a></strong>()</code> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName--">getMessageSerializerName</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName()">getMessageSerializerName</a></strong>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey--">getPartitionKey</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey()">getPartitionKey</a></strong>()</code> </td> </tr> -<tr id="i6" class="altColor"> +<tr 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><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream--">getSystemStream</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream()">getSystemStream</a></strong>()</code> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode--">hashCode</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> -<tr id="i8" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#toString--">toString</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#toString()">toString</a></strong>()</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> @@ -230,97 +217,74 @@ 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="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> +<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> </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="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> +<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> </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="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> +<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> </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="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> +<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> </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"> @@ -329,7 +293,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"> @@ -338,7 +302,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"> @@ -347,7 +311,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"> @@ -356,7 +320,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"> @@ -365,7 +329,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"> @@ -374,7 +338,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"> @@ -382,12 +346,12 @@ extends java.lang.Object</pre> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dt><strong>Overrides:</strong></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"> @@ -395,12 +359,12 @@ extends java.lang.Object</pre> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dt><strong>Overrides:</strong></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"> @@ -408,7 +372,7 @@ extends java.lang.Object</pre> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dt><strong>Overrides:</strong></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> @@ -421,11 +385,9 @@ 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> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -440,15 +402,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="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> +<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> </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"><!-- @@ -467,17 +429,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: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html?rev=1721446&r1=1721445&r2=1721446&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html Tue Dec 22 19:03:17 2015 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_45) on Sun Jul 12 17:16:16 PDT 2015 --> -<title>SystemAdmin (samza-api 0.10.0-SNAPSHOT API)</title> -<meta name="date" content="2015-07-12"> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Dec 22 11:02:11 PST 2015 --> +<title>SystemAdmin (samza-api 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2015-12-22"> <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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemAdmin (samza-api 0.10.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemAdmin (samza-api 0.10.1-SNAPSHOT API)"; } //--> -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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -104,7 +91,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public interface <span class="typeNameLabel">SystemAdmin</span></pre> +<pre>public interface <span class="strong">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 system.</div> @@ -116,42 +103,56 @@ var activeTableTab = "activeTableTab"; <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="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> +<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> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemAdmin.html#createChangelogStream-java.lang.String-int-">createChangelogStream</a></span>(java.lang.String streamName, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#createChangelogStream(java.lang.String,%20int)">createChangelogStream</a></strong>(java.lang.String streamName, int numOfPartitions)</code> <div class="block">An API to create a change log stream</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemAdmin.html#createCoordinatorStream-java.lang.String-">createCoordinatorStream</a></span>(java.lang.String streamName)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#createCoordinatorStream(java.lang.String)">createCoordinatorStream</a></strong>(java.lang.String streamName)</code> <div class="block">Create a stream for the job coordinator.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr 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><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> +<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> <div class="block">Fetches the offsets for the messages immediately after the supplied offsets for a group of SystemStreamPartitions.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr 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><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> +<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> <div class="block">Fetch metadata from a system for a set of streams.</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#offsetComparator(java.lang.String,%20java.lang.String)">offsetComparator</a></strong>(java.lang.String offset1, + java.lang.String offset2)</code> +<div class="block">Compare the two offsets.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#validateChangelogStream(java.lang.String,%20int)">validateChangelogStream</a></strong>(java.lang.String streamName, + int numOfPartitions)</code> +<div class="block">Validates change log stream</div> +</td> +</tr> </table> </li> </ul> @@ -163,11 +164,11 @@ var activeTableTab = "activeTableTab"; <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"> @@ -176,16 +177,12 @@ var activeTableTab = "activeTableTab"; <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="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> +<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> </li> </ul> -<a name="getSystemStreamMetadata-java.util.Set-"> +<a name="getSystemStreamMetadata(java.util.Set)"> <!-- --> </a> <ul class="blockList"> @@ -193,44 +190,60 @@ var activeTableTab = "activeTableTab"; <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="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> +<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> </li> </ul> -<a name="createChangelogStream-java.lang.String-int-"> +<a name="createChangelogStream(java.lang.String, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>createChangelogStream</h4> <pre>void createChangelogStream(java.lang.String streamName, - int numOfPartitions)</pre> + int numOfPartitions)</pre> <div class="block">An API to create a change log stream</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>streamName</code> - The name of the stream to be created in the underlying stream</dd> -<dd><code>numOfPartitions</code> - The number of partitions in the changelog stream</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamName</code> - The name of the stream to be created in the underlying stream</dd><dd><code>numOfPartitions</code> - The number of partitions in the changelog stream</dd></dl> </li> </ul> -<a name="createCoordinatorStream-java.lang.String-"> +<a name="validateChangelogStream(java.lang.String, int)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> +<li class="blockList"> +<h4>validateChangelogStream</h4> +<pre>void validateChangelogStream(java.lang.String streamName, + int numOfPartitions)</pre> +<div class="block">Validates change log stream</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamName</code> - The name of the stream to be created in the underlying stream</dd><dd><code>numOfPartitions</code> - The number of partitions in the changelog stream</dd></dl> +</li> +</ul> +<a name="createCoordinatorStream(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> <li class="blockList"> <h4>createCoordinatorStream</h4> <pre>void createCoordinatorStream(java.lang.String streamName)</pre> <div class="block">Create a stream for the job coordinator. If the stream already exists, this call should simply return.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>streamName</code> - The name of the coordinator stream to create.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamName</code> - The name of the coordinator stream to create.</dd></dl> +</li> +</ul> +<a name="offsetComparator(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>offsetComparator</h4> +<pre>java.lang.Integer offsetComparator(java.lang.String offset1, + java.lang.String offset2)</pre> +<div class="block">Compare the two offsets. -1, 0, +1 means offset1 < offset2, + offset1 == offset2 and offset1 > offset2 respectively. Return + null if those two offsets are not comparable</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset1</code> - First offset for comparison.</dd><dd><code>offset2</code> - Second offset for comparison.</dd> +<dt><span class="strong">Returns:</span></dt><dd>-1 if offset1 < offset2; 0 if offset1 == offset2; 1 if offset1 > offset2. Null if not comparable</dd></dl> </li> </ul> </li> @@ -241,11 +254,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -260,15 +271,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -288,16 +299,16 @@ var activeTableTab = "activeTableTab"; <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: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html?rev=1721446&r1=1721445&r2=1721446&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html Tue Dec 22 19:03:17 2015 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_45) on Sun Jul 12 17:16:16 PDT 2015 --> -<title>SystemConsumer (samza-api 0.10.0-SNAPSHOT API)</title> -<meta name="date" content="2015-07-12"> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Dec 22 11:02:11 PST 2015 --> +<title>SystemConsumer (samza-api 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2015-12-22"> <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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemConsumer (samza-api 0.10.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemConsumer (samza-api 0.10.1-SNAPSHOT API)"; } //--> -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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -74,18 +61,18 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -104,7 +91,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public interface <span class="typeNameLabel">SystemConsumer</span></pre> +<pre>public interface <span class="strong">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 @@ -182,11 +169,11 @@ var activeTableTab = "activeTableTab"; <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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<table class="overviewSummary" 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> @@ -194,7 +181,7 @@ var activeTableTab = "activeTableTab"; </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> -<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> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></strong></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 @@ -207,41 +194,41 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr 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, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Set,%20long)">poll</a></strong>(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 id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<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, +<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, java.lang.String offset)</code> <div class="block">Register a SystemStreamPartition to this SystemConsumer.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#start--">start</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#start()">start</a></strong>()</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 id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemConsumer.html#stop--">stop</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#stop()">stop</a></strong>()</code> <div class="block">Tells the SystemConsumer to close all connections, release all resource, and shut down everything.</div> </td> @@ -257,7 +244,7 @@ var activeTableTab = "activeTableTab"; <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> @@ -273,21 +260,18 @@ var activeTableTab = "activeTableTab"; 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="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> +<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> </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"> @@ -298,7 +282,7 @@ var activeTableTab = "activeTableTab"; to begin serving messages when poll is invoked.</div> </li> </ul> -<a name="stop--"> +<a name="stop()"> <!-- --> </a> <ul class="blockList"> @@ -310,38 +294,34 @@ var activeTableTab = "activeTableTab"; 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="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 +<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 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.Set-long-"> +<a name="poll(java.util.Set, long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>poll</h4> <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> + long timeout) + throws java.lang.InterruptedException</pre> <div class="block">Poll the SystemConsumer to get any available messages from the underlying system. @@ -352,15 +332,12 @@ var activeTableTab = "activeTableTab"; will block the entire main thread in SamzaContainer, and no messages will 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 +<dl><dt><span class="strong">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 map is returned. If timeout >= 0, poll will return any messages that are currently @@ -369,18 +346,16 @@ var activeTableTab = "activeTableTab"; milliseconds for messages from any SystemStreamPartition to become available. It will return an empty map if the timeout is hit, and no new messages are available.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A map from SystemStreamPartitions to any available +<dt><span class="strong">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> +<dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code> - Thrown when a blocking poll has been interrupted by another - thread.</dd> -</dl> + thread.</dd></dl> </li> </ul> </li> @@ -391,11 +366,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -410,15 +383,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -436,18 +409,18 @@ var activeTableTab = "activeTableTab"; <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: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html?rev=1721446&r1=1721445&r2=1721446&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html Tue Dec 22 19:03:17 2015 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_45) on Sun Jul 12 17:16:16 PDT 2015 --> -<title>SystemFactory (samza-api 0.10.0-SNAPSHOT API)</title> -<meta name="date" content="2015-07-12"> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Dec 22 11:02:11 PST 2015 --> +<title>SystemFactory (samza-api 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2015-12-22"> <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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemFactory (samza-api 0.10.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemFactory (samza-api 0.10.1-SNAPSHOT API)"; } //--> -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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -76,16 +63,16 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -100,7 +87,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">SystemFactory</span></pre> +<pre>public interface <span class="strong">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> @@ -111,30 +98,30 @@ var activeTableTab = "activeTableTab"; <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="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> +<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> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr 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><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, +<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, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> </tr> -<tr id="i1" class="rowColor"> +<tr 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><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, +<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, <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 id="i2" class="altColor"> +<tr 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><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, +<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, <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> @@ -149,40 +136,40 @@ var activeTableTab = "activeTableTab"; <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> @@ -193,11 +180,9 @@ var activeTableTab = "activeTableTab"; </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -212,15 +197,15 @@ var activeTableTab = "activeTableTab"; </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="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> +<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> </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"><!-- @@ -240,16 +225,16 @@ var activeTableTab = "activeTableTab"; <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 ======= -->
