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.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index 4b46e04..b3e182c 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -229,13 +229,13 @@ class KafkaConsumer(six.Iterator):
(such as offsets) should be exposed to the consumer. If set to True
the only way to receive records from an internal topic is
subscribing to it. Requires 0.10+ Default: True
- sasl_mechanism (str): String picking sasl mechanism when security_protocol
- is SASL_PLAINTEXT or SASL_SSL. Currently only PLAIN is supported.
- Default: None
+ sasl_mechanism (str): Authentication mechanism when security_protocol
+ is configured for SASL_PLAINTEXT or SASL_SSL. Valid values are:
+ PLAIN, GSSAPI, OAUTHBEARER.
sasl_plain_username (str): Username for sasl PLAIN authentication.
- Default: None
+ Required if sasl_mechanism is PLAIN.
sasl_plain_password (str): Password for sasl PLAIN authentication.
- Default: None
+ Required if sasl_mechanism is PLAIN.
sasl_kerberos_service_name (str): Service name to include in GSSAPI
sasl mechanism handshake. Default: 'kafka'
sasl_kerberos_domain_name (str): kerberos domain name to use in GSSAPI