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.v2beta3.RateLimits
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RateLimits.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public RateLimits build()
Returns
buildPartial()
public RateLimits buildPartial()
Returns
clear()
public RateLimits.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public RateLimits.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearMaxBurstSize()
public RateLimits.Builder clearMaxBurstSize()
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.
The default value of max_burst_size is picked by Cloud Tasks
based on the value of
max_dispatches_per_second.
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.
If
UpdateQueue is called on a queue without
explicitly setting a value for max_burst_size,
max_burst_size value will get updated if
UpdateQueue is updating
max_dispatches_per_second.
int32 max_burst_size = 2;
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;
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.
- For App Engine queues, the maximum allowed value
is 500.
This field has the same meaning as
rate in
queue.yaml/xml.
double max_dispatches_per_second = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public RateLimits.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public RateLimits.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public RateLimits getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMaxBurstSize()
public int getMaxBurstSize()
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.
The default value of max_burst_size is picked by Cloud Tasks
based on the value of
max_dispatches_per_second.
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.
If
UpdateQueue is called on a queue without
explicitly setting a value for max_burst_size,
max_burst_size value will get updated if
UpdateQueue is updating
max_dispatches_per_second.
int32 max_burst_size = 2;
| 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;
| 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.
- For App Engine queues, the maximum allowed value
is 500.
This field has the same meaning as
rate in
queue.yaml/xml.
double max_dispatches_per_second = 1;
| Type | Description |
| double | The maxDispatchesPerSecond.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(RateLimits other)
public RateLimits.Builder mergeFrom(RateLimits other)
Parameter
Returns
public RateLimits.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public RateLimits.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RateLimits.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public RateLimits.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setMaxBurstSize(int value)
public RateLimits.Builder setMaxBurstSize(int value)
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.
The default value of max_burst_size is picked by Cloud Tasks
based on the value of
max_dispatches_per_second.
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.
If
UpdateQueue is called on a queue without
explicitly setting a value for max_burst_size,
max_burst_size value will get updated if
UpdateQueue is updating
max_dispatches_per_second.
int32 max_burst_size = 2;
| Name | Description |
| value | int
The maxBurstSize to set.
|
Returns
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;
| Name | Description |
| value | int
The maxConcurrentDispatches to set.
|
Returns
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.
- For App Engine queues, the maximum allowed value
is 500.
This field has the same meaning as
rate in
queue.yaml/xml.
double max_dispatches_per_second = 1;
| Name | Description |
| value | double
The maxDispatchesPerSecond to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RateLimits.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final RateLimits.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
