http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/clients/consumer/ConsumerConfig.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/clients/consumer/ConsumerConfig.html b/10/javadoc/org/apache/kafka/clients/consumer/ConsumerConfig.html new file mode 100644 index 0000000..5818a97 --- /dev/null +++ b/10/javadoc/org/apache/kafka/clients/consumer/ConsumerConfig.html @@ -0,0 +1,1153 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:41 GMT 2017 --> +<title>ConsumerConfig (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConsumerConfig (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<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/Consumer.html" title="interface in org.apache.kafka.clients.consumer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="interface in org.apache.kafka.clients.consumer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerConfig.html" target="_top">Frames</a></li> +<li><a href="ConsumerConfig.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>Constr | </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>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="Class ConsumerConfig" class="title">Class ConsumerConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">org.apache.kafka.common.config.AbstractConfig</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.consumer.ConsumerConfig</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ConsumerConfig</span> +extends <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></pre> +<div class="block">The consumer configuration keys</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#AUTO_COMMIT_INTERVAL_MS_CONFIG">AUTO_COMMIT_INTERVAL_MS_CONFIG</a></span></code> +<div class="block"><code>auto.commit.interval.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#AUTO_OFFSET_RESET_CONFIG">AUTO_OFFSET_RESET_CONFIG</a></span></code> +<div class="block"><code>auto.offset.reset</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#AUTO_OFFSET_RESET_DOC">AUTO_OFFSET_RESET_DOC</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#BOOTSTRAP_SERVERS_CONFIG">BOOTSTRAP_SERVERS_CONFIG</a></span></code> +<div class="block"><code>bootstrap.servers</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#CHECK_CRCS_CONFIG">CHECK_CRCS_CONFIG</a></span></code> +<div class="block"><code>check.crcs</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#CLIENT_ID_CONFIG">CLIENT_ID_CONFIG</a></span></code> +<div class="block"><code>client.id</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#CONNECTIONS_MAX_IDLE_MS_CONFIG">CONNECTIONS_MAX_IDLE_MS_CONFIG</a></span></code> +<div class="block"><code>connections.max.idle.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#DEFAULT_EXCLUDE_INTERNAL_TOPICS">DEFAULT_EXCLUDE_INTERNAL_TOPICS</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#DEFAULT_FETCH_MAX_BYTES">DEFAULT_FETCH_MAX_BYTES</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#DEFAULT_ISOLATION_LEVEL">DEFAULT_ISOLATION_LEVEL</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#DEFAULT_MAX_PARTITION_FETCH_BYTES">DEFAULT_MAX_PARTITION_FETCH_BYTES</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#ENABLE_AUTO_COMMIT_CONFIG">ENABLE_AUTO_COMMIT_CONFIG</a></span></code> +<div class="block"><code>enable.auto.commit</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#EXCLUDE_INTERNAL_TOPICS_CONFIG">EXCLUDE_INTERNAL_TOPICS_CONFIG</a></span></code> +<div class="block"><code>exclude.internal.topics</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#FETCH_MAX_BYTES_CONFIG">FETCH_MAX_BYTES_CONFIG</a></span></code> +<div class="block"><code>fetch.max.bytes</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#FETCH_MAX_WAIT_MS_CONFIG">FETCH_MAX_WAIT_MS_CONFIG</a></span></code> +<div class="block"><code>fetch.max.wait.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#FETCH_MIN_BYTES_CONFIG">FETCH_MIN_BYTES_CONFIG</a></span></code> +<div class="block"><code>fetch.min.bytes</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#GROUP_ID_CONFIG">GROUP_ID_CONFIG</a></span></code> +<div class="block"><code>group.id</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#HEARTBEAT_INTERVAL_MS_CONFIG">HEARTBEAT_INTERVAL_MS_CONFIG</a></span></code> +<div class="block"><code>heartbeat.interval.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#INTERCEPTOR_CLASSES_CONFIG">INTERCEPTOR_CLASSES_CONFIG</a></span></code> +<div class="block"><code>interceptor.classes</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#INTERCEPTOR_CLASSES_DOC">INTERCEPTOR_CLASSES_DOC</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#ISOLATION_LEVEL_CONFIG">ISOLATION_LEVEL_CONFIG</a></span></code> +<div class="block"><code>isolation.level</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#ISOLATION_LEVEL_DOC">ISOLATION_LEVEL_DOC</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#KEY_DESERIALIZER_CLASS_CONFIG">KEY_DESERIALIZER_CLASS_CONFIG</a></span></code> +<div class="block"><code>key.deserializer</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#KEY_DESERIALIZER_CLASS_DOC">KEY_DESERIALIZER_CLASS_DOC</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#MAX_PARTITION_FETCH_BYTES_CONFIG">MAX_PARTITION_FETCH_BYTES_CONFIG</a></span></code> +<div class="block"><code>max.partition.fetch.bytes</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#MAX_POLL_INTERVAL_MS_CONFIG">MAX_POLL_INTERVAL_MS_CONFIG</a></span></code> +<div class="block"><code>max.poll.interval.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#MAX_POLL_RECORDS_CONFIG">MAX_POLL_RECORDS_CONFIG</a></span></code> +<div class="block"><code>max.poll.records</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#METADATA_MAX_AGE_CONFIG">METADATA_MAX_AGE_CONFIG</a></span></code> +<div class="block"><code>metadata.max.age.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#METRIC_REPORTER_CLASSES_CONFIG">METRIC_REPORTER_CLASSES_CONFIG</a></span></code> +<div class="block"><code>metric.reporters</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#METRICS_NUM_SAMPLES_CONFIG">METRICS_NUM_SAMPLES_CONFIG</a></span></code> +<div class="block"><code>metrics.num.samples</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#METRICS_RECORDING_LEVEL_CONFIG">METRICS_RECORDING_LEVEL_CONFIG</a></span></code> +<div class="block"><code>metrics.log.level</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#METRICS_SAMPLE_WINDOW_MS_CONFIG">METRICS_SAMPLE_WINDOW_MS_CONFIG</a></span></code> +<div class="block"><code>metrics.sample.window.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#PARTITION_ASSIGNMENT_STRATEGY_CONFIG">PARTITION_ASSIGNMENT_STRATEGY_CONFIG</a></span></code> +<div class="block"><code>partition.assignment.strategy</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#RECEIVE_BUFFER_CONFIG">RECEIVE_BUFFER_CONFIG</a></span></code> +<div class="block"><code>receive.buffer.bytes</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#RECONNECT_BACKOFF_MAX_MS_CONFIG">RECONNECT_BACKOFF_MAX_MS_CONFIG</a></span></code> +<div class="block"><code>reconnect.backoff.max.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#RECONNECT_BACKOFF_MS_CONFIG">RECONNECT_BACKOFF_MS_CONFIG</a></span></code> +<div class="block"><code>reconnect.backoff.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#REQUEST_TIMEOUT_MS_CONFIG">REQUEST_TIMEOUT_MS_CONFIG</a></span></code> +<div class="block"><code>request.timeout.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#RETRY_BACKOFF_MS_CONFIG">RETRY_BACKOFF_MS_CONFIG</a></span></code> +<div class="block"><code>retry.backoff.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#SEND_BUFFER_CONFIG">SEND_BUFFER_CONFIG</a></span></code> +<div class="block"><code>send.buffer.bytes</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#SESSION_TIMEOUT_MS_CONFIG">SESSION_TIMEOUT_MS_CONFIG</a></span></code> +<div class="block"><code>session.timeout.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#VALUE_DESERIALIZER_CLASS_CONFIG">VALUE_DESERIALIZER_CLASS_CONFIG</a></span></code> +<div class="block"><code>value.deserializer</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#VALUE_DESERIALIZER_CLASS_DOC">VALUE_DESERIALIZER_CLASS_DOC</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#addDeserializerToConfig-java.util.Map-org.apache.kafka.common.serialization.Deserializer-org.apache.kafka.common.serialization.Deserializer-">addDeserializerToConfig</a></span>(java.util.Map<java.lang.String,java.lang.Object> configs, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> keyDeserializer, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> valueDeserializer)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static java.util.Properties</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#addDeserializerToConfig-java.util.Properties-org.apache.kafka.common.serialization.Deserializer-org.apache.kafka.common.serialization.Deserializer-">addDeserializerToConfig</a></span>(java.util.Properties properties, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> keyDeserializer, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> valueDeserializer)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#configNames--">configNames</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html#postProcessParsedConfig-java.util.Map-">postProcessParsedConfig</a></span>(java.util.Map<java.lang.String,java.lang.Object> parsedValues)</code> +<div class="block">Called directly after user configs got parsed (and thus default values got set).</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.kafka.common.config.AbstractConfig"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.common.config.<a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></h3> +<code><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#get-java.lang.String-">get</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getBoolean-java.lang.String-">getBoolean</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getClass-java.lang.String-">getClass</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstance-java.lang.String-java.lang.Class-">getConfiguredInstance</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstances-java.lang.String-java.lang.Class-">getConfiguredInstances</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstances-java.lang.String-java.lang.Class-java.util.Map-">getConfiguredInstances</a>, <a href="../../../../../org/apache/kaf ka/common/config/AbstractConfig.html#getDouble-java.lang.String-">getDouble</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getInt-java.lang.String-">getInt</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getList-java.lang.String-">getList</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getLong-java.lang.String-">getLong</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getPassword-java.lang.String-">getPassword</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getShort-java.lang.String-">getShort</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getString-java.lang.String-">getString</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#ignore-java.lang.String-">ignore</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#logUnused--">logUnused</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originals--">originals</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsStrings--">originalsStrings</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsWithPrefix-java.lang.String-">originalsWithPrefix</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#typeOf-java.lang.String-">typeOf</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#unused--">unused</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#values--">values</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#valuesWithPrefixOverride-java.lang.String-">valuesWithPrefixOverride</a></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, finalize, getClass, 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="GROUP_ID_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GROUP_ID_CONFIG</h4> +<pre>public static final java.lang.String GROUP_ID_CONFIG</pre> +<div class="block"><code>group.id</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.GROUP_ID_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="MAX_POLL_RECORDS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_POLL_RECORDS_CONFIG</h4> +<pre>public static final java.lang.String MAX_POLL_RECORDS_CONFIG</pre> +<div class="block"><code>max.poll.records</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.MAX_POLL_RECORDS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="MAX_POLL_INTERVAL_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_POLL_INTERVAL_MS_CONFIG</h4> +<pre>public static final java.lang.String MAX_POLL_INTERVAL_MS_CONFIG</pre> +<div class="block"><code>max.poll.interval.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.MAX_POLL_INTERVAL_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SESSION_TIMEOUT_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SESSION_TIMEOUT_MS_CONFIG</h4> +<pre>public static final java.lang.String SESSION_TIMEOUT_MS_CONFIG</pre> +<div class="block"><code>session.timeout.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HEARTBEAT_INTERVAL_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HEARTBEAT_INTERVAL_MS_CONFIG</h4> +<pre>public static final java.lang.String HEARTBEAT_INTERVAL_MS_CONFIG</pre> +<div class="block"><code>heartbeat.interval.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.HEARTBEAT_INTERVAL_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="BOOTSTRAP_SERVERS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BOOTSTRAP_SERVERS_CONFIG</h4> +<pre>public static final java.lang.String BOOTSTRAP_SERVERS_CONFIG</pre> +<div class="block"><code>bootstrap.servers</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ENABLE_AUTO_COMMIT_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ENABLE_AUTO_COMMIT_CONFIG</h4> +<pre>public static final java.lang.String ENABLE_AUTO_COMMIT_CONFIG</pre> +<div class="block"><code>enable.auto.commit</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="AUTO_COMMIT_INTERVAL_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AUTO_COMMIT_INTERVAL_MS_CONFIG</h4> +<pre>public static final java.lang.String AUTO_COMMIT_INTERVAL_MS_CONFIG</pre> +<div class="block"><code>auto.commit.interval.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="PARTITION_ASSIGNMENT_STRATEGY_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PARTITION_ASSIGNMENT_STRATEGY_CONFIG</h4> +<pre>public static final java.lang.String PARTITION_ASSIGNMENT_STRATEGY_CONFIG</pre> +<div class="block"><code>partition.assignment.strategy</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.PARTITION_ASSIGNMENT_STRATEGY_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="AUTO_OFFSET_RESET_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AUTO_OFFSET_RESET_CONFIG</h4> +<pre>public static final java.lang.String AUTO_OFFSET_RESET_CONFIG</pre> +<div class="block"><code>auto.offset.reset</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.AUTO_OFFSET_RESET_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="AUTO_OFFSET_RESET_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AUTO_OFFSET_RESET_DOC</h4> +<pre>public static final java.lang.String AUTO_OFFSET_RESET_DOC</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.AUTO_OFFSET_RESET_DOC">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="FETCH_MIN_BYTES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FETCH_MIN_BYTES_CONFIG</h4> +<pre>public static final java.lang.String FETCH_MIN_BYTES_CONFIG</pre> +<div class="block"><code>fetch.min.bytes</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.FETCH_MIN_BYTES_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="FETCH_MAX_BYTES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FETCH_MAX_BYTES_CONFIG</h4> +<pre>public static final java.lang.String FETCH_MAX_BYTES_CONFIG</pre> +<div class="block"><code>fetch.max.bytes</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.FETCH_MAX_BYTES_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_FETCH_MAX_BYTES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_FETCH_MAX_BYTES</h4> +<pre>public static final int DEFAULT_FETCH_MAX_BYTES</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.DEFAULT_FETCH_MAX_BYTES">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="FETCH_MAX_WAIT_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FETCH_MAX_WAIT_MS_CONFIG</h4> +<pre>public static final java.lang.String FETCH_MAX_WAIT_MS_CONFIG</pre> +<div class="block"><code>fetch.max.wait.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.FETCH_MAX_WAIT_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="METADATA_MAX_AGE_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METADATA_MAX_AGE_CONFIG</h4> +<pre>public static final java.lang.String METADATA_MAX_AGE_CONFIG</pre> +<div class="block"><code>metadata.max.age.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.METADATA_MAX_AGE_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="MAX_PARTITION_FETCH_BYTES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_PARTITION_FETCH_BYTES_CONFIG</h4> +<pre>public static final java.lang.String MAX_PARTITION_FETCH_BYTES_CONFIG</pre> +<div class="block"><code>max.partition.fetch.bytes</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.MAX_PARTITION_FETCH_BYTES_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_MAX_PARTITION_FETCH_BYTES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_MAX_PARTITION_FETCH_BYTES</h4> +<pre>public static final int DEFAULT_MAX_PARTITION_FETCH_BYTES</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.DEFAULT_MAX_PARTITION_FETCH_BYTES">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SEND_BUFFER_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SEND_BUFFER_CONFIG</h4> +<pre>public static final java.lang.String SEND_BUFFER_CONFIG</pre> +<div class="block"><code>send.buffer.bytes</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.SEND_BUFFER_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="RECEIVE_BUFFER_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RECEIVE_BUFFER_CONFIG</h4> +<pre>public static final java.lang.String RECEIVE_BUFFER_CONFIG</pre> +<div class="block"><code>receive.buffer.bytes</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.RECEIVE_BUFFER_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CLIENT_ID_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLIENT_ID_CONFIG</h4> +<pre>public static final java.lang.String CLIENT_ID_CONFIG</pre> +<div class="block"><code>client.id</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.CLIENT_ID_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="RECONNECT_BACKOFF_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RECONNECT_BACKOFF_MS_CONFIG</h4> +<pre>public static final java.lang.String RECONNECT_BACKOFF_MS_CONFIG</pre> +<div class="block"><code>reconnect.backoff.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.RECONNECT_BACKOFF_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="RECONNECT_BACKOFF_MAX_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RECONNECT_BACKOFF_MAX_MS_CONFIG</h4> +<pre>public static final java.lang.String RECONNECT_BACKOFF_MAX_MS_CONFIG</pre> +<div class="block"><code>reconnect.backoff.max.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.RECONNECT_BACKOFF_MAX_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="RETRY_BACKOFF_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RETRY_BACKOFF_MS_CONFIG</h4> +<pre>public static final java.lang.String RETRY_BACKOFF_MS_CONFIG</pre> +<div class="block"><code>retry.backoff.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.RETRY_BACKOFF_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="METRICS_SAMPLE_WINDOW_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRICS_SAMPLE_WINDOW_MS_CONFIG</h4> +<pre>public static final java.lang.String METRICS_SAMPLE_WINDOW_MS_CONFIG</pre> +<div class="block"><code>metrics.sample.window.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.METRICS_SAMPLE_WINDOW_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="METRICS_NUM_SAMPLES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRICS_NUM_SAMPLES_CONFIG</h4> +<pre>public static final java.lang.String METRICS_NUM_SAMPLES_CONFIG</pre> +<div class="block"><code>metrics.num.samples</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.METRICS_NUM_SAMPLES_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="METRICS_RECORDING_LEVEL_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRICS_RECORDING_LEVEL_CONFIG</h4> +<pre>public static final java.lang.String METRICS_RECORDING_LEVEL_CONFIG</pre> +<div class="block"><code>metrics.log.level</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.METRICS_RECORDING_LEVEL_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="METRIC_REPORTER_CLASSES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRIC_REPORTER_CLASSES_CONFIG</h4> +<pre>public static final java.lang.String METRIC_REPORTER_CLASSES_CONFIG</pre> +<div class="block"><code>metric.reporters</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.METRIC_REPORTER_CLASSES_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CHECK_CRCS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_CRCS_CONFIG</h4> +<pre>public static final java.lang.String CHECK_CRCS_CONFIG</pre> +<div class="block"><code>check.crcs</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.CHECK_CRCS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="KEY_DESERIALIZER_CLASS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEY_DESERIALIZER_CLASS_CONFIG</h4> +<pre>public static final java.lang.String KEY_DESERIALIZER_CLASS_CONFIG</pre> +<div class="block"><code>key.deserializer</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="KEY_DESERIALIZER_CLASS_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEY_DESERIALIZER_CLASS_DOC</h4> +<pre>public static final java.lang.String KEY_DESERIALIZER_CLASS_DOC</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.KEY_DESERIALIZER_CLASS_DOC">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="VALUE_DESERIALIZER_CLASS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALUE_DESERIALIZER_CLASS_CONFIG</h4> +<pre>public static final java.lang.String VALUE_DESERIALIZER_CLASS_CONFIG</pre> +<div class="block"><code>value.deserializer</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="VALUE_DESERIALIZER_CLASS_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALUE_DESERIALIZER_CLASS_DOC</h4> +<pre>public static final java.lang.String VALUE_DESERIALIZER_CLASS_DOC</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.VALUE_DESERIALIZER_CLASS_DOC">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONNECTIONS_MAX_IDLE_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONNECTIONS_MAX_IDLE_MS_CONFIG</h4> +<pre>public static final java.lang.String CONNECTIONS_MAX_IDLE_MS_CONFIG</pre> +<div class="block"><code>connections.max.idle.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.CONNECTIONS_MAX_IDLE_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="REQUEST_TIMEOUT_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REQUEST_TIMEOUT_MS_CONFIG</h4> +<pre>public static final java.lang.String REQUEST_TIMEOUT_MS_CONFIG</pre> +<div class="block"><code>request.timeout.ms</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.REQUEST_TIMEOUT_MS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="INTERCEPTOR_CLASSES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INTERCEPTOR_CLASSES_CONFIG</h4> +<pre>public static final java.lang.String INTERCEPTOR_CLASSES_CONFIG</pre> +<div class="block"><code>interceptor.classes</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.INTERCEPTOR_CLASSES_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="INTERCEPTOR_CLASSES_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INTERCEPTOR_CLASSES_DOC</h4> +<pre>public static final java.lang.String INTERCEPTOR_CLASSES_DOC</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.INTERCEPTOR_CLASSES_DOC">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="EXCLUDE_INTERNAL_TOPICS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXCLUDE_INTERNAL_TOPICS_CONFIG</h4> +<pre>public static final java.lang.String EXCLUDE_INTERNAL_TOPICS_CONFIG</pre> +<div class="block"><code>exclude.internal.topics</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.EXCLUDE_INTERNAL_TOPICS_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_EXCLUDE_INTERNAL_TOPICS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_EXCLUDE_INTERNAL_TOPICS</h4> +<pre>public static final boolean DEFAULT_EXCLUDE_INTERNAL_TOPICS</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.DEFAULT_EXCLUDE_INTERNAL_TOPICS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ISOLATION_LEVEL_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ISOLATION_LEVEL_CONFIG</h4> +<pre>public static final java.lang.String ISOLATION_LEVEL_CONFIG</pre> +<div class="block"><code>isolation.level</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.ISOLATION_LEVEL_CONFIG">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ISOLATION_LEVEL_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ISOLATION_LEVEL_DOC</h4> +<pre>public static final java.lang.String ISOLATION_LEVEL_DOC</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.consumer.ConsumerConfig.ISOLATION_LEVEL_DOC">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_ISOLATION_LEVEL"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_ISOLATION_LEVEL</h4> +<pre>public static final java.lang.String DEFAULT_ISOLATION_LEVEL</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="postProcessParsedConfig-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>postProcessParsedConfig</h4> +<pre>protected java.util.Map<java.lang.String,java.lang.Object> postProcessParsedConfig(java.util.Map<java.lang.String,java.lang.Object> parsedValues)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#postProcessParsedConfig-java.util.Map-">AbstractConfig</a></code></span></div> +<div class="block">Called directly after user configs got parsed (and thus default values got set). + This allows to change default values for "secondary defaults" if required.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#postProcessParsedConfig-java.util.Map-">postProcessParsedConfig</a></code> in class <code><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parsedValues</code> - unmodifiable map of current configuration</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a map of updates that should be applied to the configuration (will be validated to prevent bad updates)</dd> +</dl> +</li> +</ul> +<a name="addDeserializerToConfig-java.util.Map-org.apache.kafka.common.serialization.Deserializer-org.apache.kafka.common.serialization.Deserializer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDeserializerToConfig</h4> +<pre>public static java.util.Map<java.lang.String,java.lang.Object> addDeserializerToConfig(java.util.Map<java.lang.String,java.lang.Object> configs, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> keyDeserializer, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> valueDeserializer)</pre> +</li> +</ul> +<a name="addDeserializerToConfig-java.util.Properties-org.apache.kafka.common.serialization.Deserializer-org.apache.kafka.common.serialization.Deserializer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDeserializerToConfig</h4> +<pre>public static java.util.Properties addDeserializerToConfig(java.util.Properties properties, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> keyDeserializer, + <a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><?> valueDeserializer)</pre> +</li> +</ul> +<a name="configNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>configNames</h4> +<pre>public static java.util.Set<java.lang.String> configNames()</pre> +</li> +</ul> +<a name="main-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args)</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<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/Consumer.html" title="interface in org.apache.kafka.clients.consumer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="interface in org.apache.kafka.clients.consumer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/consumer/ConsumerConfig.html" target="_top">Frames</a></li> +<li><a href="ConsumerConfig.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>Constr | </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>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/2e200cfc/10/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html b/10/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html new file mode 100644 index 0000000..111b19c --- /dev/null +++ b/10/javadoc/org/apache/kafka/clients/consumer/ConsumerInterceptor.html @@ -0,0 +1,309 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:41 GMT 2017 --> +<title>ConsumerInterceptor (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConsumerInterceptor (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<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="typeNameLink">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="typeNameLink">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="typeNameLabel">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>. + <p> + Implement <a href="../../../../../org/apache/kafka/common/ClusterResourceListener.html" title="interface in org.apache.kafka.common"><code>ClusterResourceListener</code></a> to receive cluster metadata once it's available. Please see the class documentation for ClusterResourceListener for more information.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html#close--">close</a></span>()</code> +<div class="block">This is called when interceptor is closed</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html#onCommit-java.util.Map-">onCommit</a></span>(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 id="i2" 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><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html#onConsume-org.apache.kafka.clients.consumer.ConsumerRecords-">onConsume</a></span>(<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="paramLabel">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="returnLabel">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="paramLabel">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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<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="typeNameLink">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="typeNameLink">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>
