Class PubsubMessage (1.4.3)

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 for more information. See Quotas and limits for more information about message limits.

.. attribute:: data

The message data field. If this field is empty, the message must contain at least one attribute.

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.

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. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward- incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Inheritance

builtins.object > google.protobuf.pyext._message.CMessage > builtins.object > google.protobuf.message.Message > PubsubMessage

Classes

AttributesEntry

API documentation for pubsub_v1.types.PubsubMessage.AttributesEntry class.