package google.cloud.tasks.v2beta3

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 AppEngineHttpQueue

target.proto:146

App Engine HTTP queue. The task will be delivered to the App Engine application hostname specified by its [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]. The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] explains how the task's host URL is constructed. Using [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] 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: Queue

message AppEngineHttpRequest

target.proto:217

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.v2beta3.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.v2beta3.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][google.cloud.tasks.v2beta3.AppEngineHttpQueue.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][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. The `url` that the task will be sent to is: * `url =` [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] `+` [relative_uri][google.cloud.tasks.v2beta3.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.v2beta3.Task.dispatch_deadline]. Failed tasks will be retried according to the [retry configuration][google.cloud.tasks.v2beta3.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:312

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).

Used in: AppEngineHttpQueue, AppEngineHttpRequest

message Attempt

task.proto:172

The status of a task attempt.

Used in: Task

enum HttpMethod

target.proto:379

The HTTP method used to execute the task.

Used in: AppEngineHttpRequest, HttpRequest

message HttpRequest

target.proto:55

HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: [retry configuration][google.cloud.tasks.v2beta3.Queue.retry_config], [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state]. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits] will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden large traffic spikes, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).

Used in: Task

message OAuthToken

target.proto:409

Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Used in: HttpRequest

message OidcToken

target.proto:429

Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Used in: HttpRequest

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:178

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

Used in: Queue

message RetryConfig

queue.proto:249

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

Used in: Queue

message StackdriverLoggingConfig

queue.proto:351

Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).

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.v2beta3.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