Class: Google::Apis::CloudtasksV2beta2::RateLimits

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2beta2/classes.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RateLimits

Returns a new instance of RateLimits



1111
1112
1113
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1111

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#max_burst_size ⇒ Fixnum

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. Corresponds to the JSON property maxBurstSize

Returns:

  • (Fixnum) 


1078
1079
1080
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1078

def max_burst_size
  @max_burst_size
end

#max_concurrent_tasks ⇒ Fixnum

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. -1 indicates no limit. This field is output only for pull queues. This field has the same meaning as max_concurrent_requests in queue.yaml/xml. Corresponds to the JSON property maxConcurrentTasks

Returns:

  • (Fixnum) 


1094
1095
1096
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1094

def max_concurrent_tasks
  @max_concurrent_tasks
end

#max_tasks_dispatched_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.

  • 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. Corresponds to the JSON property maxTasksDispatchedPerSecond

Returns:

  • (Float) 


1109
1110
1111
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1109

def max_tasks_dispatched_per_second
  @max_tasks_dispatched_per_second
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1116
1117
1118
1119
1120
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1116

def update!(**args)
  @max_burst_size = args[:max_burst_size] if args.key?(:max_burst_size)
  @max_concurrent_tasks = args[:max_concurrent_tasks] if args.key?(:max_concurrent_tasks)
  @max_tasks_dispatched_per_second = args[:max_tasks_dispatched_per_second] if args.key?(:max_tasks_dispatched_per_second)
end