Struct RateLimits 

#[non_exhaustive]
pub struct RateLimits {
    pub max_dispatches_per_second: f64,
    pub max_burst_size: i32,
    pub max_concurrent_dispatches: i32,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_dispatches_per_second: 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.

• The maximum allowed value is 500.

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

max_burst_size: 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_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.

max_concurrent_dispatches: 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 has the same meaning as max_concurrent_requests in queue.yaml/xml.

Implementations

impl RateLimits

pub fn new() -> Self

pub fn set_max_dispatches_per_second<T: Into<f64>>(self, v: T) -> Self

Sets the value of max_dispatches_per_second.

pub fn set_max_burst_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_burst_size.

pub fn set_max_concurrent_dispatches<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_concurrent_dispatches.

Trait Implementations

impl Clone for RateLimits

fn clone(&self) -> RateLimits

Returns a duplicate 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 Message for RateLimits

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RateLimits

fn eq(&self, other: &RateLimits) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RateLimits