Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add additional info on use_legacy_flow_control parameter #301

Merged
merged 7 commits into from
Apr 13, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,11 @@ class StreamingPullManager(object):
``projects/{project}/subscriptions/{subscription}``.
flow_control (~google.cloud.pubsub_v1.types.FlowControl): The flow
control settings.
use_legacy_flow_control (bool): Disables enforcing flow control settings
at the Cloud PubSub server and uses the less accurate method of only
enforcing flow control at the client side.
use_legacy_flow_control (bool):
plamut marked this conversation as resolved.
Show resolved Hide resolved
If set to ``True``, it disables enforcing flow control settings on the
Cloud PubSub server. Defaults to ``False``.
anguillanneuf marked this conversation as resolved.
Show resolved Hide resolved
The less accurate method of enforcing flow control on the client side
plamut marked this conversation as resolved.
Show resolved Hide resolved
is still enabled in both cases.
scheduler (~google.cloud.pubsub_v1.scheduler.Scheduler): The scheduler
to use to process messages. If not provided, a thread pool-based
scheduler will be used.
Expand Down
5 changes: 5 additions & 0 deletions google/cloud/pubsub_v1/subscriber/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,11 @@ def callback(message):
*scheduler* to use when executing the callback. This controls
how callbacks are executed concurrently. This object must not be shared
across multiple SubscriberClients.
use_legacy_flow_control (bool):
If set to ``True``, it disables enforcing flow control settings on the
Cloud PubSub server. Defaults to ``False``.
anguillanneuf marked this conversation as resolved.
Show resolved Hide resolved
The less accurate method of enforcing flow control on the client side
is still enabled in both cases.

Returns:
A :class:`~google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture`
Expand Down