Cloud PubSub Client - Class BatchPublisher (1.40.1)

Version 1.40.1

• 2.8.0 (latest)
• 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 Client class BatchPublisher.

Publishes messages to Google Cloud Pub\Sub with background batching.

Example:

use Google\Cloud\PubSub\PubSubClient;

$pubsub = new PubSubClient();
$batchPublisher = $pubsub->topic('my_topic')
    ->batchPublisher();

$batchPublisher->publish([
    'data' => 'An important message.'
]);

Methods

__construct

Parameters
Name	Description
topicName	string The topic name.
options	array [optional] Please see {@see \Google\Cloud\PubSub\Google\Cloud\PubSub\Topic::batchPublisher()} for configuration details.

publish

Send messages to a batch queue.

Example:

$batchPublisher->publish([
    'data' => 'An important message.'
]);

Parameter
Name	Description
message	Google\Cloud\PubSub\Message|array An instance of {@see \Google\Cloud\PubSub\Google\Cloud\PubSub\Message}, or an array in the correct Message Format.

Returns
Type	Description
bool

Constants

ID_TEMPLATE

Value: 'pubsub-topic-%s'