Class ReceivedMessage (2.3.0)

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

A message and its corresponding acknowledgment ID.

Inheritance

System.Object > ReceivedMessage

Implements

Google.Protobuf.IMessage<ReceivedMessage>, System.IEquatable<ReceivedMessage>, Google.Protobuf.IDeepCloneable<ReceivedMessage>, Google.Protobuf.IBufferMessage, Google.Protobuf.IMessage

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

ReceivedMessage()

public ReceivedMessage()

ReceivedMessage(ReceivedMessage)

public ReceivedMessage(ReceivedMessage other)

Parameter
Name	Description
`other`	`ReceivedMessage`

Properties

AckId

public string AckId { get; set; }

This ID can be used to acknowledge the received message.

Property Value
Type	Description
`System.String`

DeliveryAttempt

public int DeliveryAttempt { get; set; }

The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.

More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.

A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.

Upon the first delivery of a given message, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate.

If a DeadLetterPolicy is not set on the subscription, this will be 0.

Property Value
Type	Description
`System.Int32`

Message

public PubsubMessage Message { get; set; }

The message.

Property Value
Type	Description
`PubsubMessage`