Cloud PubSub Client - Class BatchPublisher (1.49.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.49.0 keyboard_arrow_down
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
Please see Google\Cloud\PubSub\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.'
]);
Returns Type Description void
publishDeferred
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-28 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-09-28 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-28 UTC."]]