@@ -659,8 +659,9 @@ def list_consumer_groups(self, **kwargs):
659
659
"""
660
660
List consumer groups.
661
661
662
- :param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
663
- Default: `socket.timeout.ms*1000.0`
662
+ :param float request_timeout: The overall request timeout in seconds,
663
+ including broker lookup, request transmission, operation time
664
+ on broker, and response. Default: `socket.timeout.ms*1000.0`
664
665
:param set(ConsumerGroupState) states: only list consumer groups which are currently in
665
666
these states.
666
667
@@ -694,8 +695,9 @@ def describe_consumer_groups(self, group_ids, **kwargs):
694
695
Describe consumer groups.
695
696
696
697
:param list(str) group_ids: List of group_ids which need to be described.
697
- :param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
698
- Default: `socket.timeout.ms*1000.0`
698
+ :param float request_timeout: The overall request timeout in seconds,
699
+ including broker lookup, request transmission, operation time
700
+ on broker, and response. Default: `socket.timeout.ms*1000.0`
699
701
700
702
:returns: A dict of futures for each group, keyed by the group_id.
701
703
The future result() method returns :class:`ConsumerGroupDescription`.
@@ -725,8 +727,9 @@ def delete_consumer_groups(self, group_ids, **kwargs):
725
727
Delete the given consumer groups.
726
728
727
729
:param list(str) group_ids: List of group_ids which need to be deleted.
728
- :param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
729
- Default: `socket.timeout.ms*1000.0`
730
+ :param float request_timeout: The overall request timeout in seconds,
731
+ including broker lookup, request transmission, operation time
732
+ on broker, and response. Default: `socket.timeout.ms*1000.0`
730
733
731
734
:returns: A dict of futures for each group, keyed by the group_id.
732
735
The future result() method returns None.
0 commit comments