Class: Google::Apis::CloudtasksV2::RateLimits

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudtasks_v2/classes.rb,
lib/google/apis/cloudtasks_v2/representations.rb,
lib/google/apis/cloudtasks_v2/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. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RateLimits

Returns a new instance of RateLimits.



1336
1337
1338
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1336

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

Returns:

  • (Fixnum) 


1314
1315
1316
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1314

def max_burst_size
  @max_burst_size
end

#max_concurrent_dispatches ⇒ 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. This field has the same meaning as max_concurrent_requests in queue.yaml/xml. Corresponds to the JSON property maxConcurrentDispatches

Returns:

  • (Fixnum) 


1325
1326
1327
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1325

def max_concurrent_dispatches
  @max_concurrent_dispatches
end

#max_dispatches_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. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/ xml. Corresponds to the JSON property maxDispatchesPerSecond

Returns:

  • (Float) 


1334
1335
1336
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1334

def max_dispatches_per_second
  @max_dispatches_per_second
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1341
1342
1343
1344
1345
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1341

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