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] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

Inheritance
object
PubsubMessage
Implements
Inherited Members
Namespace: Google.Apis.Pubsub.v1.Data
Assembly: Google.Apis.Pubsub.v1.dll
Syntax
public class PubsubMessage : IDirectResponseSchema

Properties

Attributes

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.

Declaration
[JsonProperty("attributes")]
public virtual IDictionary<string, string> Attributes { get; set; }
Property Value
Type Description
IDictionary<string, string>

Data

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

Declaration
[JsonProperty("data")]
public virtual string Data { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

MessageId

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.

Declaration
[JsonProperty("messageId")]
public virtual string MessageId { get; set; }
Property Value
Type Description
string

OrderingKey

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.

Declaration
[JsonProperty("orderingKey")]
public virtual string OrderingKey { get; set; }
Property Value
Type Description
string

PublishTime

object representation of PublishTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use PublishTimeDateTimeOffset instead.")]
public virtual object PublishTime { get; set; }
Property Value
Type Description
object

PublishTimeDateTimeOffset

DateTimeOffset representation of PublishTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? PublishTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

PublishTimeRaw

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.

Declaration
[JsonProperty("publishTime")]
public virtual string PublishTimeRaw { get; set; }
Property Value
Type Description
string

Implements