diff --git a/docs/pubsub-api.rst b/docs/pubsub-api.rst index 0782789a0574..2893879ad6ea 100644 --- a/docs/pubsub-api.rst +++ b/docs/pubsub-api.rst @@ -211,8 +211,17 @@ Fetch pending messages for a pull subscription >>> from gcloud.pubsub.subscription import Subscription >>> topic = Topic('topic_name') >>> subscription = Subscription('subscription_name', topic) - >>> [message.id for message in subscription.pull()] - [, , ...] + >>> with topic: + ... topic.publish('this is the first message_payload') + ... topic.publish('this is the second message_payload', + ... attr1='value1', attr2='value2') + >>> messages = subscription.pull() # API request + >>> [message.id for message in messages] + [, ] + >>> [message.data for message in messages] + ['this is the first message_payload', 'this is the second message_payload'] + >>> [message.attrs for message in messages] + [{}, {'attr1': 'value1', 'attr2': 'value2'}] Fetch a limited number of pending messages for a pull subscription: @@ -222,8 +231,12 @@ Fetch a limited number of pending messages for a pull subscription: >>> from gcloud.pubsub.subscription import Subscription >>> topic = Topic('topic_name') >>> subscription = Subscription('subscription_name', topic) - >>> [message.id for message in subscription.pull(max_messages=2)] - [, ] + >>> with topic: + ... topic.publish('this is the first message_payload') + ... topic.publish('this is the second message_payload', + ... attr1='value1', attr2='value2') + >>> [message.id for message in subscription.pull(max_messages=1)] + [] Fetch messages for a pull subscription without blocking (none pending):