summaryrefslogtreecommitdiff
path: root/kafka/consumer/group.py
diff options
context:
space:
mode:
Diffstat (limited to 'kafka/consumer/group.py')
-rw-r--r--kafka/consumer/group.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index a300c83..8c2ab2d 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -161,9 +161,9 @@ class KafkaConsumer(six.Iterator):
providing a file, only the leaf certificate will be checked against
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
Default: None.
- api_version (tuple): Specify which kafka API version to use.
- If set to None, the client will attempt to infer the broker version
- by probing various APIs. Default: None
+ api_version (tuple): Specify which Kafka API version to use. If set to
+ None, the client will attempt to infer the broker version by probing
+ various APIs. Different versions enable different functionality.
Examples:
(0, 9) enables full group coordination features with automatic
partition assignment and rebalancing,
@@ -173,7 +173,8 @@ class KafkaConsumer(six.Iterator):
partition assignment only,
(0, 8, 0) enables basic functionality but requires manual
partition assignment and offset management.
- For a full list of supported versions, see KafkaClient.API_VERSIONS
+ For the full list of supported versions, see
+ KafkaClient.API_VERSIONS. Default: None
api_version_auto_timeout_ms (int): number of milliseconds to throw a
timeout exception from the constructor when checking the broker
api version. Only applies if api_version set to 'auto'