Send feedback
Class FlowControl (2.31.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
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)
Send feedback
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 2025-08-28 UTC.
Need to tell us more?
[[["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 2025-08-28 UTC."],[],[],null,["# Class FlowControl (2.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.0 (latest)](/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.FlowControl)\n- [2.30.0](/python/docs/reference/pubsub/2.30.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.29.1](/python/docs/reference/pubsub/2.29.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.28.0](/python/docs/reference/pubsub/2.28.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.27.3](/python/docs/reference/pubsub/2.27.3/google.cloud.pubsub_v1.types.FlowControl)\n- [2.26.1](/python/docs/reference/pubsub/2.26.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.25.2](/python/docs/reference/pubsub/2.25.2/google.cloud.pubsub_v1.types.FlowControl)\n- [2.23.1](/python/docs/reference/pubsub/2.23.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.22.0](/python/docs/reference/pubsub/2.22.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.21.5](/python/docs/reference/pubsub/2.21.5/google.cloud.pubsub_v1.types.FlowControl)\n- [2.20.3](/python/docs/reference/pubsub/2.20.3/google.cloud.pubsub_v1.types.FlowControl)\n- [2.19.8](/python/docs/reference/pubsub/2.19.8/google.cloud.pubsub_v1.types.FlowControl)\n- [2.18.4](/python/docs/reference/pubsub/2.18.4/google.cloud.pubsub_v1.types.FlowControl)\n- [2.17.1](/python/docs/reference/pubsub/2.17.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.16.1](/python/docs/reference/pubsub/2.16.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.15.2](/python/docs/reference/pubsub/2.15.2/google.cloud.pubsub_v1.types.FlowControl)\n- [2.14.1](/python/docs/reference/pubsub/2.14.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.13.12](/python/docs/reference/pubsub/2.13.12/google.cloud.pubsub_v1.types.FlowControl)\n- [2.12.1](/python/docs/reference/pubsub/2.12.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.11.1](/python/docs/reference/pubsub/2.11.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.10.0](/python/docs/reference/pubsub/2.10.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.9.0](/python/docs/reference/pubsub/2.9.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.8.0](/python/docs/reference/pubsub/2.8.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.7.1](/python/docs/reference/pubsub/2.7.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.6.1](/python/docs/reference/pubsub/2.6.1/google.cloud.pubsub_v1.types.FlowControl)\n- [2.5.0](/python/docs/reference/pubsub/2.5.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.4.2](/python/docs/reference/pubsub/2.4.2/google.cloud.pubsub_v1.types.FlowControl)\n- [2.3.0](/python/docs/reference/pubsub/2.3.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.2.0](/python/docs/reference/pubsub/2.2.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.1.0](/python/docs/reference/pubsub/2.1.0/google.cloud.pubsub_v1.types.FlowControl)\n- [2.0.0](/python/docs/reference/pubsub/2.0.0/google.cloud.pubsub_v1.types.FlowControl)\n- [1.7.2](/python/docs/reference/pubsub/1.7.2/google.cloud.pubsub_v1.types.FlowControl)\n- [1.6.1](/python/docs/reference/pubsub/1.6.1/google.cloud.pubsub_v1.types.FlowControl)\n- [1.5.0](/python/docs/reference/pubsub/1.5.0/google.cloud.pubsub_v1.types.FlowControl)\n- [1.4.3](/python/docs/reference/pubsub/1.4.3/google.cloud.pubsub_v1.types.FlowControl)\n- [1.3.1](/python/docs/reference/pubsub/1.3.1/google.cloud.pubsub_v1.types.FlowControl)\n- [1.2.0](/python/docs/reference/pubsub/1.2.0/google.cloud.pubsub_v1.types.FlowControl)\n- [1.1.0](/python/docs/reference/pubsub/1.1.0/google.cloud.pubsub_v1.types.FlowControl)\n- [1.0.2](/python/docs/reference/pubsub/1.0.2/google.cloud.pubsub_v1.types.FlowControl)\n- [0.45.0](/python/docs/reference/pubsub/0.45.0/google.cloud.pubsub_v1.types.FlowControl)\n- [0.44.0](/python/docs/reference/pubsub/0.44.0/google.cloud.pubsub_v1.types.FlowControl)\n- [0.43.0](/python/docs/reference/pubsub/0.43.0/google.cloud.pubsub_v1.types.FlowControl) \n\n FlowControl(\n max_bytes: int = 104857600,\n max_messages: int = 1000,\n max_lease_duration: float = 3600,\n min_duration_per_lease_extension: float = 0,\n max_duration_per_lease_extension: float = 0,\n )\n\nThe settings for controlling the rate at which messages are pulled\nwith an asynchronous subscription.\n\nMethods\n-------\n\n### FlowControl\n\n FlowControl(\n max_bytes: int = 104857600,\n max_messages: int = 1000,\n max_lease_duration: float = 3600,\n min_duration_per_lease_extension: float = 0,\n max_duration_per_lease_extension: float = 0,\n )\n\nCreate new instance of FlowControl(max_bytes, max_messages, max_lease_duration, min_duration_per_lease_extension, max_duration_per_lease_extension)"]]