RateLimits class
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.
Constructors
- RateLimits()
- RateLimits.fromJson(Map _json)
Properties
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- maxBurstSize ↔ 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_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 ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.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.read / write - maxConcurrentDispatches ↔ 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.
read / write
- maxDispatchesPerSecond ↔ double
-
The maximum rate at which tasks are dispatched from this queue. If
unspecified when the queue is created, Cloud Tasks will pick the default. [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, Object> -
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited