Class FlowControl (2.26.0)

Version 2.26.0

• 2.26.1 (latest)
• 2.26.0
• 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

FlowControl(
    max_bytes: int = 104857600,
    max_messages: int = 1000,
    max_lease_duration: float = 3600,
    min_duration_per_lease_extension: float = 0,
    max_duration_per_lease_extension: float = 0,
)

The settings for controlling the rate at which messages are pulled with an asynchronous subscription.

Attributes
Name	Description
max_bytes :noindex:	int The maximum total size of received - but not yet processed - messages before pausing the message stream. Defaults to 100 MiB.
max_messages :noindex:	int The maximum number of received - but not yet processed - messages before pausing the message stream. Defaults to 1000.
max_lease_duration :noindex:	float The maximum amount of time in seconds to hold a lease on a message before dropping it from the lease management. Defaults to 1 hour.
min_duration_per_lease_extension :noindex:	float The min amount of time in seconds for a single lease extension attempt. Must be between 10 and 600 (inclusive). Ignored by default, but set to 60 seconds if the subscription has exactly-once delivery enabled.
max_duration_per_lease_extension :noindex:	float The max amount of time in seconds for a single lease extension attempt. Bounds the delay before a message redelivery if the subscriber fails to extend the deadline. Must be between 10 and 600 (inclusive). Ignored if set to 0.

Methods

FlowControl

FlowControl(
    max_bytes: int = 104857600,
    max_messages: int = 1000,
    max_lease_duration: float = 3600,
    min_duration_per_lease_extension: float = 0,
    max_duration_per_lease_extension: float = 0,
)

Create new instance of FlowControl(max_bytes, max_messages, max_lease_duration, min_duration_per_lease_extension, max_duration_per_lease_extension)