Class BatchSettings (2.17.1)

Version 2.17.1

• 2.27.1 (latest)
• 2.27.0
• 2.26.1
• 2.25.2
• 2.23.1
• 2.22.0
• 2.21.5
• 2.20.3
• 2.19.8
• 2.18.4
• 2.17.1
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.12
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.1
• 2.5.0
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.2
• 0.45.0
• 0.44.0
• 0.43.0

BatchSettings(
    max_bytes: int = 1000000, max_latency: float = 0.01, max_messages: int = 100
)

The settings for batch publishing the messages.

Attributes
Name	Description
max_bytes	int The maximum total size of the messages to collect before automatically publishing the batch, including any byte size overhead of the publish request itself. The maximum value is bound by the server-side limit of 10_000_000 bytes. Defaults to 1 MB.
max_latency	float The maximum number of seconds to wait for additional messages before automatically publishing the batch. Defaults to 10ms.
max_messages	int The maximum number of messages to collect before automatically publishing the batch. Defaults to 100.

Methods

BatchSettings

BatchSettings(
    max_bytes: int = 1000000, max_latency: float = 0.01, max_messages: int = 100
)

Create new instance of BatchSettings(max_bytes, max_latency, max_messages)