Skip to content

docs: clarify the types of Message parameters #486

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
tseaver merged 2 commits into from
Sep 2, 2021
Merged

docs: clarify the types of Message parameters #486

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49cd669
docs: clarify the types of Message parameters
plamut Sep 2, 2021
72b1a04
Merge branch 'main' into iss-485
plamut Sep 2, 2021
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
10 changes: 6 additions & 4 deletions google/cloud/pubsub_v1/subscriber/message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,12 @@ def __init__(self, message, ack_id, delivery_attempt, request_queue):
responsibility of :class:`BasePolicy` subclasses to do so.

Args:
message (~.pubsub_v1.types.PubsubMessage): The message received
from Pub/Sub. For performance reasons it should be the the raw
protobuf message wrapped by the ``PubsubMessage`` class obtained
through the message's ``.pb()`` method.
message (`pubsub_v1.types.PubsubMessage._meta._pb`):
The message received from Pub/Sub. For performance reasons it should be
the raw protobuf message normally wrapped by
:class:`~pubsub_v1.types.PubsubMessage`. A raw message can be obtained
from a :class:`~pubsub_v1.types.PubsubMessage` instance through the
latter's ``._pb`` attribute.
ack_id (str): The ack_id received from Pub/Sub.
delivery_attempt (int): The delivery attempt counter received
from Pub/Sub if a DeadLetterPolicy is set on the subscription,
Expand Down