Skip to content

Removed incorrect infinite timeout value from request timeout doc in Admin APIs #1554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 20, 2023
Merged

Removed incorrect infinite timeout value from request timeout doc in Admin APIs #1554

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d4e323
Removed incorrect infinite timeout value from request timeout doc in …
pranavrth Apr 17, 2023
73a8875
Merge branch 'master' into dev_infinite-request-timeout
pranavrth Apr 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Confluent's Python client for Apache Kafka

## v2.1.1

v2.1.1 is a maintenance release with the following fixes and enhancements:

* Fix some Admin API documentation stating -1 for infinte timeout incorrectly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spelling of infinite

Request timeout can't be infinite.


## v2.1.0

v2.1.0 is a feature release with the following features, fixes and enhancements:
Expand Down
15 changes: 9 additions & 6 deletions src/confluent_kafka/admin/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,8 +629,9 @@ def list_consumer_groups(self, **kwargs):
"""
List consumer groups.

:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
Default: `socket.timeout.ms*1000.0`
:param float request_timeout: The overall request timeout in seconds,
including broker lookup, request transmission, operation time
on broker, and response. Default: `socket.timeout.ms*1000.0`
:param set(ConsumerGroupState) states: only list consumer groups which are currently in
these states.

Expand Down Expand Up @@ -664,8 +665,9 @@ def describe_consumer_groups(self, group_ids, **kwargs):
Describe consumer groups.

:param list(str) group_ids: List of group_ids which need to be described.
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
Default: `socket.timeout.ms*1000.0`
:param float request_timeout: The overall request timeout in seconds,
including broker lookup, request transmission, operation time
on broker, and response. Default: `socket.timeout.ms*1000.0`

:returns: A dict of futures for each group, keyed by the group_id.
The future result() method returns :class:`ConsumerGroupDescription`.
Expand Down Expand Up @@ -695,8 +697,9 @@ def delete_consumer_groups(self, group_ids, **kwargs):
Delete the given consumer groups.

:param list(str) group_ids: List of group_ids which need to be deleted.
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
Default: `socket.timeout.ms*1000.0`
:param float request_timeout: The overall request timeout in seconds,
including broker lookup, request transmission, operation time
on broker, and response. Default: `socket.timeout.ms*1000.0`

:returns: A dict of futures for each group, keyed by the group_id.
The future result() method returns None.
Expand Down