Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 4d13713

Browse filesBrowse files
committed
Document KafkaAdmin class
1 parent f00016e commit 4d13713
Copy full SHA for 4d13713

File tree

3 files changed

+13
-0
lines changed
Filter options

3 files changed

+13
-0
lines changed

‎docs/apidoc/KafkaAdmin.rst

Copy file name to clipboard
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
KafkaAdmin
2+
===========
3+
4+
.. autoclass:: kafka.admin.KafkaAdmin
5+
:members:

‎docs/apidoc/modules.rst

Copy file name to clipboardExpand all lines: docs/apidoc/modules.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ kafka-python API
55

66
KafkaConsumer
77
KafkaProducer
8+
KafkaAdmin
89
KafkaClient
910
BrokerConnection
1011
ClusterMetadata

‎kafka/admin/kafka.py

Copy file name to clipboardExpand all lines: kafka/admin/kafka.py
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@
1818
class KafkaAdmin(object):
1919
"""An class for administering the kafka cluster.
2020
21+
Warning:
22+
This is an unstable interface that was recently added and is subject to
23+
change without warning. In particular, many methods currently return
24+
raw protocol tuples. In future releases, we plan to make these into
25+
nicer, more pythonic objects. Unfortunately, this will likely break
26+
those interfaces.
27+
2128
The KafkaAdmin class will negotiate for the latest version of each message protocol format supported
2229
by both the kafka-python client library and the kafka broker. Usage of optional fields from protocol
2330
versions that are not supported by the broker will result in UnsupportedVersionError exceptions.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.