Cloud PubSub Client - Class BatchPublisher (2.13.2)

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

Please see Topic::batchPublisher() for configuration details.

↳ enableCompression

bool

Flag to enable compression of messages before publishing. Set the flag to true to enable compression. Defaults to false . Messsages are compressed if their total size >= compressionBytesThreshold , whose default value has been experimentally derived after performance evaluations.

↳ compressionBytesThreshold

int

The threshold byte size above which messages are compressed. This only takes effect if enableCompression is set to true . Defaults to 240 .

publish

Send messages to a batch queue.

Example:

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

Parameter

Name

Description

message

 Message 
|array

An instance of Message , or an array in the correct Message Format .

Returns

Type

Description

void

publishDeferred

Constants

ID_TEMPLATE

  Value: 'pubsub-topic-%s'

Cloud PubSub Client - Class BatchPublisher (2.13.2) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

publish

publishDeferred

Constants

ID_TEMPLATE

Cloud PubSub Client - Class BatchPublisher (2.13.2)