Cloud PubSub Client - Class Message (1.44.0)

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

Represents a PubSub Message.

Example:

use Google\Cloud\PubSub\PubSubClient;

$pubsub = new PubSubClient();
$subscription = $pubsub->subscription('my-new-subscription');

$messages = $subscription->pull();
foreach ($messages as $message) {
    echo $message->data();
}

The message payload.

Example:

echo $message->data();

Retrieve a single message attribute.

Example:

echo $message->attribute('browser-name');

Retrieve all message attributes.

Example:

$attributes = $message->attributes();

Get the message ID.

The message ID is assigned by the server when the message is published. Guaranteed to be unique within the topic.

Example:

echo $message->id();

Get the message ordering key.

Example:

$orderingKey = $message->orderingKey();

Get the message published time.

Example:

$time = $message->publishTime();

Get the message ackId.

This is only set when message is obtained via Google\Cloud\PubSub\Google\Cloud\PubSub\Subscription::pull().

Example:

echo $message->ackId();

Get the delivery attempt count.

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

Example:

echo $message->deliveryAttempt();

Get the subcription through which the message was obtained.

This is only set when the message is obtained via push delivery.

Example:

echo "Subscription Name: ". $message->subscription()->name();

Get the message data.

Available keys are ackId, subscription and message.

Example:

$info = $message->info();

Get the message as an array.