- class google.cloud.pubsub_v1.subscriber.message.Message(message, ack_id, delivery_attempt, request_queue)
A representation of a single Pub/Sub message.
The common way to interact with
Messageobjects is to receive them in callbacks on subscriptions; most users should never have a need to instantiate them by hand. (The exception to this is if you are implementing a custom subclass to
The message ID. In general, you should not need to use this directly.
The attributes sent along with the message. See
attributesfor more information on this type.
The time that this message was originally published.
Construct the Message.
This class should not be constructed directly; it is the responsibility of
BasePolicysubclasses to do so.
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
PubsubMessage. A raw message can be obtained from a
PubsubMessageinstance through the latter’s
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, and zero otherwise.
request_queue (queue.Queue) – A queue provided by the policy that can accept requests; the policy is responsible for handling those requests.
Acknowledge the given message.
Acknowledging a message in Pub/Sub means that you are done with it, and it will not be delivered to this subscription again. You should avoid acknowledging messages until you have finished processing them, so that in the event of a failure, you receive the message again.
Acks in Pub/Sub are best effort. You should always ensure that your processing code is idempotent, as you may receive any given message more than once.
- property ack_id
the ID used to ack the message.
- property attributes
Return the attributes of the underlying Pub/Sub Message.
ScalarMapContainerbehaves slightly differently than a
dict. For a Pub / Sub message this is a
string->stringmap. When trying to access a value via
map['key'], if the key is not in the map, then the default value for the string type will be returned, which is an empty string. It may be more intuitive to just cast the map to a
dictor to one use
The message’s attributes. This is a
dict-like object provided by
- Return type
- property data
Return the data for the underlying Pub/Sub Message.
- property delivery_attempt
The delivery attempt counter is 1 + (the sum of number of NACKs and number of ack_deadline exceeds) for this message. It is set to None if a DeadLetterPolicy is not set on the subscription.
A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.
The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate.
The delivery attempt counter or None.
- Return type
Release the message from lease management.
This informs the policy to no longer hold on to the lease for this message. Pub/Sub will re-deliver the message if it is not acknowledged before the existing lease expires.
For most use cases, the only reason to drop a message from lease management is on ack or nack; this library automatically drop()s the message on ack or nack. You probably do not want to call this method directly.
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
seconds (int) – The number of seconds to set the lease deadline to. This should be between 0 and 600. Due to network latency, values below 10 are advised against.
Decline to acknowldge the given message.
This will cause the message to be re-delivered to the subscription.
- property ordering_key
the ordering key used to publish the message.
- property publish_time
Return the time that the message was originally published.
The date and time that the message was published.
- Return type
- property size
Return the size of the underlying message, in bytes.