- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
public final class RateLimits extends GeneratedMessageV3 implements RateLimitsOrBuilderRate 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.v2beta2.RateLimits
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RateLimitsImplements
RateLimitsOrBuilderStatic Fields
MAX_BURST_SIZE_FIELD_NUMBER
public static final int MAX_BURST_SIZE_FIELD_NUMBER| Type | Description |
| int |
MAX_CONCURRENT_TASKS_FIELD_NUMBER
public static final int MAX_CONCURRENT_TASKS_FIELD_NUMBER| Type | Description |
| int |
MAX_TASKS_DISPATCHED_PER_SECOND_FIELD_NUMBER
public static final int MAX_TASKS_DISPATCHED_PER_SECOND_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static RateLimits getDefaultInstance()| Type | Description |
| RateLimits |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static RateLimits.Builder newBuilder()| Type | Description |
| RateLimits.Builder |
newBuilder(RateLimits prototype)
public static RateLimits.Builder newBuilder(RateLimits prototype)| Name | Description |
| prototype | RateLimits |
| Type | Description |
| RateLimits.Builder |
parseDelimitedFrom(InputStream input)
public static RateLimits parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| RateLimits |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RateLimits |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static RateLimits parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| RateLimits |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RateLimits |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static RateLimits parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| RateLimits |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RateLimits |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static RateLimits parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| RateLimits |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RateLimits |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static RateLimits parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| RateLimits |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RateLimits |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static RateLimits parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| RateLimits |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RateLimits |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<RateLimits> parser()| Type | Description |
| Parser<RateLimits> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getDefaultInstanceForType()
public RateLimits getDefaultInstanceForType()| Type | Description |
| RateLimits |
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. |
getMaxConcurrentTasks()
public int getMaxConcurrentTasks() 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 is output only for
pull queues and always -1, which indicates no limit. No other
queue types can have max_concurrent_tasks set to -1.
This field has the same meaning as
max_concurrent_requests in
queue.yaml/xml.
int32 max_concurrent_tasks = 3;
| Type | Description |
| int | The maxConcurrentTasks. |
getMaxTasksDispatchedPerSecond()
public double getMaxTasksDispatchedPerSecond()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_secondlimit, 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.
double max_tasks_dispatched_per_second = 1;
| Type | Description |
| double | The maxTasksDispatchedPerSecond. |
getParserForType()
public Parser<RateLimits> getParserForType()| Type | Description |
| Parser<RateLimits> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public RateLimits.Builder newBuilderForType()| Type | Description |
| RateLimits.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RateLimits.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| RateLimits.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public RateLimits.Builder toBuilder()| Type | Description |
| RateLimits.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |