# Cloud Tasks V2beta3 API - Class Google::Cloud::Tasks::V2beta3::RateLimits (v0.19.0)

0.19.0 (latest) 0.18.0 0.17.1 0.16.0 0.15.1 0.14.0 0.13.1 0.12.3 0.11.0 0.10.2 0.9.0 0.8.0 0.7.0 0.6.6 Reference documentation and code samples for the Cloud Tasks V2beta3 API class Google::Cloud::Tasks::V2beta3::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.

<br />

Note: The debugging command,
[RunTask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_run_task_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#run_task (method)"), will run a task
even if the queue has reached its
[RateLimits](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits "Google::Cloud::Tasks::V2beta3::RateLimits (class)").

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #max_burst_size

    def max_burst_size() -> ::Integer

**Returns**

- (::Integer) --- 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](https://wikipedia.org/wiki/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

  The default value of `max_burst_size` is picked by Cloud Tasks
  based on the value of
  [max_dispatches_per_second](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

  The maximum value of `max_burst_size` is 500.

  For App Engine queues that were created or updated using
  `queue.yaml/xml`, `max_burst_size` is equal to
  [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
  If
  [UpdateQueue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_update_queue_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue (method)") is called
  on a queue without explicitly setting a value for `max_burst_size`,
  `max_burst_size` value will get updated if
  [UpdateQueue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_update_queue_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue (method)") is
  updating
  [max_dispatches_per_second](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

### #max_burst_size=

    def max_burst_size=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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](https://wikipedia.org/wiki/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

  The default value of `max_burst_size` is picked by Cloud Tasks
  based on the value of
  [max_dispatches_per_second](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

  The maximum value of `max_burst_size` is 500.

  For App Engine queues that were created or updated using
  `queue.yaml/xml`, `max_burst_size` is equal to
  [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
  If
  [UpdateQueue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_update_queue_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue (method)") is called
  on a queue without explicitly setting a value for `max_burst_size`,
  `max_burst_size` value will get updated if
  [UpdateQueue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_update_queue_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue (method)") is
  updating
  [max_dispatches_per_second](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").
**Returns**

- (::Integer) --- 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](https://wikipedia.org/wiki/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

  The default value of `max_burst_size` is picked by Cloud Tasks
  based on the value of
  [max_dispatches_per_second](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

  The maximum value of `max_burst_size` is 500.

  For App Engine queues that were created or updated using
  `queue.yaml/xml`, `max_burst_size` is equal to
  [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
  If
  [UpdateQueue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_update_queue_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue (method)") is called
  on a queue without explicitly setting a value for `max_burst_size`,
  `max_burst_size` value will get updated if
  [UpdateQueue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-CloudTasks-Client#Google__Cloud__Tasks__V2beta3__CloudTasks__Client_update_queue_instance_ "Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue (method)") is
  updating
  [max_dispatches_per_second](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-RateLimits#Google__Cloud__Tasks__V2beta3__RateLimits_max_dispatches_per_second_instance_ "Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second (method)").

### #max_concurrent_dispatches

    def max_concurrent_dispatches() -> ::Integer

**Returns**

- (::Integer) --- 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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).

### #max_concurrent_dispatches=

    def max_concurrent_dispatches=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
**Returns**

- (::Integer) --- 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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).

### #max_dispatches_per_second

    def max_dispatches_per_second() -> ::Float

**Returns**

- (::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.
  - For [App Engine queues](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-AppEngineHttpQueue "Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue (class)"), the maximum allowed value is 500.

  This field has the same meaning as
  [rate in
  queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).

### #max_dispatches_per_second=

    def max_dispatches_per_second=(value) -> ::Float

**Parameter**

- **value** (::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.
  - For [App Engine queues](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-AppEngineHttpQueue "Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue (class)"), the maximum allowed value is 500.

  This field has the same meaning as
  [rate in
  queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
**Returns**

- (::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.
  - For [App Engine queues](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-tasks-v2beta3/latest/Google-Cloud-Tasks-V2beta3-AppEngineHttpQueue "Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue (class)"), the maximum allowed value is 500.

  This field has the same meaning as
  [rate in
  queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).