http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html b/0100/javadoc/org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html new file mode 100644 index 0000000..b8cdb47 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html @@ -0,0 +1,281 @@ +<!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_80) on Thu May 19 00:52:04 BST 2016 --> +<title>ConsumerRecordTimestampExtractor (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConsumerRecordTimestampExtractor (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= 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/kafka/streams/processor/AbstractProcessor.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/DefaultPartitionGrouper.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html" target="_top">Frames</a></li> +<li><a href="ConsumerRecordTimestampExtractor.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.processor</div> +<h2 title="Class ConsumerRecordTimestampExtractor" class="title">Class ConsumerRecordTimestampExtractor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.streams.processor.ConsumerRecordTimestampExtractor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor">TimestampExtractor</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConsumerRecordTimestampExtractor</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor">TimestampExtractor</a></pre> +<div class="block">Retrieves built-in timestamps from Kafka messages (introduced in KIP-32: Add timestamps to Kafka message). + + Here, "built-in" refers to the fact that compatible Kafka producer clients automatically and + transparently embed such timestamps into messages they sent to Kafka, which can then be retrieved + via this timestamp extractor. + + If <i>CreateTime</i> is used to define the built-in timestamps, using this extractor effectively provide + <i>event-time</i> semantics. If <i>LogAppendTime</i> is used to define the built-in timestamps, using + this extractor effectively provides <i>ingestion-time</i> semantics. + + If you need <i>processing-time</i> semantics, use <a href="../../../../../org/apache/kafka/streams/processor/WallclockTimestampExtractor.html" title="class in org.apache.kafka.streams.processor"><code>WallclockTimestampExtractor</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/kafka/streams/processor/ConsumerRecordTimestampExtractor.html#ConsumerRecordTimestampExtractor()">ConsumerRecordTimestampExtractor</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html#extract(org.apache.kafka.clients.consumer.ConsumerRecord)">extract</a></strong>(<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> record)</code> +<div class="block">Extracts a timestamp from a record.</div> +</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConsumerRecordTimestampExtractor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConsumerRecordTimestampExtractor</h4> +<pre>public ConsumerRecordTimestampExtractor()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="extract(org.apache.kafka.clients.consumer.ConsumerRecord)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>extract</h4> +<pre>public long extract(<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> record)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html#extract(org.apache.kafka.clients.consumer.ConsumerRecord)">TimestampExtractor</a></code></strong></div> +<div class="block">Extracts a timestamp from a record. + <p> + Typically, the timestamp represents the milliseconds since midnight, January 1, 1970 UTC.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html#extract(org.apache.kafka.clients.consumer.ConsumerRecord)">extract</a></code> in interface <code><a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor">TimestampExtractor</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>record</code> - a data record</dd> +<dt><span class="strong">Returns:</span></dt><dd>the timestamp of the record</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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/kafka/streams/processor/AbstractProcessor.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/DefaultPartitionGrouper.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/ConsumerRecordTimestampExtractor.html" target="_top">Frames</a></li> +<li><a href="ConsumerRecordTimestampExtractor.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/processor/DefaultPartitionGrouper.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/processor/DefaultPartitionGrouper.html b/0100/javadoc/org/apache/kafka/streams/processor/DefaultPartitionGrouper.html new file mode 100644 index 0000000..a22b50d --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/processor/DefaultPartitionGrouper.html @@ -0,0 +1,291 @@ +<!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_80) on Thu May 19 00:52:04 BST 2016 --> +<title>DefaultPartitionGrouper (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DefaultPartitionGrouper (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= 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/kafka/streams/processor/ConsumerRecordTimestampExtractor.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/DefaultPartitionGrouper.html" target="_top">Frames</a></li> +<li><a href="DefaultPartitionGrouper.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.processor</div> +<h2 title="Class DefaultPartitionGrouper" class="title">Class DefaultPartitionGrouper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.streams.processor.DefaultPartitionGrouper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor">PartitionGrouper</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DefaultPartitionGrouper</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor">PartitionGrouper</a></pre> +<div class="block">Default implementation of the <a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor"><code>PartitionGrouper</code></a> interface that groups partitions by the partition id. + + Join operations requires that topics of the joining entities are copartitoned, i.e., being partitioned by the same key and having the same + number of partitions. Copartitioning is ensured by having the same number of partitions on + joined topics, and by using the serialization and Producer's default partitioner.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/kafka/streams/processor/DefaultPartitionGrouper.html#DefaultPartitionGrouper()">DefaultPartitionGrouper</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/DefaultPartitionGrouper.html#maxNumPartitions(org.apache.kafka.common.Cluster,%20java.util.Set)">maxNumPartitions</a></strong>(<a href="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> topics)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/DefaultPartitionGrouper.html#partitionGroups(java.util.Map,%20org.apache.kafka.common.Cluster)">partitionGroups</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> topicGroups, + <a href="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata)</code> +<div class="block">Generate tasks with the assigned topic partitions.</div> +</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DefaultPartitionGrouper()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DefaultPartitionGrouper</h4> +<pre>public DefaultPartitionGrouper()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="partitionGroups(java.util.Map, org.apache.kafka.common.Cluster)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitionGroups</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>>> partitionGroups(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set </a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> topicGroups, + <a href="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata)</pre> +<div class="block">Generate tasks with the assigned topic partitions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html#partitionGroups(java.util.Map,%20org.apache.kafka.common.Cluster)">partitionGroups</a></code> in interface <code><a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor">PartitionGrouper</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>topicGroups</code> - group of topics that need to be joined together</dd><dd><code>metadata</code> - metadata of the consuming cluster</dd> +<dt><span class="strong">Returns:</span></dt><dd>The map from generated task ids to the assigned partitions</dd></dl> +</li> +</ul> +<a name="maxNumPartitions(org.apache.kafka.common.Cluster, java.util.Set)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>maxNumPartitions</h4> +<pre>protected int maxNumPartitions(<a href="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> topics)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/streams/errors/StreamsException.html" title="class in org.apache.kafka.streams.errors">StreamsException</a></code> - if no metadata can be received for a topic</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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/kafka/streams/processor/ConsumerRecordTimestampExtractor.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/DefaultPartitionGrouper.html" target="_top">Frames</a></li> +<li><a href="DefaultPartitionGrouper.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/processor/PartitionGrouper.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/processor/PartitionGrouper.html b/0100/javadoc/org/apache/kafka/streams/processor/PartitionGrouper.html new file mode 100644 index 0000000..0a7c52d --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/processor/PartitionGrouper.html @@ -0,0 +1,223 @@ +<!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_80) on Thu May 19 00:52:04 BST 2016 --> +<title>PartitionGrouper (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="PartitionGrouper (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= 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/kafka/streams/processor/DefaultPartitionGrouper.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/Processor.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/PartitionGrouper.html" target="_top">Frames</a></li> +<li><a href="PartitionGrouper.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.processor</div> +<h2 title="Interface PartitionGrouper" class="title">Interface PartitionGrouper</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/kafka/streams/processor/DefaultPartitionGrouper.html" title="class in org.apache.kafka.streams.processor">DefaultPartitionGrouper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">PartitionGrouper</span></pre> +<div class="block">A partition grouper that generates partition groups given the list of topic-partitions. + + This grouper also acts as the stream task creation function along with partition distribution + such that each generated partition group is assigned with a distinct <a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor"><code>TaskId</code></a>; + the created task ids will then be assigned to Kafka Streams instances that host the stream + processing application.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/PartitionGrouper.html#partitionGroups(java.util.Map,%20org.apache.kafka.common.Cluster)">partitionGroups</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> topicGroups, + <a href="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata)</code> +<div class="block">Returns a map of task ids to groups of partitions.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="partitionGroups(java.util.Map, org.apache.kafka.common.Cluster)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>partitionGroups</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>>> partitionGroups(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a h ref="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> topicGroups, + <a href="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata)</pre> +<div class="block">Returns a map of task ids to groups of partitions. A partition group forms a task, thus, partitions that are + expected to be processed together must be in the same group. DefaultPartitionGrouper implements this + interface. See <a href="../../../../../org/apache/kafka/streams/processor/DefaultPartitionGrouper.html" title="class in org.apache.kafka.streams.processor"><code>DefaultPartitionGrouper</code></a> for more information.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topicGroups</code> - The map from the <a href="../../../../../org/apache/kafka/streams/processor/TopologyBuilder.html#topicGroups(java.lang.String)"><code>TopologyBuilder.topicGroups(String)</code></a> topic group} id to topics</dd><dd><code>metadata</code> - Metadata of the consuming cluster</dd> +<dt><span class="strong">Returns:</span></dt><dd>a map of task ids to groups of partitions</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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/kafka/streams/processor/DefaultPartitionGrouper.html" title="class in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/Processor.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/PartitionGrouper.html" target="_top">Frames</a></li> +<li><a href="PartitionGrouper.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/processor/Processor.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/processor/Processor.html b/0100/javadoc/org/apache/kafka/streams/processor/Processor.html new file mode 100644 index 0000000..52b59c5 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/processor/Processor.html @@ -0,0 +1,275 @@ +<!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_80) on Thu May 19 00:52:04 BST 2016 --> +<title>Processor (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Processor (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= 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/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/Processor.html" target="_top">Frames</a></li> +<li><a href="Processor.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.processor</div> +<h2 title="Interface Processor" class="title">Interface Processor<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - the type of keys</dd><dd><code>V</code> - the type of values</dd></dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/kafka/streams/processor/AbstractProcessor.html" title="class in org.apache.kafka.streams.processor">AbstractProcessor</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Processor<K,V></span></pre> +<div class="block">A processor of key-value pair records.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/Processor.html#close()">close</a></strong>()</code> +<div class="block">Close this processor and clean up any resources.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/Processor.html#init(org.apache.kafka.streams.processor.ProcessorContext)">init</a></strong>(<a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor">ProcessorContext</a> context)</code> +<div class="block">Initialize this processor with the given context.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/Processor.html#process(K,%20V)">process</a></strong>(<a href="../../../../../org/apache/kafka/streams/processor/Processor.html" title="type parameter in Processor">K</a> key, + <a href="../../../../../org/apache/kafka/streams/processor/Processor.html" title="type parameter in Processor">V</a> value)</code> +<div class="block">Process the record with the given key and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/Processor.html#punctuate(long)">punctuate</a></strong>(long timestamp)</code> +<div class="block">Perform any periodic operations, if this processor <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the context + during <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(org.apache.kafka.streams.processor.ProcessorContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor">ProcessorContext</a> context)</pre> +<div class="block">Initialize this processor with the given context. The framework ensures this is called once per processor when the topology + that contains it is initialized. + <p> + If this processor is to be <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#punctuate(long)"><code>called periodically</code></a> by the framework, then this method should + <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the provided context.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the context; may not be null</dd></dl> +</li> +</ul> +<a name="process(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="process(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>process</h4> +<pre>void process(<a href="../../../../../org/apache/kafka/streams/processor/Processor.html" title="type parameter in Processor">K</a> key, + <a href="../../../../../org/apache/kafka/streams/processor/Processor.html" title="type parameter in Processor">V</a> value)</pre> +<div class="block">Process the record with the given key and value.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key for the record</dd><dd><code>value</code> - the value for the record</dd></dl> +</li> +</ul> +<a name="punctuate(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>punctuate</h4> +<pre>void punctuate(long timestamp)</pre> +<div class="block">Perform any periodic operations, if this processor <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the context + during <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - the stream time when this method is being called</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">Close this processor and clean up any resources. Be aware that <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#close()"><code>close()</code></a> is called after an internal cleanup. + Thus, it is not possible to write anything to Kafka as underlying clients are already closed.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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/kafka/streams/processor/PartitionGrouper.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/Processor.html" target="_top">Frames</a></li> +<li><a href="Processor.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/processor/ProcessorContext.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/processor/ProcessorContext.html b/0100/javadoc/org/apache/kafka/streams/processor/ProcessorContext.html new file mode 100644 index 0000000..0746930 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/processor/ProcessorContext.html @@ -0,0 +1,517 @@ +<!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_80) on Thu May 19 00:52:04 BST 2016 --> +<title>ProcessorContext (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ProcessorContext (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= 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/kafka/streams/processor/Processor.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/ProcessorSupplier.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/ProcessorContext.html" target="_top">Frames</a></li> +<li><a href="ProcessorContext.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.processor</div> +<h2 title="Interface ProcessorContext" class="title">Interface ProcessorContext</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public interface <span class="strong">ProcessorContext</span></pre> +<div class="block">Processor context interface.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#applicationId()">applicationId</a></strong>()</code> +<div class="block">Returns the application id</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#commit()">commit</a></strong>()</code> +<div class="block">Requests a commit</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><K,V> void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#forward(K,%20V)">forward</a></strong>(K key, + V value)</code> +<div class="block">Forwards a key/value pair to the downstream processors</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><K,V> void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#forward(K,%20V,%20int)">forward</a></strong>(K key, + V value, + int childIndex)</code> +<div class="block">Forwards a key/value pair to one of the downstream processors designated by childIndex</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><K,V> void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#forward(K,%20V,%20java.lang.String)">forward</a></strong>(K key, + V value, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> childName)</code> +<div class="block">Forwards a key/value pair to one of the downstream processors designated by the downstream processor name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#getStateStore(java.lang.String)">getStateStore</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Get the state store given the store name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#keySerde()">keySerde</a></strong>()</code> +<div class="block">Returns the default key serde</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/StreamsMetrics.html" title="interface in org.apache.kafka.streams">StreamsMetrics</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#metrics()">metrics</a></strong>()</code> +<div class="block">Returns Metrics instance</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#offset()">offset</a></strong>()</code> +<div class="block">Returns the offset of the current input record; could be -1 if it is not + available (for example, if this method is invoked from the punctuate call)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#partition()">partition</a></strong>()</code> +<div class="block">Returns the partition id of the current input record; could be -1 if it is not + available (for example, if this method is invoked from the punctuate call)</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#register(org.apache.kafka.streams.processor.StateStore,%20boolean,%20org.apache.kafka.streams.processor.StateRestoreCallback)">register</a></strong>(<a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a> store, + boolean loggingEnabled, + <a href="../../../../../org/apache/kafka/streams/processor/StateRestoreCallback.html" title="interface in org.apache.kafka.streams.processor">StateRestoreCallback</a> stateRestoreCallback)</code> +<div class="block">Registers and possibly restores the specified storage engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)">schedule</a></strong>(long interval)</code> +<div class="block">Schedules a periodic operation for processors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#stateDir()">stateDir</a></strong>()</code> +<div class="block">Returns the state directory for the partition.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#taskId()">taskId</a></strong>()</code> +<div class="block">Returns the task id</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#timestamp()">timestamp</a></strong>()</code> +<div class="block">Returns the current timestamp.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#topic()">topic</a></strong>()</code> +<div class="block">Returns the topic name of the current input record; could be null if it is not + available (for example, if this method is invoked from the punctuate call)</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#valueSerde()">valueSerde</a></strong>()</code> +<div class="block">Returns the default value serde</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="applicationId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>applicationId</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> applicationId()</pre> +<div class="block">Returns the application id</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the application id</dd></dl> +</li> +</ul> +<a name="taskId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>taskId</h4> +<pre><a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a> taskId()</pre> +<div class="block">Returns the task id</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the task id</dd></dl> +</li> +</ul> +<a name="keySerde()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySerde</h4> +<pre><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><?> keySerde()</pre> +<div class="block">Returns the default key serde</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the key serializer</dd></dl> +</li> +</ul> +<a name="valueSerde()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueSerde</h4> +<pre><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><?> valueSerde()</pre> +<div class="block">Returns the default value serde</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the value serializer</dd></dl> +</li> +</ul> +<a name="stateDir()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stateDir</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> stateDir()</pre> +<div class="block">Returns the state directory for the partition.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the state directory</dd></dl> +</li> +</ul> +<a name="metrics()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>metrics</h4> +<pre><a href="../../../../../org/apache/kafka/streams/StreamsMetrics.html" title="interface in org.apache.kafka.streams">StreamsMetrics</a> metrics()</pre> +<div class="block">Returns Metrics instance</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>StreamsMetrics</dd></dl> +</li> +</ul> +<a name="register(org.apache.kafka.streams.processor.StateStore, boolean, org.apache.kafka.streams.processor.StateRestoreCallback)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>void register(<a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a> store, + boolean loggingEnabled, + <a href="../../../../../org/apache/kafka/streams/processor/StateRestoreCallback.html" title="interface in org.apache.kafka.streams.processor">StateRestoreCallback</a> stateRestoreCallback)</pre> +<div class="block">Registers and possibly restores the specified storage engine.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>store</code> - the storage engine</dd></dl> +</li> +</ul> +<a name="getStateStore(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStateStore</h4> +<pre><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a> getStateStore(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Get the state store given the store name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The store name</dd> +<dt><span class="strong">Returns:</span></dt><dd>The state store instance</dd></dl> +</li> +</ul> +<a name="schedule(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>schedule</h4> +<pre>void schedule(long interval)</pre> +<div class="block">Schedules a periodic operation for processors. A processor may call this method during + <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a> to + schedule a periodic call called a punctuation to <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#punctuate(long)"><code>Processor.punctuate(long)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - the time interval between punctuations</dd></dl> +</li> +</ul> +<a name="forward(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="forward(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forward</h4> +<pre><K,V> void forward(K key, + V value)</pre> +<div class="block">Forwards a key/value pair to the downstream processors</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key</dd><dd><code>value</code> - value</dd></dl> +</li> +</ul> +<a name="forward(java.lang.Object,java.lang.Object,int)"> +<!-- --> +</a><a name="forward(K, V, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forward</h4> +<pre><K,V> void forward(K key, + V value, + int childIndex)</pre> +<div class="block">Forwards a key/value pair to one of the downstream processors designated by childIndex</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key</dd><dd><code>value</code> - value</dd><dd><code>childIndex</code> - index in list of children of this node</dd></dl> +</li> +</ul> +<a name="forward(java.lang.Object,java.lang.Object,java.lang.String)"> +<!-- --> +</a><a name="forward(K, V, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forward</h4> +<pre><K,V> void forward(K key, + V value, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> childName)</pre> +<div class="block">Forwards a key/value pair to one of the downstream processors designated by the downstream processor name</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key</dd><dd><code>value</code> - value</dd><dd><code>childName</code> - name of downstream processor</dd></dl> +</li> +</ul> +<a name="commit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commit</h4> +<pre>void commit()</pre> +<div class="block">Requests a commit</div> +</li> +</ul> +<a name="topic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>topic</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic()</pre> +<div class="block">Returns the topic name of the current input record; could be null if it is not + available (for example, if this method is invoked from the punctuate call)</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the topic name</dd></dl> +</li> +</ul> +<a name="partition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partition</h4> +<pre>int partition()</pre> +<div class="block">Returns the partition id of the current input record; could be -1 if it is not + available (for example, if this method is invoked from the punctuate call)</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the partition id</dd></dl> +</li> +</ul> +<a name="offset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>long offset()</pre> +<div class="block">Returns the offset of the current input record; could be -1 if it is not + available (for example, if this method is invoked from the punctuate call)</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the offset</dd></dl> +</li> +</ul> +<a name="timestamp()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>timestamp</h4> +<pre>long timestamp()</pre> +<div class="block">Returns the current timestamp. + + If it is triggered while processing a record streamed from the source processor, timestamp is defined as the timestamp of the current input record; the timestamp is extracted from + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><code>ConsumerRecord</code></a> by <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TimestampExtractor</code></a>. + + If it is triggered while processing a record generated not from the source processor (for example, + if this method is invoked from the punctuate call), timestamp is defined as the current + task's stream time, which is defined as the smallest among all its input stream partition timestamps.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the timestamp</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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/kafka/streams/processor/Processor.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/processor/ProcessorSupplier.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/ProcessorContext.html" target="_top">Frames</a></li> +<li><a href="ProcessorContext.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"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</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> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
