Skip to content

clarify that modify_ack_deadline resets the deadline #4822

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
theacodes merged 2 commits into from
Feb 5, 2018
Merged

clarify that modify_ack_deadline resets the deadline #4822

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9eb4939
clarify that modify_ack_deadline resets the deadline to the number of…
opyate Feb 1, 2018
4af7296
Tweak to ensure single-line summary.
tseaver Feb 2, 2018
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
9 changes: 3 additions & 6 deletions pubsub/google/cloud/pubsub_v1/subscriber/message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,18 +223,15 @@ def lease(self):
)

def modify_ack_deadline(self, seconds):
"""Set the deadline for acknowledgement to the given value.
"""Resets the deadline for acknowledgement.

New deadline will be the given value of seconds from now.

The default implementation handles this for you; you should not need
to manually deal with setting ack deadlines. The exception case is
if you are implementing your own custom subclass of
:class:`~.pubsub_v1.subcriber._consumer.Consumer`.

.. note::
This is not an extension; it *sets* the deadline to the given
number of seconds from right now. It is even possible to use this
method to make a deadline shorter.

Args:
seconds (int): The number of seconds to set the lease deadline
to. This should be between 0 and 600. Due to network latency,
Expand Down