Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

docs: explain how to nack a sync pull message #123

Merged
pradn merged 2 commits into from
Jun 18, 2020
Merged

docs: explain how to nack a sync pull message #123

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c83e18
docs: explain how to nack a sync pull message
plamut Jun 15, 2020
6639e8e
Improve wording
plamut Jun 18, 2020
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
15 changes: 14 additions & 1 deletion docs/subscriber/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,20 @@ To pull the messages synchronously, use the client's
subscriber.acknowledge(subscription_path, ack_ids)

The method returns a :class:`~.pubsub_v1.types.PullResponse` instance that
cointains a list of received :class:`~.pubsub_v1.types.ReceivedMessage`
contains a list of received :class:`~.pubsub_v1.types.ReceivedMessage`
instances.

If you want to **nack** some of the received messages (see :ref:`explaining-ack` below),
you can use the :meth:`~.pubsub_v1.subscriber.client.Client.modify_ack_deadline`
method and set their acknowledge deadlines to zero. This will cause them to
be dropped by this client and the backend will try to re-deliver them.

.. code-block:: python

ack_ids = [] # TODO: populate with `ack_ids` of the messages to NACK
ack_deadline_seconds = 0
subscriber.modify_ack_deadline(subscription_path, ack_ids, ack_deadline_seconds)


Pulling a Subscription Asynchronously
-------------------------------------
Expand Down Expand Up @@ -159,6 +170,8 @@ receiving messages.
future.cancel()


.. _explaining-ack:

Explaining Ack
--------------

Expand Down