A message that is published by publishers and consumed by
subscribers. The message must contain either a non-empty data field
or at least one attribute. Note that client libraries represent this
object differently depending on the language. See the corresponding
client library
documentation <https://cloud.google.com/pubsub/docs/reference/libraries>__
for more information. See quotas and limits for more information about
message limits.
Attributes
Name
Description
data
:noindex:
bytes
Optional. The message data field. If this
field is empty, the message must contain at
least one attribute.
attributes
:noindex:
MutableMapping[str, str]
Optional. Attributes for this message. If
this field is empty, the message must contain
non-empty data. This can be used to filter
messages on the subscription.
message_id
:noindex:
str
ID of this message, assigned by the server when the message
is published. Guaranteed to be unique within the topic. This
value may be read by a subscriber that receives a
PubsubMessage via a Pull call or a push delivery. It
must not be populated by the publisher in a Publish
call.
publish_time
:noindex:
google.protobuf.timestamp_pb2.Timestamp
The time at which the message was published, populated by
the server when it receives the Publish call. It must
not be populated by the publisher in a Publish call.
ordering_key
:noindex:
str
Optional. If non-empty, identifies related messages for
which publish order should be respected. If a
Subscription has enable_message_ordering set to
true, messages published with the same non-empty
ordering_key value will be delivered to subscribers in
the order in which they are received by the Pub/Sub system.
All PubsubMessage\ s published in a given
PublishRequest must specify the same ordering_key
value. For more information, see `ordering
messages
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class PubsubMessage (2.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.0 (latest)](/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.30.0](/python/docs/reference/pubsub/2.30.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.29.1](/python/docs/reference/pubsub/2.29.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.28.0](/python/docs/reference/pubsub/2.28.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.27.3](/python/docs/reference/pubsub/2.27.3/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.26.1](/python/docs/reference/pubsub/2.26.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.25.2](/python/docs/reference/pubsub/2.25.2/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.23.1](/python/docs/reference/pubsub/2.23.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.22.0](/python/docs/reference/pubsub/2.22.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.21.5](/python/docs/reference/pubsub/2.21.5/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.20.3](/python/docs/reference/pubsub/2.20.3/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.19.8](/python/docs/reference/pubsub/2.19.8/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.18.4](/python/docs/reference/pubsub/2.18.4/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.17.1](/python/docs/reference/pubsub/2.17.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.16.1](/python/docs/reference/pubsub/2.16.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.15.2](/python/docs/reference/pubsub/2.15.2/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.14.1](/python/docs/reference/pubsub/2.14.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.13.12](/python/docs/reference/pubsub/2.13.12/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.12.1](/python/docs/reference/pubsub/2.12.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.11.1](/python/docs/reference/pubsub/2.11.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.10.0](/python/docs/reference/pubsub/2.10.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.9.0](/python/docs/reference/pubsub/2.9.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.8.0](/python/docs/reference/pubsub/2.8.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.7.1](/python/docs/reference/pubsub/2.7.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.6.1](/python/docs/reference/pubsub/2.6.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.5.0](/python/docs/reference/pubsub/2.5.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.4.2](/python/docs/reference/pubsub/2.4.2/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.3.0](/python/docs/reference/pubsub/2.3.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.2.0](/python/docs/reference/pubsub/2.2.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.1.0](/python/docs/reference/pubsub/2.1.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [2.0.0](/python/docs/reference/pubsub/2.0.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.7.2](/python/docs/reference/pubsub/1.7.2/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.6.1](/python/docs/reference/pubsub/1.6.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.5.0](/python/docs/reference/pubsub/1.5.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.4.3](/python/docs/reference/pubsub/1.4.3/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.3.1](/python/docs/reference/pubsub/1.3.1/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.2.0](/python/docs/reference/pubsub/1.2.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.1.0](/python/docs/reference/pubsub/1.1.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [1.0.2](/python/docs/reference/pubsub/1.0.2/google.cloud.pubsub_v1.types.PubsubMessage)\n- [0.45.0](/python/docs/reference/pubsub/0.45.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [0.44.0](/python/docs/reference/pubsub/0.44.0/google.cloud.pubsub_v1.types.PubsubMessage)\n- [0.43.0](/python/docs/reference/pubsub/0.43.0/google.cloud.pubsub_v1.types.PubsubMessage) \n\n PubsubMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA message that is published by publishers and consumed by\nsubscribers. The message must contain either a non-empty data field\nor at least one attribute. Note that client libraries represent this\nobject differently depending on the language. See the corresponding\n`client library\ndocumentation \u003chttps://cloud.google.com/pubsub/docs/reference/libraries\u003e`__\nfor more information. See [quotas and limits](https://cloud.google.com/pubsub/quotas) for more information about\nmessage limits.\n\nClasses\n-------\n\n### AttributesEntry\n\n AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message."]]