- Resource: Queue
- AppEngineHttpQueue
- HttpTarget
- UriOverride
- Scheme
- PathOverride
- QueryOverride
- UriOverrideEnforceMode
- HeaderOverride
- Header
- RateLimits
- RetryConfig
- State
- StackdriverLoggingConfig
- Type
- QueueStats
- Methods
Resource: Queue
A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.
JSON representation |
---|
{ "name": string, "httpTarget": { object ( |
Fields | |
---|---|
name |
Caller-specified and required in The queue name. The queue name must have the following format:
|
httpTarget |
Modifies HTTP target for HTTP tasks. |
rateLimits |
Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
|
retryConfig |
Settings that determine the retry behavior.
|
state |
Output only. The state of the queue.
|
purgeTime |
Output only. The last time this queue was purged. All tasks that were A queue can be purged using Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
taskTtl |
The maximum amount of time that a task will be retained in this queue. After a task has lived for The minimum value is 10 days. The maximum value is 10 years. The value must be given as a string that indicates the length of time (in seconds) followed by Queues created by Cloud Tasks have a default Queues created by queue.yaml/xml have a fixed |
tombstoneTtl |
The task tombstone time to live (TTL). After a task is deleted or executed, the task's tombstone is retained for the length of time specified by The minimum value is 1 hour. The maximum value is 9 days. The value must be given as a string that indicates the length of time (in seconds) followed by Queues created by Cloud Tasks have a default |
stackdriverLoggingConfig |
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written. |
type |
Immutable. The type of a queue (push or pull).
|
stats |
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask. |
Union field
|
|
appEngineHttpQueue |
|
AppEngineHttpQueue
App Engine HTTP queue.
The task will be delivered to the App Engine application hostname specified by its AppEngineHttpQueue
and AppEngineHttpRequest
. The documentation for AppEngineHttpRequest
explains how the task's host URL is constructed.
Using AppEngineHttpQueue
requires appengine.applications.get
Google IAM permission for the project and the following scope:
https://www.googleapis.com/auth/cloud-platform
JSON representation |
---|
{
"appEngineRoutingOverride": {
object ( |
Fields | |
---|---|
appEngineRoutingOverride |
Overrides for the If set, |
HttpTarget
HTTP target.
When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.
JSON representation |
---|
{ "uriOverride": { object ( |
Fields | |
---|---|
uriOverride |
URI override. When specified, overrides the execution URI for all the tasks in the queue. |
httpMethod |
The HTTP method to use for the request. When specified, it overrides |
headerOverrides[] |
HTTP target headers. This map contains the header field names and values. Headers will be set when running the These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.Target.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks.
Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms. |
Union field If specified, all |
|
oauthToken |
If specified, an OAuth token is generated and attached as the This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. |
oidcToken |
If specified, an OIDC token is generated and attached as an This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. |
UriOverride
URI Override.
When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.
JSON representation |
---|
{ "pathOverride": { object ( |
Fields | |
---|---|
pathOverride |
URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. |
queryOverride |
URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. |
uriOverrideEnforceMode |
URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. |
scheme |
Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). |
host |
Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT). |
port |
Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. |
Scheme
The Scheme for an HTTP request. By default, it is HTTPS.
Enums | |
---|---|
SCHEME_UNSPECIFIED |
Scheme unspecified. Defaults to HTTPS. |
HTTP |
Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca. |
HTTPS |
Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca. |
PathOverride
PathOverride.
Path message defines path override for HTTP targets.
JSON representation |
---|
{ "path": string } |
Fields | |
---|---|
path |
The URI path (e.g., /users/1234). Default is an empty string. |
QueryOverride
QueryOverride.
Query message defines query override for HTTP targets.
JSON representation |
---|
{ "queryParams": string } |
Fields | |
---|---|
queryParams |
The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string. |
UriOverrideEnforceMode
UriOverrideEnforceMode mode is to define enforcing mode for the override modes.
Enums | |
---|---|
URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED |
OverrideMode Unspecified. Defaults to ALWAYS. |
IF_NOT_EXISTS |
In the IF_NOT_EXISTS mode, queue-level configuration is only applied where task-level configuration does not exist. |
ALWAYS |
In the ALWAYS mode, queue-level configuration overrides all task-level configuration |
HeaderOverride
Wraps the Header object.
JSON representation |
---|
{
"header": {
object ( |
Fields | |
---|---|
header |
Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms. |
Header
Defines a header message. A header can have a key and a value.
JSON representation |
---|
{ "key": string, "value": string } |
Fields | |
---|---|
key |
The Key of the header. |
value |
The Value of the header. |
RateLimits
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
.
JSON representation |
---|
{ "maxDispatchesPerSecond": number, "maxBurstSize": integer, "maxConcurrentDispatches": integer } |
Fields | |
---|---|
maxDispatchesPerSecond |
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
This field has the same meaning as rate in queue.yaml/xml. |
maxBurstSize |
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 The default value of The maximum value of For App Engine queues that were created or updated using |
maxConcurrentDispatches |
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. |
RetryConfig
Retry config.
These settings determine when a failed task attempt is retried.
JSON representation |
---|
{ "maxAttempts": integer, "maxRetryDuration": string, "minBackoff": string, "maxBackoff": string, "maxDoublings": integer } |
Fields | |
---|---|
maxAttempts |
Number of attempts per task. Cloud Tasks will attempt the task If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. |
maxRetryDuration |
If positive, If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by This field has the same meaning as taskAgeLimit in queue.yaml/xml. |
minBackoff |
A task will be If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by This field has the same meaning as min_backoff_seconds in queue.yaml/xml. |
maxBackoff |
A task will be If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by This field has the same meaning as max_backoff_seconds in queue.yaml/xml. |
maxDoublings |
The time between retries will double A task's retry interval starts at For example, if If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as maxDoublings in queue.yaml/xml. |
State
State of the queue.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
RUNNING |
The queue is running. Tasks can be dispatched. If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return |
PAUSED |
Tasks are paused by the user. If the queue is paused then Cloud Tasks will stop delivering tasks from it, but more tasks can still be added to it by the user. |
DISABLED |
The queue is disabled. A queue becomes When a queue is disabled, tasks can still be added to a queue but the tasks are not dispatched. To permanently delete this queue and all of its tasks, call |
StackdriverLoggingConfig
Configuration options for writing logs to Stackdriver Logging.
JSON representation |
---|
{ "samplingRatio": number } |
Fields | |
---|---|
samplingRatio |
Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. |
Type
The type of the queue.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default value. |
PULL |
A pull queue. |
PUSH |
A push queue. |
QueueStats
Statistics for a queue.
JSON representation |
---|
{ "tasksCount": string, "oldestEstimatedArrivalTime": string, "executedLastMinuteCount": string, "concurrentDispatchesCount": string, "effectiveExecutionRate": number } |
Fields | |
---|---|
tasksCount |
Output only. An estimation of the number of tasks in the queue, that is, the tasks in the queue that haven't been executed, the tasks in the queue which the queue has dispatched but has not yet received a reply for, and the failed tasks that the queue is retrying. |
oldestEstimatedArrivalTime |
Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
executedLastMinuteCount |
Output only. The number of tasks that the queue has dispatched and received a reply for during the last minute. This variable counts both successful and non-successful executions. |
concurrentDispatchesCount |
Output only. The number of requests that the queue has dispatched but has not received a reply for yet. |
effectiveExecutionRate |
Output only. The current maximum number of tasks per second executed by the queue. The maximum value of this variable is controlled by the RateLimits of the Queue. However, this value could be less to avoid overloading the endpoints tasks in the queue are targeting. |
Methods |
|
---|---|
|
Creates a queue. |
|
Deletes a queue. |
|
Gets a queue. |
|
Gets the access control policy for a Queue . |
|
Lists queues. |
|
Updates a queue. |
|
Pauses the queue. |
|
Purges a queue by deleting all of its tasks. |
|
Resume a queue. |
|
Sets the access control policy for a Queue . |
|
Returns permissions that a caller has on a Queue . |