Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::PubsubMessage (v1.9.0)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::PubsubMessage.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#data

def data() -> ::String
Returns
  • (::String) — Optional. The message data field. If this field is empty, the message must contain at least one attribute.

#data=

def data=(value) -> ::String
Parameter
  • value (::String) — Optional. The message data field. If this field is empty, the message must contain at least one attribute.
Returns
  • (::String) — Optional. The message data field. If this field is empty, the message must contain at least one attribute.

#message_id

def message_id() -> ::String
Returns
  • (::String) — 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.

#message_id=

def message_id=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#ordering_key

def ordering_key() -> ::String
Returns
  • (::String) — 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 PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see ordering messages.

#ordering_key=

def ordering_key=(value) -> ::String
Parameter
  • value (::String) — 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 PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see ordering messages.
Returns
  • (::String) — 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 PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see ordering messages.

#publish_time

def publish_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::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.

#publish_time=

def publish_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::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.
Returns
  • (::Google::Protobuf::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.