Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html Wed Dec 10 00:54:42 2014 @@ -1,447 +1,497 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +OutgoingMessageEnvelope (samza-api 0.9.0-SNAPSHOT API) +</TITLE> + +<META NAME="date" CONTENT="2014-12-09"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="OutgoingMessageEnvelope (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</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> -</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> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/system/OutgoingMessageEnvelope.html" target="_top"><B>FRAMES</B></A> + <A HREF="OutgoingMessageEnvelope.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<div> -<ul class="subNavList"> -<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> -</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> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> + +<HR> <!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.system</div> -<h2 title="Class OutgoingMessageEnvelope" class="title">Class OutgoingMessageEnvelope</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.system.OutgoingMessageEnvelope</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<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 - process method and write to their output streams by sending OutgoingMessageEnvelopes via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a></div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> +<H2> +<FONT SIZE="-1"> +org.apache.samza.system</FONT> +<BR> +Class OutgoingMessageEnvelope</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.system.OutgoingMessageEnvelope</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>OutgoingMessageEnvelope</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +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 + process method and write to their output streams by sending OutgoingMessageEnvelopes via the provided <A HREF="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><CODE>MessageCollector</CODE></A> +<P> + +<P> +<HR> + +<P> + <!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<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"> -<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, - 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, - 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, - java.lang.Object partitionKey, - java.lang.Object key, - 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.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, - java.lang.Object key, - java.lang.Object message)</code> -<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> -</td> -</tr> -</table> -</li> -</ul> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object)">OutgoingMessageEnvelope</A></B>(<A HREF="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</A> systemStream, + java.lang.Object message)</CODE> + +<BR> + Constructs a new OutgoingMessageEnvelope from specified components.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object)">OutgoingMessageEnvelope</A></B>(<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> + +<BR> + Constructs a new OutgoingMessageEnvelope from specified components.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><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></B>(<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> + +<BR> + Constructs a new OutgoingMessageEnvelope from specified components.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><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></B>(<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)</CODE> + +<BR> + Constructs a new OutgoingMessageEnvelope from specified components.</TD> +</TR> +</TABLE> + <!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<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> -<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>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> -</tr> -<tr 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> -</tr> -<tr 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> -</tr> -<tr 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> -</tr> -<tr 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> -</tr> -<tr 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> -</tr> -<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><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream()">getSystemStream</a></strong>()</code> </td> -</tr> -<tr 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> -</tr> -<tr 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> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKey()">getKey</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName()">getKeySerializerName</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage()">getMessage</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName()">getMessageSerializerName</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey()">getPartitionKey</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream()">getSystemStream</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode()">hashCode</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#toString()">toString</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + <!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<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> -<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> -<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> -</li> -</ul> -<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> -<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> -</li> -</ul> -<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> -<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> -</li> -</ul> -<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> -<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> -</li> -</ul> -</li> -</ul> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)"><!-- --></A><H3> +OutgoingMessageEnvelope</H3> +<PRE> +public <B>OutgoingMessageEnvelope</B>(<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> +<DL> +<DD>Constructs a new OutgoingMessageEnvelope from specified components. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>systemStream</CODE> - Object representing the appropriate stream of which this envelope will be sent on.<DD><CODE>keySerializerName</CODE> - String representing the serializer used for serializing this envelope's key.<DD><CODE>messageSerializerName</CODE> - String representing the serializer used for serializing this envelope's message.<DD><CODE>partitionKey</CODE> - A key representing which partition of the systemStream to send this envelope on.<DD><CODE>key</CODE> - A deserialized key to be used for the message.<DD><CODE>message</CODE> - A deserialized message to be sent in this envelope.</DL> +</DL> +<HR> + +<A NAME="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object, java.lang.Object)"><!-- --></A><H3> +OutgoingMessageEnvelope</H3> +<PRE> +public <B>OutgoingMessageEnvelope</B>(<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> +<DL> +<DD>Constructs a new OutgoingMessageEnvelope from specified components. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>systemStream</CODE> - Object representing the appropriate stream of which this envelope will be sent on.<DD><CODE>partitionKey</CODE> - A key representing which partition of the systemStream to send this envelope on.<DD><CODE>key</CODE> - A deserialized key to be used for the message.<DD><CODE>message</CODE> - A deserialized message to be sent in this envelope.</DL> +</DL> +<HR> + +<A NAME="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object)"><!-- --></A><H3> +OutgoingMessageEnvelope</H3> +<PRE> +public <B>OutgoingMessageEnvelope</B>(<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> +<DL> +<DD>Constructs a new OutgoingMessageEnvelope from specified components. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>systemStream</CODE> - Object representing the appropriate stream of which this envelope will be sent on.<DD><CODE>key</CODE> - A deserialized key to be used for the message.<DD><CODE>message</CODE> - A deserialized message to be sent in this envelope.</DL> +</DL> +<HR> + +<A NAME="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object)"><!-- --></A><H3> +OutgoingMessageEnvelope</H3> +<PRE> +public <B>OutgoingMessageEnvelope</B>(<A HREF="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</A> systemStream, + java.lang.Object message)</PRE> +<DL> +<DD>Constructs a new OutgoingMessageEnvelope from specified components. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>systemStream</CODE> - Object representing the appropriate stream of which this envelope will be sent on.<DD><CODE>message</CODE> - A deserialized message to be sent in this envelope.</DL> +</DL> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getSystemStream()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSystemStream</h4> -<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> -<ul class="blockList"> -<li class="blockList"> -<h4>getKeySerializerName</h4> -<pre>public java.lang.String getKeySerializerName()</pre> -</li> -</ul> -<a name="getMessageSerializerName()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMessageSerializerName</h4> -<pre>public java.lang.String getMessageSerializerName()</pre> -</li> -</ul> -<a name="getPartitionKey()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getPartitionKey</h4> -<pre>public java.lang.Object getPartitionKey()</pre> -</li> -</ul> -<a name="getKey()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getKey</h4> -<pre>public java.lang.Object getKey()</pre> -</li> -</ul> -<a name="getMessage()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMessage</h4> -<pre>public java.lang.Object getMessage()</pre> -</li> -</ul> -<a name="hashCode()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hashCode</h4> -<pre>public int hashCode()</pre> -<dl> -<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> -<ul class="blockList"> -<li class="blockList"> -<h4>equals</h4> -<pre>public boolean equals(java.lang.Object obj)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>equals</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getSystemStream()"><!-- --></A><H3> +getSystemStream</H3> +<PRE> +public <A HREF="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</A> <B>getSystemStream</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getKeySerializerName()"><!-- --></A><H3> +getKeySerializerName</H3> +<PRE> +public java.lang.String <B>getKeySerializerName</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getMessageSerializerName()"><!-- --></A><H3> +getMessageSerializerName</H3> +<PRE> +public java.lang.String <B>getMessageSerializerName</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getPartitionKey()"><!-- --></A><H3> +getPartitionKey</H3> +<PRE> +public java.lang.Object <B>getPartitionKey</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getKey()"><!-- --></A><H3> +getKey</H3> +<PRE> +public java.lang.Object <B>getKey</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getMessage()"><!-- --></A><H3> +getMessage</H3> +<PRE> +public java.lang.Object <B>getMessage</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="hashCode()"><!-- --></A><H3> +hashCode</H3> +<PRE> +public int <B>hashCode</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(java.lang.Object)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(java.lang.Object obj)</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> +<HR> + + <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</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> -</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> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/system/OutgoingMessageEnvelope.html" target="_top"><B>FRAMES</B></A> + <A HREF="OutgoingMessageEnvelope.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<div> -<ul class="subNavList"> -<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> -</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> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML>
Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html Wed Dec 10 00:54:42 2014 @@ -1,239 +1,243 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Fri Dec 05 10:56:59 PST 2014 --> -<title>SystemAdmin (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +SystemAdmin (samza-api 0.9.0-SNAPSHOT API) +</TITLE> + +<META NAME="date" CONTENT="2014-12-09"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemAdmin (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="SystemAdmin (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</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> -</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> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/system/SystemAdmin.html" target="_top"><B>FRAMES</B></A> + <A HREF="SystemAdmin.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </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> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> + +<HR> <!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.system</div> -<h2 title="Interface SystemAdmin" class="title">Interface SystemAdmin</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="strong">SystemAdmin</span></pre> -<div class="block">Helper interface attached to an underlying system to fetch +<H2> +<FONT SIZE="-1"> +org.apache.samza.system</FONT> +<BR> +Interface SystemAdmin</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>SystemAdmin</B></DL> +</PRE> + +<P> +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> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> + system. +<P> + +<P> +<HR> + +<P> + <!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<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> -<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.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> -<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"> -<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> -<div class="block">Fetch metadata from a system for a set of streams.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<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></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/SystemAdmin.html#getOffsetsAfter(java.util.Map)">getOffsetsAfter</A></B>(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> + +<BR> + Fetches the offsets for the messages immediately after the supplied offsets + for a group of SystemStreamPartitions.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<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></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/system/SystemAdmin.html#getSystemStreamMetadata(java.util.Set)">getSystemStreamMetadata</A></B>(java.util.Set<java.lang.String> streamNames)</CODE> + +<BR> + Fetch metadata from a system for a set of streams.</TD> +</TR> +</TABLE> + +<P> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getOffsetsAfter(java.util.Map)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getOffsetsAfter</h4> -<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> -</li> -</ul> -<a name="getSystemStreamMetadata(java.util.Set)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<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> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getOffsetsAfter(java.util.Map)"><!-- --></A><H3> +getOffsetsAfter</H3> +<PRE> +java.util.Map<<A HREF="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</A>,java.lang.String> <B>getOffsetsAfter</B>(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> +<DL> +<DD>Fetches the offsets for the messages immediately after the supplied offsets + for a group of SystemStreamPartitions. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>offsets</CODE> - Map from SystemStreamPartition to current offsets. +<DT><B>Returns:</B><DD>Map from SystemStreamPartition to offsets immediately after the + current offsets.</DL> +</DD> +</DL> +<HR> + +<A NAME="getSystemStreamMetadata(java.util.Set)"><!-- --></A><H3> +getSystemStreamMetadata</H3> +<PRE> +java.util.Map<java.lang.String,<A HREF="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</A>> <B>getSystemStreamMetadata</B>(java.util.Set<java.lang.String> streamNames)</PRE> +<DL> +<DD>Fetch metadata from a system for a set of streams. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>streamNames</CODE> - The streams to to fetch metadata for. +<DT><B>Returns:</B><DD>A map from stream name to SystemStreamMetadata for each stream + requested in the parameter set.</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> +<HR> + + <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</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> -</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> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/system/SystemAdmin.html" target="_top"><B>FRAMES</B></A> + <A HREF="SystemAdmin.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </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> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML>
