Package types (2.15.0)

API documentation for tasks_v2.types package.

Classes

AppEngineHttpRequest

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 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 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].

The url that the task will be sent to is:

  • url = host + 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 withlogin: 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. 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.

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

Attempt

The status of a task attempt.

CreateQueueRequest

Request message for CreateQueue.

CreateTaskRequest

Request message for CreateTask.

DeleteQueueRequest

Request message for DeleteQueue.

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

GetQueueRequest

Request message for GetQueue.

GetTaskRequest

Request message for getting a task using GetTask.

HttpMethod

The HTTP method used to deliver the task.

Values: HTTP_METHOD_UNSPECIFIED (0): HTTP method unspecified POST (1): HTTP POST GET (2): HTTP GET HEAD (3): HTTP HEAD PUT (4): HTTP PUT DELETE (5): HTTP DELETE PATCH (6): HTTP PATCH OPTIONS (7): HTTP OPTIONS

HttpRequest

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 be 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.v2.Queue.retry_config], [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.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.v2.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 increases in traffic, 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).

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListQueuesRequest

Request message for ListQueues.

ListQueuesResponse

Response message for ListQueues.

ListTasksRequest

Request message for listing tasks using ListTasks.

ListTasksResponse

Response message for listing tasks using ListTasks.

OAuthToken

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.

OidcToken

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.

PauseQueueRequest

Request message for PauseQueue.

PurgeQueueRequest

Request message for PurgeQueue.

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.

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.

ResumeQueueRequest

Request message for ResumeQueue.

RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

RunTaskRequest

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

StackdriverLoggingConfig

Configuration options for writing logs to Stackdriver Logging <https://cloud.google.com/logging/docs/>__.

Task

A unit of scheduled work.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateQueueRequest

Request message for UpdateQueue.