Class RateLimits (1.5.2)

Version 1.5.2

• 2.17.0 (latest)
• 2.16.5
• 2.15.1
• 2.14.2
• 2.13.2
• 2.12.1
• 2.11.0
• 2.10.4
• 2.9.1
• 2.8.1
• 2.7.2
• 2.6.0
• 2.5.3
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.5.2
• 1.4.0
• 1.3.0
• 1.2.1

Rate limits.

This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry.

Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.

Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket <https://wikipedia.org/wiki/Token_Bucket> algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by max_burst_size. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on [max_tasks_di spatched_per_second][google.cloud.tasks.v2beta2.RateLimits.m ax_tasks_dispatched_per_second]. Cloud Tasks will pick the value of max_burst_size based on the value of [max_ta sks_dispatched_per_second][google.cloud.tasks.v2beta2.RateL imits.max_tasks_dispatched_per_second]. For App Engine queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket\_size <https://cloud.go ogle.com/appengine/docs/standard/python/config/queueref#bucket _size>. Since max_burst_size is output only, if [Update Queue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called on a queue created by queue.yaml/xml, max_burst_size will be reset based on the value of [max_t asks_dispatched_per_second][google.cloud.tasks.v2beta2.Rate Limits.max_tasks_dispatched_per_second], regardless of whether [max_tasks_dispatched_per_second][google.cloud.tas ks.v2beta2.RateLimits.max_tasks_dispatched_per_second] is updated.