summaryrefslogtreecommitdiff
path: root/kafka/consumer/group.py
diff options
context:
space:
mode:
authorDana Powers <dana.powers@rd.io>2015-12-30 12:51:34 -0800
committerDana Powers <dana.powers@rd.io>2015-12-30 12:51:34 -0800
commite093ffefaecb59c26f2e480214f72a03ba5a49fc (patch)
tree88b4bd434b29a751b7e0adebbe4e7514a4c7e844 /kafka/consumer/group.py
parent1dd9e8bb05b6efc2888ac4cae8e7199b35dd633f (diff)
downloadkafka-python-e093ffefaecb59c26f2e480214f72a03ba5a49fc.tar.gz
More Docstring Improvements
Diffstat (limited to 'kafka/consumer/group.py')
-rw-r--r--kafka/consumer/group.py10
1 files changed, 9 insertions, 1 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index 00955f8..14485d2 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -114,6 +114,10 @@ class KafkaConsumer(object):
periodically committed in the background. Default: True.
auto_commit_interval_ms (int): milliseconds between automatic
offset commits, if enable_auto_commit is True. Default: 5000.
+ default_offset_commit_callback (callable): called as
+ callback(offsets, response) response will be either an Exception
+ or a OffsetCommitResponse struct. This callback can be used to
+ trigger custom actions when a commit request completes.
check_crcs (bool): Automatically check the CRC32 of the records
consumed. This ensures no on-the-wire or on-disk corruption to
the messages occurred. This check adds some overhead, so it may
@@ -438,13 +442,17 @@ class KafkaConsumer(object):
self._subscription.resume(partition)
def seek(self, partition, offset):
- """Manually specify the fetch offset for a TopicPartition
+ """Manually specify the fetch offset for a TopicPartition.
Overrides the fetch offsets that the consumer will use on the next
poll(). If this API is invoked for the same partition more than once,
the latest offset will be used on the next poll(). Note that you may
lose data if this API is arbitrarily used in the middle of consumption,
to reset the fetch offsets.
+
+ Arguments:
+ partition (TopicPartition): partition for seek operation
+ offset (int): message offset in partition
"""
if offset < 0:
raise Errors.IllegalStateError("seek offset must not be a negative number")