Cloud PubSub Client - Class BatchPublisher (1.43.2)

Version 1.43.2

• 2.8.2 (latest)
• 2.8.1
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.'
]);

Namespace

Google \ Cloud \ PubSub

Methods

__construct

Parameters
Name	Description
topicName	string The topic name.
options	array [optional] Please 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 Google\Cloud\PubSub\Google\Cloud\PubSub\Message, or an array in the correct Message Format.

Returns
Type	Description
void

publishDeferred

Publish a set of deferred messages, sorted into multiple calls by ordering key.

Intended for internal use only by the batch publisher.

Parameters
Name	Description
messages	array[] A list of messages. Each message must be in the correct Message Format.
options	array [optional] Configuration Options

Returns
Type	Description
array	A list of message IDs.

Constants

ID_TEMPLATE

Value: 'pubsub-topic-%s'