Cloud Pub/Sub v1 API - Class PubsubMessage (3.10.0-beta01)

public sealed class PubsubMessage : IMessage<PubsubMessage>, IEquatable<PubsubMessage>, IDeepCloneable<PubsubMessage>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class 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.

Inheritance

object > PubsubMessage

Implements

IMessage PubsubMessage, IEquatable PubsubMessage, IDeepCloneable PubsubMessage, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

PubsubMessage()

public PubsubMessage()

PubsubMessage(PubsubMessage)

public PubsubMessage(PubsubMessage other)

Parameter
Name	Description
`other`	`PubsubMessage`

Properties

Attributes

public MapField<string, string> Attributes { get; }

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.

Property Value
Type	Description
`MapFieldstringstring`

Data

public ByteString Data { get; set; }

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

Property Value
Type	Description
`ByteString`

MessageId

public string MessageId { get; set; }

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.

Property Value
Type	Description
`string`

OrderingKey

public string OrderingKey { get; set; }

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.

Property Value
Type	Description
`string`

PublishTime

public Timestamp PublishTime { get; set; }

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.

Property Value
Type	Description
`Timestamp`

Extension Method

PubsubExtensions.GetDeliveryAttempt(PubsubMessage)