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 its RateLimits.
Generated from protobuf message google.cloud.tasks.v2.RateLimits
Namespace
Google \ Cloud \ Tasks \ V2Methods
__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 as rate 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. The 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_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 as max_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 as rate 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 as rate 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.
The 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_dispatches_per_second.
Cloud Tasks will pick the value of max_burst_size based on the
value of
max_dispatches_per_second.
For queues that were created or updated using
queue.yaml/xml, max_burst_size is equal to
bucket_size.
Since max_burst_size is output only, if
UpdateQueue is called on a
queue created by queue.yaml/xml, max_burst_size will be reset based on
the value of
max_dispatches_per_second,
regardless of whether
max_dispatches_per_second
is 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.
The 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_dispatches_per_second.
Cloud Tasks will pick the value of max_burst_size based on the
value of
max_dispatches_per_second.
For queues that were created or updated using
queue.yaml/xml, max_burst_size is equal to
bucket_size.
Since max_burst_size is output only, if
UpdateQueue is called on a
queue created by queue.yaml/xml, max_burst_size will be reset based on
the value of
max_dispatches_per_second,
regardless of whether
max_dispatches_per_second
is 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 as max_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 as max_concurrent_requests in queue.yaml/xml.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|