Class RateLimits.Builder (2.54.0) 

public static final class RateLimits.Builder extends GeneratedMessageV3.Builder<RateLimits.Builder> implements RateLimitsOrBuilder

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.

Protobuf type google.cloud.tasks.v2.RateLimits

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RateLimits.Builder

Implements

RateLimitsOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RateLimits.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RateLimits.Builder
Overrides

build()

public RateLimits build()
Returns
Type Description
RateLimits

buildPartial()

public RateLimits buildPartial()
Returns
Type Description
RateLimits

clear()

public RateLimits.Builder clear()
Returns
Type Description
RateLimits.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RateLimits.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RateLimits.Builder
Overrides

clearMaxBurstSize()

public RateLimits.Builder clearMaxBurstSize()

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.

int32 max_burst_size = 2;

Returns
Type Description
RateLimits.Builder

This builder for chaining.

clearMaxConcurrentDispatches()

public RateLimits.Builder clearMaxConcurrentDispatches()

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.

int32 max_concurrent_dispatches = 3;

Returns
Type Description
RateLimits.Builder

This builder for chaining.

clearMaxDispatchesPerSecond()

public RateLimits.Builder clearMaxDispatchesPerSecond()

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.

double max_dispatches_per_second = 1;

Returns
Type Description
RateLimits.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RateLimits.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RateLimits.Builder
Overrides

clone()

public RateLimits.Builder clone()
Returns
Type Description
RateLimits.Builder
Overrides

getDefaultInstanceForType()

public RateLimits getDefaultInstanceForType()
Returns
Type Description
RateLimits

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMaxBurstSize()

public int getMaxBurstSize()

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.

int32 max_burst_size = 2;

Returns
Type Description
int

The maxBurstSize.

getMaxConcurrentDispatches()

public int getMaxConcurrentDispatches()

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.

int32 max_concurrent_dispatches = 3;

Returns
Type Description
int

The maxConcurrentDispatches.

getMaxDispatchesPerSecond()

public double getMaxDispatchesPerSecond()

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.

double max_dispatches_per_second = 1;

Returns
Type Description
double

The maxDispatchesPerSecond.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RateLimits other)

public RateLimits.Builder mergeFrom(RateLimits other)
Parameter
Name Description
other RateLimits
Returns
Type Description
RateLimits.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RateLimits.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RateLimits.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RateLimits.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RateLimits.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RateLimits.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RateLimits.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RateLimits.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RateLimits.Builder
Overrides

setMaxBurstSize(int value)

public RateLimits.Builder setMaxBurstSize(int value)

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.

int32 max_burst_size = 2;

Parameter
Name Description
value int

The maxBurstSize to set.
Returns
Type Description
RateLimits.Builder

This builder for chaining.

setMaxConcurrentDispatches(int value)

public RateLimits.Builder setMaxConcurrentDispatches(int value)

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.

int32 max_concurrent_dispatches = 3;

Parameter
Name Description
value int

The maxConcurrentDispatches to set.
Returns
Type Description
RateLimits.Builder

This builder for chaining.

setMaxDispatchesPerSecond(double value)

public RateLimits.Builder setMaxDispatchesPerSecond(double value)

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.

double max_dispatches_per_second = 1;

Parameter
Name Description
value double

The maxDispatchesPerSecond to set.
Returns
Type Description
RateLimits.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RateLimits.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RateLimits.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RateLimits.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RateLimits.Builder
Overrides