Reference documentation and code samples for the Google Cloud Tasks V2 Client class RateLimits.
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 itsRateLimits.
Generated from protobuf messagegoogle.cloud.tasks.v2.RateLimits
Namespace
Google \ Cloud \ Tasks \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ max_dispatches_per_second
float
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * * The maximum allowed value is 500. This field has the same meaning asrate in queue.yaml/xml.
↳ max_burst_size
int
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. Thetoken bucketalgorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified bymax_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 onmax_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_sizebased on the value ofmax_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml,max_burst_sizeis equal tobucket_size. Sincemax_burst_sizeis output only, ifUpdateQueueis called on a queue created byqueue.yaml/xml,max_burst_sizewill be reset based on the value ofmax_dispatches_per_second, regardless of whethermax_dispatches_per_secondis updated.
↳ max_concurrent_dispatches
int
The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning asmax_concurrent_requests in queue.yaml/xml.
getMaxDispatchesPerSecond
The maximum rate at which tasks are dispatched from this queue.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
The maximum allowed value is 500.
This field has the same meaning asrate in
queue.yaml/xml.
Returns
Type
Description
float
setMaxDispatchesPerSecond
The maximum rate at which tasks are dispatched from this queue.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
The maximum allowed value is 500.
This field has the same meaning asrate in
queue.yaml/xml.
Parameter
Name
Description
var
float
Returns
Type
Description
$this
getMaxBurstSize
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.
Thetoken bucketalgorithm is used to control the rate of task dispatches. Each
queue has a token bucket that holds tokens, up to the maximum
specified bymax_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 onmax_dispatches_per_second.
Cloud Tasks will pick the value ofmax_burst_sizebased on the
value ofmax_dispatches_per_second.
For queues that were created or updated usingqueue.yaml/xml,max_burst_sizeis equal tobucket_size.
Sincemax_burst_sizeis output only, ifUpdateQueueis called on a
queue created byqueue.yaml/xml,max_burst_sizewill be reset based on
the value ofmax_dispatches_per_second,
regardless of whethermax_dispatches_per_secondis updated.
Returns
Type
Description
int
setMaxBurstSize
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.
Thetoken bucketalgorithm is used to control the rate of task dispatches. Each
queue has a token bucket that holds tokens, up to the maximum
specified bymax_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 onmax_dispatches_per_second.
Cloud Tasks will pick the value ofmax_burst_sizebased on the
value ofmax_dispatches_per_second.
For queues that were created or updated usingqueue.yaml/xml,max_burst_sizeis equal tobucket_size.
Sincemax_burst_sizeis output only, ifUpdateQueueis called on a
queue created byqueue.yaml/xml,max_burst_sizewill be reset based on
the value ofmax_dispatches_per_second,
regardless of whethermax_dispatches_per_secondis updated.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMaxConcurrentDispatches
The maximum number of concurrent tasks that Cloud Tasks allows
to be dispatched for this queue. After this threshold has been
reached, Cloud Tasks stops dispatching tasks until the number of
concurrent requests decreases.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
The maximum allowed value is 5,000.
This field has the same meaning asmax_concurrent_requests in
queue.yaml/xml.
Returns
Type
Description
int
setMaxConcurrentDispatches
The maximum number of concurrent tasks that Cloud Tasks allows
to be dispatched for this queue. After this threshold has been
reached, Cloud Tasks stops dispatching tasks until the number of
concurrent requests decreases.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
The maximum allowed value is 5,000.
This field has the same meaning asmax_concurrent_requests in
queue.yaml/xml.
[[["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-09-04 UTC."],[],[],null,["# Google Cloud Tasks V2 Client - Class RateLimits (2.0.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.2 (latest)](/php/docs/reference/cloud-tasks/latest/V2.RateLimits)\n- [2.0.1](/php/docs/reference/cloud-tasks/2.0.1/V2.RateLimits)\n- [1.15.2](/php/docs/reference/cloud-tasks/1.15.2/V2.RateLimits)\n- [1.14.6](/php/docs/reference/cloud-tasks/1.14.6/V2.RateLimits)\n- [1.13.2](/php/docs/reference/cloud-tasks/1.13.2/V2.RateLimits)\n- [1.12.2](/php/docs/reference/cloud-tasks/1.12.2/V2.RateLimits)\n- [1.11.11](/php/docs/reference/cloud-tasks/1.11.11/V2.RateLimits) \nReference documentation and code samples for the Google Cloud Tasks V2 Client class RateLimits.\n\nRate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.\nNote: The debugging command,\n[RunTask](/php/docs/reference/cloud-tasks/latest/V2.Client.CloudTasksClient#_Google_Cloud_Tasks_V2_Client_CloudTasksClient__runTask__), will run a task even if\nthe queue has reached its [RateLimits](/php/docs/reference/cloud-tasks/latest/V2.RateLimits).\n\nGenerated from protobuf message `google.cloud.tasks.v2.RateLimits`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Tasks \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMaxDispatchesPerSecond\n\nThe maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n- The maximum allowed value is 500. This field has the same meaning as [rate in\n queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).\n\n### setMaxDispatchesPerSecond\n\nThe maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n- The maximum allowed value is 500. This field has the same meaning as [rate in\n queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).\n\n### getMaxBurstSize\n\nOutput only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__).\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__).\nFor queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\n[UpdateQueue](/php/docs/reference/cloud-tasks/latest/V2.Client.CloudTasksClient#_Google_Cloud_Tasks_V2_Client_CloudTasksClient__updateQueue__) is called on a\nqueue created by `queue.yaml/xml`, `max_burst_size` will be reset based on\nthe value of\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__),\nregardless of whether\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__)\nis updated.\n\n### setMaxBurstSize\n\nOutput only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__).\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__).\nFor queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\n[UpdateQueue](/php/docs/reference/cloud-tasks/latest/V2.Client.CloudTasksClient#_Google_Cloud_Tasks_V2_Client_CloudTasksClient__updateQueue__) is called on a\nqueue created by `queue.yaml/xml`, `max_burst_size` will be reset based on\nthe value of\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__),\nregardless of whether\n[max_dispatches_per_second](/php/docs/reference/cloud-tasks/latest/V2.RateLimits#_Google_Cloud_Tasks_V2_RateLimits__getMaxDispatchesPerSecond__)\nis updated.\n\n### getMaxConcurrentDispatches\n\nThe maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\nThe maximum allowed value is 5,000.\nThis field has the same meaning as\n[max_concurrent_requests in\nqueue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).\n\n### setMaxConcurrentDispatches\n\nThe maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\nThe maximum allowed value is 5,000.\nThis field has the same meaning as\n[max_concurrent_requests in\nqueue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests)."]]