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_attemptwill 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.
getAckId
Optional. This ID can be used to acknowledge the received message.
Returns
Type
Description
string
setAckId
Optional. This ID can be used to acknowledge the received message.
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_attemptwill 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.
Returns
Type
Description
int
setDeliveryAttempt
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_attemptwill 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class ReceivedMessage (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.ReceivedMessage)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.ReceivedMessage)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.ReceivedMessage)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.ReceivedMessage)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.ReceivedMessage)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.ReceivedMessage)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.ReceivedMessage)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.ReceivedMessage)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.ReceivedMessage)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.ReceivedMessage)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.ReceivedMessage)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.ReceivedMessage)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.ReceivedMessage)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.ReceivedMessage)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.ReceivedMessage)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.ReceivedMessage)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.ReceivedMessage)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.ReceivedMessage)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.ReceivedMessage)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.ReceivedMessage)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.ReceivedMessage)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.ReceivedMessage)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.ReceivedMessage)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.ReceivedMessage)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.ReceivedMessage)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.ReceivedMessage) \nReference documentation and code samples for the Cloud PubSub V1 Client class ReceivedMessage.\n\nA message and its corresponding acknowledgment ID.\n\nGenerated from protobuf message `google.pubsub.v1.ReceivedMessage`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAckId\n\nOptional. This ID can be used to acknowledge the received message.\n\n### setAckId\n\nOptional. This ID can be used to acknowledge the received message.\n\n### getMessage\n\nOptional. The message.\n\n### hasMessage\n\n### clearMessage\n\n### setMessage\n\nOptional. The message.\n\n### getDeliveryAttempt\n\nOptional. The approximate number of times that Pub/Sub has attempted to\ndeliver the associated message to a subscriber.\n\nMore precisely, this is 1 + (number of NACKs) +\n(number of ack_deadline exceeds) for this message.\nA NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline\nexceeds event is whenever a message is not acknowledged within\nack_deadline. Note that ack_deadline is initially\nSubscription.ackDeadlineSeconds, but may get extended automatically by\nthe client library.\nUpon the first delivery of a given message, `delivery_attempt` will have a\nvalue of 1. The value is calculated at best effort and is approximate.\nIf a DeadLetterPolicy is not set on the subscription, this will be 0.\n\n### setDeliveryAttempt\n\nOptional. The approximate number of times that Pub/Sub has attempted to\ndeliver the associated message to a subscriber.\n\nMore precisely, this is 1 + (number of NACKs) +\n(number of ack_deadline exceeds) for this message.\nA NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline\nexceeds event is whenever a message is not acknowledged within\nack_deadline. Note that ack_deadline is initially\nSubscription.ackDeadlineSeconds, but may get extended automatically by\nthe client library.\nUpon the first delivery of a given message, `delivery_attempt` will have a\nvalue of 1. The value is calculated at best effort and is approximate.\nIf a DeadLetterPolicy is not set on the subscription, this will be 0."]]
