Skip to content

Commit

Permalink
docs: clarify the types of Message parameters (#486)
Browse files Browse the repository at this point in the history
  • Loading branch information
plamut authored Sep 2, 2021
1 parent 4f88810 commit 633e91b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions google/cloud/pubsub_v1/subscriber/message.py
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

0 comments on commit 633e91b

Please sign in to comment.