package google.cloud.tasks.v2

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service CloudTasks

cloudtasks.proto:39

Cloud Tasks allows developers to manage the execution of background work in their applications.

message AppEngineHttpRequest

target.proto:87

App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) 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](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). 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][google.cloud.tasks.v2.AppEngineRouting] used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If [app_engine_routing_override is set on the queue][Queue.app_engine_routing_override], this value is used for all tasks in the queue, no matter what the setting is for the [task-level app_engine_routing][AppEngineHttpRequest.app_engine_routing]. The `url` that the task will be sent to is: * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+` [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri] Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) 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][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed tasks will be retried according to the [retry configuration][google.cloud.tasks.v2.Queue.retry_config]. `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.

Used in: Task

message AppEngineRouting

target.proto:189

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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform`

Used in: AppEngineHttpRequest, Queue

message Attempt

task.proto:163

The status of a task attempt.

Used in: Task

enum HttpMethod

target.proto:256

The HTTP method used to deliver the task.

Used in: AppEngineHttpRequest

message Queue

queue.proto:34

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.

Used as response type in: CloudTasks.CreateQueue, CloudTasks.GetQueue, CloudTasks.PauseQueue, CloudTasks.PurgeQueue, CloudTasks.ResumeQueue, CloudTasks.UpdateQueue

Used as field type in: CreateQueueRequest, ListQueuesResponse, UpdateQueueRequest

enum Queue.State

queue.proto:41

State of the queue.

Used in: Queue

message RateLimits

queue.proto:177

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][google.cloud.tasks.v2.CloudTasks.RunTask], will run a task even if the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits].

Used in: Queue

message RetryConfig

queue.proto:247

Retry config. These settings determine when a failed task attempt is retried.

Used in: Queue

message Task

task.proto:33

A unit of scheduled work.

Used as response type in: CloudTasks.CreateTask, CloudTasks.GetTask, CloudTasks.RunTask

Used as field type in: CreateTaskRequest, ListTasksResponse

enum Task.View

task.proto:46

The view specifies a subset of [Task][google.cloud.tasks.v2.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.

Used in: CreateTaskRequest, GetTaskRequest, ListTasksRequest, RunTaskRequest, Task