diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2018-10-29 00:45:40 -0700 |
|---|---|---|
| committer | Jeff Widman <jeff@jeffwidman.com> | 2018-10-29 00:56:43 -0700 |
| commit | 4d13713c515796afa535e980b15fa0c2c86ba0eb (patch) | |
| tree | 757d5fc62a9dad217c5d0963f803fad7ea9e7d8d | |
| parent | f00016e7cec64cfc9697b233809cd37e0e19cc64 (diff) | |
| download | kafka-python-4d13713c515796afa535e980b15fa0c2c86ba0eb.tar.gz | |
Document KafkaAdmin class
| -rw-r--r-- | docs/apidoc/KafkaAdmin.rst | 5 | ||||
| -rw-r--r-- | docs/apidoc/modules.rst | 1 | ||||
| -rw-r--r-- | kafka/admin/kafka.py | 7 |
3 files changed, 13 insertions, 0 deletions
diff --git a/docs/apidoc/KafkaAdmin.rst b/docs/apidoc/KafkaAdmin.rst new file mode 100644 index 0000000..f8c80ab --- /dev/null +++ b/docs/apidoc/KafkaAdmin.rst @@ -0,0 +1,5 @@ +KafkaAdmin +=========== + +.. autoclass:: kafka.admin.KafkaAdmin + :members: diff --git a/docs/apidoc/modules.rst b/docs/apidoc/modules.rst index 9477887..1173cfe 100644 --- a/docs/apidoc/modules.rst +++ b/docs/apidoc/modules.rst @@ -5,6 +5,7 @@ kafka-python API KafkaConsumer KafkaProducer + KafkaAdmin KafkaClient BrokerConnection ClusterMetadata 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. |