http://git-wip-us.apache.org/repos/asf/kafka-site/blob/b91f7909/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html new file mode 100644 index 0000000..a64e14e --- /dev/null +++ b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html @@ -0,0 +1,285 @@ +<!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_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>ConsumerInterceptor (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<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="ConsumerInterceptor (clients 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/clients/consumer/ConsumerConfig.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html" title="interface in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerInterceptor.html" target="_top">Frames</a></li> +<li><a href="ConsumerInterceptor.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.clients.consumer</div> +<h2 title="Interface ConsumerInterceptor" class="title">Interface ConsumerInterceptor<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ConsumerInterceptor<K,V></span> +extends <a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></pre> +<div class="block">A plugin interface that allows you to intercept (and possibly mutate) records received by the consumer. A primary use-case + is for third-party components to hook into the consumer applications for custom monitoring, logging, etc. + + <p> + This class will get consumer config properties via <code>configure()</code> method, including clientId assigned + by KafkaConsumer if not specified in the consumer config. The interceptor implementation needs to be aware that it will be + sharing consumer config namespace with other interceptors and serializers, and ensure that there are no conflicts. + <p> + Exceptions thrown by ConsumerInterceptor methods will be caught, logged, but not propagated further. As a result, if + the user configures the interceptor with the wrong key and value type parameters, the consumer will not throw an exception, + just log the errors. + <p> + ConsumerInterceptor callbacks are called from the same thread that invokes <a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html#poll(long)"><code>KafkaConsumer.poll(long)</code></a>.</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/clients/consumer/ConsumerInterceptor.html#close()">close</a></strong>()</code> +<div class="block">This is called when interceptor is closed</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html#onCommit(java.util.Map)">onCommit</a></strong>(java.util.Map<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="../../../../../org/apache/kafka/clients/consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>> offsets)</code> +<div class="block">This is called when offsets get committed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html#onConsume(org.apache.kafka.clients.consumer.ConsumerRecords)">onConsume</a></strong>(<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">V</a>> records)</code> +<div class="block">This is called just before the records are returned by <a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html#poll(long)"><code>KafkaConsumer.poll(long)</code></a></div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.common.Configurable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.kafka.common.<a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></h3> +<code><a href="../../../../../org/apache/kafka/common/Configurable.html#configure(java.util.Map)">configure</a></code></li> +</ul> +</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="onConsume(org.apache.kafka.clients.consumer.ConsumerRecords)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onConsume</h4> +<pre><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">V</a>> onConsume(<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="type parameter in ConsumerInterceptor">V</a>> records)</pre> +<div class="block">This is called just before the records are returned by <a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html#poll(long)"><code>KafkaConsumer.poll(long)</code></a> + <p> + This method is allowed to modify consumer records, in which case the new records will be + returned. There is no limitation on number of records that could be returned from this + method. I.e., the interceptor can filter the records or generate new records. + <p> + Any exception thrown by this method will be caught by the caller, logged, but not propagated to the client. + <p> + Since the consumer may run multiple interceptors, a particular interceptor's onConsume() callback will be called + in the order specified by <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#INTERCEPTOR_CLASSES_CONFIG"><code>ConsumerConfig.INTERCEPTOR_CLASSES_CONFIG</code></a>. + The first interceptor in the list gets the consumed records, the following interceptor will be passed the records returned + by the previous interceptor, and so on. Since interceptors are allowed to modify records, interceptors may potentially get + the records already modified by other interceptors. However, building a pipeline of mutable interceptors that depend on the output + of the previous interceptor is discouraged, because of potential side-effects caused by interceptors potentially failing + to modify the record and throwing an exception. If one of the interceptors in the list throws an exception from onConsume(), + the exception is caught, logged, and the next interceptor is called with the records returned by the last successful interceptor + in the list, or otherwise the original consumed records.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>records</code> - records to be consumed by the client or records returned by the previous interceptors in the list.</dd> +<dt><span class="strong">Returns:</span></dt><dd>records that are either modified by the interceptor or same as records passed to this method.</dd></dl> +</li> +</ul> +<a name="onCommit(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onCommit</h4> +<pre>void onCommit(java.util.Map<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="../../../../../org/apache/kafka/clients/consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>> offsets)</pre> +<div class="block">This is called when offsets get committed. + <p> + Any exception thrown by this method will be ignored by the caller.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsets</code> - A map of offsets by partition with associated metadata</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">This is called when interceptor is 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/clients/consumer/ConsumerConfig.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html" title="interface in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerInterceptor.html" target="_top">Frames</a></li> +<li><a href="ConsumerInterceptor.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/b91f7909/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html new file mode 100644 index 0000000..dc8a70e --- /dev/null +++ b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html @@ -0,0 +1,294 @@ +<!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_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>ConsumerRebalanceListener (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<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="ConsumerRebalanceListener (clients 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/clients/consumer/ConsumerInterceptor.html" title="interface in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html" target="_top">Frames</a></li> +<li><a href="ConsumerRebalanceListener.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.clients.consumer</div> +<h2 title="Interface ConsumerRebalanceListener" class="title">Interface ConsumerRebalanceListener</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ConsumerRebalanceListener</span></pre> +<div class="block">A callback interface that the user can implement to trigger custom actions when the set of partitions assigned to the + consumer changes. + <p> + This is applicable when the consumer is having Kafka auto-manage group membership. If the consumer's directly assign partitions, + those partitions will never be reassigned and this callback is not applicable. + <p> + When Kafka is managing the group membership, a partition re-assignment will be triggered any time the members of the group changes or the subscription + of the members changes. This can occur when processes die, new process instances are added or old instances come back to life after failure. + Rebalances can also be triggered by changes affecting the subscribed topics (e.g. when then number of partitions is + administratively adjusted). + <p> + There are many uses for this functionality. One common use is saving offsets in a custom store. By saving offsets in + the <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsRevoked(java.util.Collection)"><code>onPartitionsRevoked(Collection)</code></a>, call we can ensure that any time partition assignment changes + the offset gets saved. + <p> + Another use is flushing out any kind of cache of intermediate results the consumer may be keeping. For example, + consider a case where the consumer is subscribed to a topic containing user page views, and the goal is to count the + number of page views per users for each five minute window. Let's say the topic is partitioned by the user id so that + all events for a particular user will go to a single consumer instance. The consumer can keep in memory a running + tally of actions per user and only flush these out to a remote data store when its cache gets to big. However if a + partition is reassigned it may want to automatically trigger a flush of this cache, before the new owner takes over + consumption. + <p> + This callback will execute in the user thread as part of the <a href="../../../../../org/apache/kafka/clients/consumer/Consumer.html#poll(long)"><code>poll(long)</code></a> call whenever partition assignment changes. + <p> + It is guaranteed that all consumer processes will invoke <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsRevoked(java.util.Collection)"><code>onPartitionsRevoked</code></a> prior to + any process invoking <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsAssigned(java.util.Collection)"><code>onPartitionsAssigned</code></a>. So if offsets or other state is saved in the + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsRevoked(java.util.Collection)"><code>onPartitionsRevoked</code></a> call it is guaranteed to be saved by the time the process taking over that + partition has their <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsAssigned(java.util.Collection)"><code>onPartitionsAssigned</code></a> callback called to load the state. + <p> + Here is pseudo-code for a callback implementation for saving offsets: + <pre> + <code>public class SaveOffsetsOnRebalance implements ConsumerRebalanceListener { + private Consumer<?,?> consumer; + + public SaveOffsetsOnRebalance(Consumer<?,?> consumer) { + this.consumer = consumer; + } + + public void onPartitionsRevoked(Collection<TopicPartition> partitions) { + // save the offsets in an external store using some custom code not described here + for(TopicPartition partition: partitions) + saveOffsetInExternalStore(consumer.position(partition)); + } + + public void onPartitionsAssigned(Collection<TopicPartition> partitions) { + // read the offsets from an external store using some custom code not described here + for(TopicPartition partition: partitions) + consumer.seek(partition, readOffsetFromExternalStore(partition)); + } + } + </code> + </pre></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/clients/consumer/ConsumerRebalanceListener.html#onPartitionsAssigned(java.util.Collection)">onPartitionsAssigned</a></strong>(java.util.Collection<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</code> +<div class="block">A callback method the user can implement to provide handling of customized offsets on completion of a successful + partition re-assignment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsRevoked(java.util.Collection)">onPartitionsRevoked</a></strong>(java.util.Collection<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</code> +<div class="block">A callback method the user can implement to provide handling of offset commits to a customized store on the start + of a rebalance operation.</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="onPartitionsRevoked(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onPartitionsRevoked</h4> +<pre>void onPartitionsRevoked(java.util.Collection<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</pre> +<div class="block">A callback method the user can implement to provide handling of offset commits to a customized store on the start + of a rebalance operation. This method will be called before a rebalance operation starts and after the consumer + stops fetching data. It is recommended that offsets should be committed in this callback to either Kafka or a + custom offset store to prevent duplicate data. + <p> + For examples on usage of this API, see Usage Examples section of <a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html" title="class in org.apache.kafka.clients.consumer"><code>KafkaConsumer</code></a> + <p> + <b>NOTE:</b> This method is only called before rebalances. It is not called prior to <a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html#close()"><code>KafkaConsumer.close()</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitions</code> - The list of partitions that were assigned to the consumer on the last rebalance</dd></dl> +</li> +</ul> +<a name="onPartitionsAssigned(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onPartitionsAssigned</h4> +<pre>void onPartitionsAssigned(java.util.Collection<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</pre> +<div class="block">A callback method the user can implement to provide handling of customized offsets on completion of a successful + partition re-assignment. This method will be called after an offset re-assignment completes and before the + consumer starts fetching data. + <p> + It is guaranteed that all the processes in a consumer group will execute their + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsRevoked(java.util.Collection)"><code>onPartitionsRevoked(Collection)</code></a> callback before any instance executes its + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html#onPartitionsAssigned(java.util.Collection)"><code>onPartitionsAssigned(Collection)</code></a> callback.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitions</code> - The list of partitions that are now assigned to the consumer (may include partitions previously + assigned to the consumer)</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/clients/consumer/ConsumerInterceptor.html" title="interface in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html" target="_top">Frames</a></li> +<li><a href="ConsumerRebalanceListener.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/b91f7909/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecord.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecord.html b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecord.html new file mode 100644 index 0000000..c1f810b --- /dev/null +++ b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecord.html @@ -0,0 +1,541 @@ +<!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_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>ConsumerRecord (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<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="ConsumerRecord (clients 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/clients/consumer/ConsumerRebalanceListener.html" title="interface in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerRecord.html" target="_top">Frames</a></li> +<li><a href="ConsumerRecord.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.consumer</div> +<h2 title="Class ConsumerRecord" class="title">Class ConsumerRecord<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.consumer.ConsumerRecord<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">ConsumerRecord<K,V></span> +extends java.lang.Object</pre> +<div class="block">A key/value pair to be received from Kafka. This consists of a topic name and a partition number, from which the + record is being received and an offset that points to the record in a Kafka partition.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#NO_TIMESTAMP">NO_TIMESTAMP</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#NULL_CHECKSUM">NULL_CHECKSUM</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#NULL_SIZE">NULL_SIZE</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/clients/consumer/ConsumerRecord.html#ConsumerRecord(java.lang.String,%20int,%20long,%20K,%20V)">ConsumerRecord</a></strong>(java.lang.String topic, + int partition, + long offset, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">K</a> key, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">V</a> value)</code> +<div class="block">Creates a record to be received from a specified topic and partition (provided for + compatibility with Kafka 0.9 before the message format supported timestamps and before + serialized metadata were exposed).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#ConsumerRecord(java.lang.String,%20int,%20long,%20long,%20org.apache.kafka.common.record.TimestampType,%20long,%20int,%20int,%20K,%20V)">ConsumerRecord</a></strong>(java.lang.String topic, + int partition, + long offset, + long timestamp, + org.apache.kafka.common.record.TimestampType timestampType, + long checksum, + int serializedKeySize, + int serializedValueSize, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">K</a> key, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">V</a> value)</code> +<div class="block">Creates a record to be received from a specified topic and partition</div> +</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/clients/consumer/ConsumerRecord.html#checksum()">checksum</a></strong>()</code> +<div class="block">The checksum (CRC32) of the record.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">K</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#key()">key</a></strong>()</code> +<div class="block">The key (or null if no key is specified)</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#offset()">offset</a></strong>()</code> +<div class="block">The position of this record in the corresponding Kafka partition.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#partition()">partition</a></strong>()</code> +<div class="block">The partition from which this record is received</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#serializedKeySize()">serializedKeySize</a></strong>()</code> +<div class="block">The size of the serialized, uncompressed key in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#serializedValueSize()">serializedValueSize</a></strong>()</code> +<div class="block">The size of the serialized, uncompressed value in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#timestamp()">timestamp</a></strong>()</code> +<div class="block">The timestamp of this record</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.kafka.common.record.TimestampType</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#timestampType()">timestampType</a></strong>()</code> +<div class="block">The timestamp type of this record</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#topic()">topic</a></strong>()</code> +<div class="block">The topic this record is received from</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html#value()">value</a></strong>()</code> +<div class="block">The value</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.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="NO_TIMESTAMP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NO_TIMESTAMP</h4> +<pre>public static final long NO_TIMESTAMP</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerRecord.NO_TIMESTAMP">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="NULL_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NULL_SIZE</h4> +<pre>public static final int NULL_SIZE</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerRecord.NULL_SIZE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="NULL_CHECKSUM"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NULL_CHECKSUM</h4> +<pre>public static final int NULL_CHECKSUM</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerRecord.NULL_CHECKSUM">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConsumerRecord(java.lang.String,int,long,java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="ConsumerRecord(java.lang.String, int, long, K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConsumerRecord</h4> +<pre>public ConsumerRecord(java.lang.String topic, + int partition, + long offset, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">K</a> key, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">V</a> value)</pre> +<div class="block">Creates a record to be received from a specified topic and partition (provided for + compatibility with Kafka 0.9 before the message format supported timestamps and before + serialized metadata were exposed).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - The topic this record is received from</dd><dd><code>partition</code> - The partition of the topic this record is received from</dd><dd><code>offset</code> - The offset of this record in the corresponding Kafka partition</dd><dd><code>key</code> - The key of the record, if one exists (null is allowed)</dd><dd><code>value</code> - The record contents</dd></dl> +</li> +</ul> +<a name="ConsumerRecord(java.lang.String,int,long,long,org.apache.kafka.common.record.TimestampType,long,int,int,java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="ConsumerRecord(java.lang.String, int, long, long, org.apache.kafka.common.record.TimestampType, long, int, int, K, V)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConsumerRecord</h4> +<pre>public ConsumerRecord(java.lang.String topic, + int partition, + long offset, + long timestamp, + org.apache.kafka.common.record.TimestampType timestampType, + long checksum, + int serializedKeySize, + int serializedValueSize, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">K</a> key, + <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">V</a> value)</pre> +<div class="block">Creates a record to be received from a specified topic and partition</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - The topic this record is received from</dd><dd><code>partition</code> - The partition of the topic this record is received from</dd><dd><code>offset</code> - The offset of this record in the corresponding Kafka partition</dd><dd><code>timestamp</code> - The timestamp of the record.</dd><dd><code>timestampType</code> - The timestamp type</dd><dd><code>checksum</code> - The checksum (CRC32) of the full record</dd><dd><code>serializedKeySize</code> - The length of the serialized key</dd><dd><code>serializedValueSize</code> - The length of the serialized value</dd><dd><code>key</code> - The key of the record, if one exists (null is allowed)</dd><dd><code>value</code> - The record contents</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="topic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>topic</h4> +<pre>public java.lang.String topic()</pre> +<div class="block">The topic this record is received from</div> +</li> +</ul> +<a name="partition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partition</h4> +<pre>public int partition()</pre> +<div class="block">The partition from which this record is received</div> +</li> +</ul> +<a name="key()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>key</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">K</a> key()</pre> +<div class="block">The key (or null if no key is specified)</div> +</li> +</ul> +<a name="value()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>value</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="type parameter in ConsumerRecord">V</a> value()</pre> +<div class="block">The value</div> +</li> +</ul> +<a name="offset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>public long offset()</pre> +<div class="block">The position of this record in the corresponding Kafka partition.</div> +</li> +</ul> +<a name="timestamp()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timestamp</h4> +<pre>public long timestamp()</pre> +<div class="block">The timestamp of this record</div> +</li> +</ul> +<a name="timestampType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timestampType</h4> +<pre>public org.apache.kafka.common.record.TimestampType timestampType()</pre> +<div class="block">The timestamp type of this record</div> +</li> +</ul> +<a name="checksum()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checksum</h4> +<pre>public long checksum()</pre> +<div class="block">The checksum (CRC32) of the record.</div> +</li> +</ul> +<a name="serializedKeySize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serializedKeySize</h4> +<pre>public int serializedKeySize()</pre> +<div class="block">The size of the serialized, uncompressed key in bytes. If key is null, the returned size + is -1.</div> +</li> +</ul> +<a name="serializedValueSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serializedValueSize</h4> +<pre>public int serializedValueSize()</pre> +<div class="block">The size of the serialized, uncompressed value in bytes. If value is null, the + returned size is -1.</div> +</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> +<!-- ========= 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/clients/consumer/ConsumerRebalanceListener.html" title="interface in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerRecord.html" target="_top">Frames</a></li> +<li><a href="ConsumerRecord.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/b91f7909/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecords.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecords.html b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecords.html new file mode 100644 index 0000000..1bb0cd4 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/clients/consumer/ConsumerRecords.html @@ -0,0 +1,394 @@ +<!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_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>ConsumerRecords (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<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="ConsumerRecords (clients 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/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/InvalidOffsetException.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerRecords.html" target="_top">Frames</a></li> +<li><a href="ConsumerRecords.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.consumer</div> +<h2 title="Class ConsumerRecords" class="title">Class ConsumerRecords<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.consumer.ConsumerRecords<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Iterable<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><K,V>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConsumerRecords<K,V></span> +extends java.lang.Object +implements java.lang.Iterable<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><K,V>></pre> +<div class="block">A container that holds the list <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><code>ConsumerRecord</code></a> per partition for a + particular topic. There is one <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><code>ConsumerRecord</code></a> list for every topic + partition returned by a <a href="../../../../../org/apache/kafka/clients/consumer/Consumer.html#poll(long)"><code>Consumer.poll(long)</code></a> operation.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><java.lang.Object,java.lang.Object></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#EMPTY">EMPTY</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/clients/consumer/ConsumerRecords.html#ConsumerRecords(java.util.Map)">ConsumerRecords</a></strong>(java.util.Map<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,java.util.List<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>>> records)</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#count()">count</a></strong>()</code> +<div class="block">The number of records for all topics</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <K,V> <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><K,V></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#empty()">empty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#iterator()">iterator</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<<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/clients/consumer/ConsumerRecords.html#partitions()">partitions</a></strong>()</code> +<div class="block">Get the partitions which have records contained in this record set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Iterable<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#records(java.lang.String)">records</a></strong>(java.lang.String topic)</code> +<div class="block">Get just the records for the given topic</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html#records(org.apache.kafka.common.TopicPartition)">records</a></strong>(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> partition)</code> +<div class="block">Get just the records for the given partition</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.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="EMPTY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY</h4> +<pre>public static final <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><java.lang.Object,java.lang.Object> EMPTY</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConsumerRecords(java.util.Map)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConsumerRecords</h4> +<pre>public ConsumerRecords(java.util.Map<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,java.util.List<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>>> records)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="records(org.apache.kafka.common.TopicPartition)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>records</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>> records(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> partition)</pre> +<div class="block">Get just the records for the given partition</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partition</code> - The partition to get records for</dd></dl> +</li> +</ul> +<a name="records(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>records</h4> +<pre>public java.lang.Iterable<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>> records(java.lang.String topic)</pre> +<div class="block">Get just the records for the given topic</div> +</li> +</ul> +<a name="partitions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitions</h4> +<pre>public java.util.Set<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions()</pre> +<div class="block">Get the partitions which have records contained in this record set.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the set of partitions with data in this record set (may be empty if no data was returned)</dd></dl> +</li> +</ul> +<a name="iterator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public java.util.Iterator<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>> iterator()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecord</a><<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">K</a>,<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="type parameter in ConsumerRecords">V</a>>></code></dd> +</dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public int count()</pre> +<div class="block">The number of records for all topics</div> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +</li> +</ul> +<a name="empty()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>empty</h4> +<pre>public static <K,V> <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer">ConsumerRecords</a><K,V> empty()</pre> +</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/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/InvalidOffsetException.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerRecords.html" target="_top">Frames</a></li> +<li><a href="ConsumerRecords.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/b91f7909/0100/javadoc/org/apache/kafka/clients/consumer/InvalidOffsetException.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/clients/consumer/InvalidOffsetException.html b/0100/javadoc/org/apache/kafka/clients/consumer/InvalidOffsetException.html new file mode 100644 index 0000000..7c52b33 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/clients/consumer/InvalidOffsetException.html @@ -0,0 +1,294 @@ +<!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_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>InvalidOffsetException (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<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="InvalidOffsetException (clients 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/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/InvalidOffsetException.html" target="_top">Frames</a></li> +<li><a href="InvalidOffsetException.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.clients.consumer</div> +<h2 title="Class InvalidOffsetException" class="title">Class InvalidOffsetException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common">org.apache.kafka.common.KafkaException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.consumer.InvalidOffsetException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/kafka/clients/consumer/NoOffsetForPartitionException.html" title="class in org.apache.kafka.clients.consumer">NoOffsetForPartitionException</a>, <a href="../../../../../org/apache/kafka/clients/consumer/OffsetOutOfRangeException.html" title="class in org.apache.kafka.clients.consumer">OffsetOutOfRangeException</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">InvalidOffsetException</span> +extends <a href="../../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common">KafkaException</a></pre> +<div class="block">Thrown when the offset for a set of partitions is invalid (either undefined or out of range), + and no reset policy has been configured.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/kafka/clients/consumer/NoOffsetForPartitionException.html" title="class in org.apache.kafka.clients.consumer"><code>NoOffsetForPartitionException</code></a>, +<a href="../../../../../org/apache/kafka/clients/consumer/OffsetOutOfRangeException.html" title="class in org.apache.kafka.clients.consumer"><code>OffsetOutOfRangeException</code></a>, +<a href="../../../../../serialized-form.html#org.apache.kafka.clients.consumer.InvalidOffsetException">Serialized Form</a></dd></dl> +</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/clients/consumer/InvalidOffsetException.html#InvalidOffsetException(java.lang.String)">InvalidOffsetException</a></strong>(java.lang.String message)</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>abstract java.util.Set<<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/clients/consumer/InvalidOffsetException.html#partitions()">partitions</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="InvalidOffsetException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InvalidOffsetException</h4> +<pre>public InvalidOffsetException(java.lang.String message)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="partitions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>partitions</h4> +<pre>public abstract java.util.Set<<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions()</pre> +</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/clients/consumer/ConsumerRecords.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html" title="class in org.apache.kafka.clients.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/InvalidOffsetException.html" target="_top">Frames</a></li> +<li><a href="InvalidOffsetException.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>
