Cloud PubSub V1 Client - Class ReceivedMessage (1.47.0)

Version 1.47.0

• 2.8.1 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.2
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.5
• 1.45.2
• 1.44.0
• 1.43.2
• 1.42.1
• 1.41.3
• 1.40.1
• 1.39.3

Reference documentation and code samples for the Cloud PubSub V1 Client class ReceivedMessage.

A message and its corresponding acknowledgment ID.

Generated from protobuf message google.pubsub.v1.ReceivedMessage

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ ack_id	string This ID can be used to acknowledge the received message.
↳ message	Google\Cloud\PubSub\V1\PubsubMessage The message.
↳ delivery_attempt	int 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.

getAckId

This ID can be used to acknowledge the received message.

Returns
Type	Description
string

setAckId

This ID can be used to acknowledge the received message.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMessage

The message.

Returns
Type	Description
Google\Cloud\PubSub\V1\PubsubMessage|null

hasMessage

clearMessage

setMessage

The message.

Parameter
Name	Description
var	Google\Cloud\PubSub\V1\PubsubMessage

Returns
Type	Description
$this

getDeliveryAttempt

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.

Returns
Type	Description
int

setDeliveryAttempt

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this