Cloud Pub/Sub v1 API - Class ReceivedMessage (3.19.0) 

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

Reference documentation and code samples for the Cloud Pub/Sub v1 API class ReceivedMessage.

A message and its corresponding acknowledgment ID.

Inheritance

object > ReceivedMessage

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; }

Optional. This ID can be used to acknowledge the received message.

Property Value
Type Description
string

DeliveryAttempt

public int DeliveryAttempt { get; set; }

Optional. The approximate number of times that 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
int

Message

public PubsubMessage Message { get; set; }

Optional. The message.

Property Value
Type Description
PubsubMessage