You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mj...@apache.org on 2021/04/12 22:17:38 UTC
[kafka] branch 2.8 updated: MINOR: Improve description of
`max.poll.records` config (#10506)
This is an automated email from the ASF dual-hosted git repository.
mjsax pushed a commit to branch 2.8
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/2.8 by this push:
new 0e9ee42 MINOR: Improve description of `max.poll.records` config (#10506)
0e9ee42 is described below
commit 0e9ee4220366d365b4c7d15fea1689ef7d27e8dd
Author: Matthias J. Sax <ma...@confluent.io>
AuthorDate: Mon Apr 12 14:02:24 2021 -0700
MINOR: Improve description of `max.poll.records` config (#10506)
Reviewers: Jason Gustafson <ja...@confluent.io>
---
.../main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
index f34e293..f7a1dff 100644
--- a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
+++ b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
@@ -66,7 +66,9 @@ public class ConsumerConfig extends AbstractConfig {
/** <code>max.poll.records</code> */
public static final String MAX_POLL_RECORDS_CONFIG = "max.poll.records";
- private static final String MAX_POLL_RECORDS_DOC = "The maximum number of records returned in a single call to poll().";
+ private static final String MAX_POLL_RECORDS_DOC = "The maximum number of records returned in a single call to poll()."
+ + " Note, that <code>" + MAX_POLL_RECORDS_CONFIG + "</code> does not impact the underlying fetching behavior."
+ + " The consumer will cache the records from each fetch request and returns them incrementally from each poll.";
/** <code>max.poll.interval.ms</code> */
public static final String MAX_POLL_INTERVAL_MS_CONFIG = CommonClientConfigs.MAX_POLL_INTERVAL_MS_CONFIG;