Struct google_cloudtasks2_beta2::RateLimits

pub struct RateLimits {
    pub max_tasks_dispatched_per_second: Option<f64>,
    pub max_burst_size: Option<i32>,
    pub max_concurrent_tasks: Option<i32>,
}

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.

This type is not used in any activity, and only used as part of another schema.

Fields

max_tasks_dispatched_per_second: Option<f64>

The maximum rate at which tasks are dispatched from this queue.

If unspecified when the queue is created, Cloud Tasks will pick the default.

• For App Engine queues, the maximum allowed value is 500.
• This field is output only for pull queues. In addition to the max_tasks_dispatched_per_second limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue.

This field has the same meaning as rate in queue.yaml/xml.

max_burst_size: Option<i32>

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_tasks_dispatched_per_second.

Cloud Tasks will pick the value of max_burst_size based on the value of 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. 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_tasks_dispatched_per_second, regardless of whether max_tasks_dispatched_per_second is updated.

max_concurrent_tasks: Option<i32>

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 is output only for pull queues and always -1, which indicates no limit. No other queue types can have max_concurrent_tasks set to -1.

This field has the same meaning as max_concurrent_requests in queue.yaml/xml.

Trait Implementations

impl Clone for RateLimits

fn clone(&self) -> RateLimits

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RateLimits

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RateLimits

fn default() -> RateLimits

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimits

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RateLimits

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for RateLimits