RetroSearch Browse

Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.

AppEngineHttpRequest

App Engine HTTP request.

The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.

This proto can only be used for tasks in a queue which has app_engine_http_target set.

Using AppEngineHttpRequest requires appengine.applications.get Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see How Requests are Routed and how routing is affected by dispatch files. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol.

The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:

If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

The url that the task will be sent to is:

url = host + relative_url

Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with login: admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login: required Task dispatches also do not follow redirects.

The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [200 - 299]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the [deadline][Task.dispatch_deadline]. Failed tasks will be retried according to the retry configuration. 503 (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a 429 (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.

Fields http_method

HttpMethod

The HTTP method to use for the request. The default is POST.

The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.

app_engine_routing

AppEngineRouting

Task-level setting for App Engine routing.

If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

relative_url

string

The relative URL.

The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.

payload

bytes

Payload.

The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.

AppEngineHttpTarget

App Engine HTTP target.

The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.

Using AppEngineHttpTarget requires appengine.applications.get Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

AppEngineRouting

App Engine Routing.

Defines routing characteristics specific to App Engine - service, version, and instance.

For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.

Fields service

string

App service.

By default, the task is sent to the service which is the default service when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.

version

string

App version.

By default, the task is sent to the version which is the default version when the task is attempted.

instance

string

App instance.

By default, the task is sent to an instance which is available when the task is attempted.

Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

host

string

Output only. The host that the task is sent to.

For more information, see How Requests are Routed.

The host is constructed as:

host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
application_domain_name = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name.
service = service
version = version
version_dot_service = version + '.' + service
instance = instance
instance_dot_service = instance + '.' + service
instance_dot_version = instance + '.' + version
instance_dot_version_dot_service = instance + '.' + version + '.' + service

If service is empty, then the task will be sent to the service which is the default service when the task is attempted.

If version is empty, then the task will be sent to the version which is the default version when the task is attempted.

If instance is empty, then the task will be sent to an instance which is available when the task is attempted.

If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.

AttemptStatus

The status of a task attempt.

Fields schedule_time

Output only. The time that this attempt was scheduled.

schedule_time will be truncated to the nearest microsecond.

dispatch_time

Output only. The time that this attempt was dispatched.

dispatch_time will be truncated to the nearest microsecond.

response_time

Output only. The time that this attempt response was received.

response_time will be truncated to the nearest microsecond.

response_status

Status

Output only. The response from the target for this attempt.

If the task has not been attempted or the task is currently running then the response status is unset.

BufferTaskRequest

Request message for BufferTask.

Fields queue

string

Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

The queue must already exist.

Authorization requires the following IAM permission on the specified resource queue:

cloudtasks.tasks.create

task_id

string

Optional. Task ID for the task being created. If not provided, a random task ID is assigned to the task.

body

HttpBody

Optional. Body of the HTTP request.

The body can take any generic value. The value is written to the [HttpRequest][payload] of the [Task].

BufferTaskResponse

Response message for BufferTask.

Fields task

Task

The created task.

CancelLeaseRequest

Request message for canceling a lease using CancelLease.

Fields name

string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.tasks.cancelLease

schedule_time

response_view

View

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

CmekConfig

Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.

Fields name

string

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

kms_key

string

Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.

CreateQueueRequest

Request message for CreateQueue.

Fields parent

string

Required. The location name in which the queue will be created. For example: projects/PROJECT_ID/locations/LOCATION_ID

The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.

Authorization requires the following IAM permission on the specified resource parent:

cloudtasks.queues.create

queue

Queue

Required. The queue to create.

Queue's name cannot be the same as an existing queue.

CreateTaskRequest

Request message for CreateTask.

Fields parent

string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

The queue must already exist.

Authorization requires the following IAM permission on the specified resource parent:

cloudtasks.tasks.create

task

Task

Required. The task to add.

Task names have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response.

If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time.

Task De-duplication:

Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again.

Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.

response_view

View

The response_view specifies which subset of the Task will be returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

DeleteQueueRequest

Request message for DeleteQueue.

Fields name

string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.queues.delete

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

Fields name

string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.tasks.delete

GetCmekConfigRequest

Request message for GetCmekConfig.

Fields name

string

Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.cmekConfig.get

GetQueueRequest

Request message for GetQueue.

Fields name

string

Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.queues.get

read_mask

Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

GetTaskRequest

Request message for getting a task using GetTask.

Fields name

string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.tasks.get

response_view

View

The response_view specifies which subset of the Task will be returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

HttpMethod

The HTTP method used to execute the task.

Enums HTTP_METHOD_UNSPECIFIED HTTP method unspecified POST HTTP POST GET HTTP GET HEAD HTTP HEAD PUT HTTP PUT DELETE HTTP DELETE PATCH HTTP PATCH OPTIONS HTTP OPTIONS HttpRequest

HTTP request.

The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.

Fields url

string

Required. The full url path that the request will be sent to.

This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.

http_method

HttpMethod

The HTTP method to use for the request. The default is POST.

body

bytes

HTTP request body.

A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

oauth_token

OAuthToken

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

oidc_token

OidcToken

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

HttpTarget

HTTP target.

When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.

Fields uri_override

UriOverride

Uri override.

When specified, overrides the execution Uri for all the tasks in the queue.

http_method

HttpMethod

The HTTP method to use for the request.

When specified, it overrides HttpRequest for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.

oauth_token

OAuthToken

If specified, an OAuth token is generated and attached as an Authorization header in the HTTP request.

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.

oidc_token

OidcToken

If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request.

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.

LeaseTasksRequest

Request message for leasing tasks using LeaseTasks.

Fields parent

string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource parent:

cloudtasks.tasks.lease

max_tasks

int32

The maximum number of tasks to lease.

The system will make a best effort to return as close to as max_tasks as possible.

The largest that max_tasks can be is 1000.

The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.

lease_duration

Required. The duration of the lease.

Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time.

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it.

The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.

response_view

View

The response_view specifies which subset of the Task will be returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

filter

string

filter can be used to specify a subset of tasks to lease.

When filter is set to tag=<my-tag> then the response will contain only tasks whose tag is equal to <my-tag>. <my-tag> must be less than 500 characters.

When filter is set to tag_function=oldest_tag(), only tasks which have the same tag as the task with the oldest schedule_time will be returned.

Grammar Syntax:

filter = "tag=" tag | "tag_function=" function
tag = string
function = "oldest_tag()"

The oldest_tag() function returns tasks which have the same tag as the oldest task (ordered by schedule time).

SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks.

LeaseTasksResponse

Response message for leasing tasks using LeaseTasks.

Fields tasks[]

Task

The leased tasks.

ListQueuesRequest

Request message for ListQueues.

Fields parent

string

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

Authorization requires the following IAM permission on the specified resource parent:

cloudtasks.queues.list

filter

string

filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

Sample filter "app_engine_http_target: *".

Note that using filters might cause fewer queues than the requested_page size to be returned.

page_size

int32

Requested page size.

The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.

page_token

string

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.

read_mask

ListQueuesResponse

Response message for ListQueues.

Fields queues[]

Queue

The list of queues.

next_page_token

string

A token to retrieve next page of results.

To return the next page of results, call ListQueues with this value as the page_token.

If the next_page_token is empty, there are no more results.

The page token is valid for only 2 hours.

ListTasksRequest

Request message for listing tasks using ListTasks.

Fields parent

string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource parent:

cloudtasks.tasks.list

response_view

View

The response_view specifies which subset of the Task will be returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

page_size

int32

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

page_token

string

A token identifying the page of results to return.

The page token is valid for only 2 hours.

ListTasksResponse

Response message for listing tasks using ListTasks.

Fields tasks[]

Task

The list of tasks.

next_page_token

string

A token to retrieve next page of results.

To return the next page of results, call ListTasks with this value as the page_token.

If the next_page_token is empty, there are no more results.

OAuthToken

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Fields service_account_email

string

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

scope

string

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

OidcToken

Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Fields service_account_email

string

Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

audience

string

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

PathOverride

PathOverride.

Path message defines path override for HTTP targets.

Fields path

string

The URI path (e.g., /users/1234). Default is an empty string.

PauseQueueRequest

Request message for PauseQueue.

Fields name

string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.queues.pause

PullMessage

The pull message contains data that can be used by the caller of LeaseTasks to process the task.

This proto can only be used for tasks in a queue which has pull_target set.

Fields payload

bytes

A data payload consumed by the worker to execute the task.

tag

string

The task's tag.

Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID.

The task's tag can only be set when the task is created.

The tag must be less than 500 characters.

SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.

PullTarget

This type has no fields.

Pull target.

PurgeQueueRequest

Request message for PurgeQueue.

Fields name

string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.queues.purge

QueryOverride

QueryOverride.

Query message defines query override for HTTP targets.

Fields query_params

string

The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.

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, target types, and others.

Fields name

string

Caller-specified and required in CreateQueue, after which it becomes output only.

The queue name.

The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

rate_limits

RateLimits

Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted in different ways:

rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry).
retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc).

retry_config

RetryConfig

Settings that determine the retry behavior.

For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks.
For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.

state

State

Output only. The state of the queue.

state can only be changed by called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

purge_time

Output only. The last time this queue was purged.

All tasks that were created before this time were purged.

A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.

Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.

task_ttl

The maximum amount of time that a task will be retained in this queue.

Queues created by Cloud Tasks have a default task_ttl of 31 days. After a task has lived for task_ttl, the task will be deleted regardless of whether it was dispatched or not.

The task_ttl for queues created via queue.yaml/xml is equal to the maximum duration because there is a storage quota for these queues. To view the maximum valid duration, see the documentation for Duration.

tombstone_ttl

The task tombstone time to live (TTL).

After a task is deleted or completed, the task's tombstone is retained for the length of time specified by tombstone_ttl. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for CreateTaskRequest.

Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

stats

QueueStats

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 target_type. Caller-specified and required in CreateQueue[], after which the queue config type becomes output only, though fields within the config are mutable.

The queue's target.

The target applies to all tasks in the queue. target_type can be only one of the following:

app_engine_http_target

AppEngineHttpTarget

App Engine HTTP target.

An App Engine queue is a queue that has an AppEngineHttpTarget.

pull_target

PullTarget

Pull target.

A pull queue is a queue that has a PullTarget.

http_target

HttpTarget

An http_target is used to override the target values for HTTP tasks.

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 NOT_FOUND and tasks may not be dispatched for a few minutes until the queue has been re-activated.

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. When a pull queue is paused, all LeaseTasks calls will return a FAILED_PRECONDITION. DISABLED

The queue is disabled.

A queue becomes DISABLED when queue.yaml or queue.xml is uploaded which does not contain the queue. You cannot directly disable a queue.

When a queue is disabled, tasks can still be added to a queue but the tasks are not dispatched and LeaseTasks calls return a FAILED_PRECONDITION error.

To permanently delete this queue and all of its tasks, call DeleteQueue.

QueueStats

Statistics for a queue.

Fields tasks_count

int64

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.

oldest_estimated_arrival_time

Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.

executed_last_minute_count

int64

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.

concurrent_dispatches_count

int64

Output only. The number of requests that the queue has dispatched but has not received a reply for yet.

effective_execution_rate

double

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.

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.

Fields max_tasks_dispatched_per_second

double

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_second limit, 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.

max_burst_size

int32

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][RateLimits.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][RateLimits.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][RateLimits.max_dispatches_per_second].

max_concurrent_tasks

int32

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.

RenewLeaseRequest

Request message for renewing a lease using RenewLease.

Fields name

string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.tasks.renewLease

schedule_time

lease_duration

Required. The desired new lease duration, starting from now.

The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.

response_view

View

The response_view specifies which subset of the Task will be returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

ResumeQueueRequest

Request message for ResumeQueue.

Fields name

string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.queues.resume

RetryConfig

Retry config.

These settings determine how a failed task attempt is retried.

Fields max_retry_duration

If positive, max_retry_duration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once max_retry_duration time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted.

If zero, then the task age is unlimited.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

max_retry_duration will be truncated to the nearest second.

This field has the same meaning as task_age_limit in queue.yaml/xml.

min_backoff

A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

min_backoff will be truncated to the nearest second.

This field has the same meaning as min_backoff_seconds in queue.yaml/xml.

max_backoff

A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

max_backoff will be truncated to the nearest second.

This field has the same meaning as max_backoff_seconds in queue.yaml/xml.

max_doublings

int32

The time between retries will double max_doublings times.

A task's retry interval starts at min_backoff, then doubles max_doublings times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times.

For example, if min_backoff is 10s, max_backoff is 300s, and max_doublings is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

This field has the same meaning as max_doublings in queue.yaml/xml.

Union field num_attempts. Number of attempts per task.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field has the same meaning as task_retry_limit in queue.yaml/xml. num_attempts can be only one of the following:

max_attempts

int32

The maximum number of attempts for a task.

Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_attempts - 1 retries). Must be > 0.

unlimited_attempts

bool

If true, then the number of attempts is unlimited.

RunTaskRequest

Request message for forcing a task to run now using RunTask.

Fields name

string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Authorization requires the following IAM permission on the specified resource name:

cloudtasks.tasks.run

response_view

View

The response_view specifies which subset of the Task will be returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

Task

A unit of scheduled work.

Fields name

string

Optionally caller-specified in CreateTask.

The task name.

The task name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
TASK_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

schedule_time

The time when the task is scheduled to be attempted.

For App Engine queues, this is when the task will be attempted or retried.

For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.

schedule_time will be truncated to the nearest microsecond.

create_time

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

status

TaskStatus

Output only. The task status.

view

View

Output only. The view specifies which subset of the Task has been returned.

Union field payload_type. Required.

The task's payload is used by the task's target to process the task. A payload is valid only if it is compatible with the queue's target. payload_type can be only one of the following:

app_engine_http_request

AppEngineHttpRequest

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue.

An App Engine task is a task that has AppEngineHttpRequest set.

pull_message

PullMessage

LeaseTasks to process the task. Can be set only if pull_target is set on the queue.

A pull task is a task that has PullMessage set.

http_request

HttpRequest

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

View

The view specifies a subset of Task data.

When a task is returned in a response, not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Enums VIEW_UNSPECIFIED Unspecified. Defaults to BASIC. BASIC

The basic view omits fields which can be large or can contain sensitive data.

This view does not include the (payload in AppEngineHttpRequest and payload in PullMessage). These payloads are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.

FULL

All information is returned.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Queue resource.

TaskStatus

Status of the task.

Fields attempt_dispatch_count

int32

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.

attempt_response_count

int32

Output only. The number of attempts which have received a response.

This field is not calculated for pull tasks.

first_attempt_status

AttemptStatus

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks.

This field is not calculated for pull tasks.

last_attempt_status

AttemptStatus

Output only. The status of the task's last attempt.

This field is not calculated for pull tasks.

UpdateCmekConfigRequest

Request message for UpdateCmekConfig.

Fields cmek_config

CmekConfig

Required. The config to update. Its name attribute distinguishes it.

Authorization requires the following IAM permission on the specified resource cmekConfig:

cloudtasks.cmekConfig.update

update_mask

List of fields to be updated in this request.

UpdateQueueRequest

Request message for UpdateQueue.

Fields queue

Queue

Required. The queue to create or update.

The queue's name must be specified.

Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

Authorization requires the following IAM permission on the specified resource queue:

cloudtasks.queues.update

update_mask