summaryrefslogtreecommitdiff
path: root/kafka
diff options
context:
space:
mode:
authorJeff Widman <jeff@jeffwidman.com>2018-10-29 00:45:40 -0700
committerJeff Widman <jeff@jeffwidman.com>2018-10-29 00:56:43 -0700
commit4d13713c515796afa535e980b15fa0c2c86ba0eb (patch)
tree757d5fc62a9dad217c5d0963f803fad7ea9e7d8d /kafka
parentf00016e7cec64cfc9697b233809cd37e0e19cc64 (diff)
downloadkafka-python-4d13713c515796afa535e980b15fa0c2c86ba0eb.tar.gz
Document KafkaAdmin class
Diffstat (limited to 'kafka')
-rw-r--r--kafka/admin/kafka.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/kafka/admin/kafka.py b/kafka/admin/kafka.py
index e78bdbf..37a80a7 100644
--- a/kafka/admin/kafka.py
+++ b/kafka/admin/kafka.py
@@ -18,6 +18,13 @@ log = logging.getLogger(__name__)
class KafkaAdmin(object):
"""An class for administering the kafka cluster.
+ Warning:
+ This is an unstable interface that was recently added and is subject to
+ change without warning. In particular, many methods currently return
+ raw protocol tuples. In future releases, we plan to make these into
+ nicer, more pythonic objects. Unfortunately, this will likely break
+ those interfaces.
+
The KafkaAdmin class will negotiate for the latest version of each message protocol format supported
by both the kafka-python client library and the kafka broker. Usage of optional fields from protocol
versions that are not supported by the broker will result in UnsupportedVersionError exceptions.