Class PubsubMessage (2.25.0)

PubsubMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Classes

AttributesEntry

AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.