API documentation for tasks_v2beta2.types package.
Classes
AcknowledgeTaskRequest
Request message for acknowledging a task using AcknowledgeTask.
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 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 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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.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`` <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][Task.dispatch_deadline]. Failed tasks will be retried
according to the [retry
configuration][google.cloud.tasks.v2beta2.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.
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 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
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>.
AttemptStatus
The status of a task attempt.
CancelLeaseRequest
Request message for canceling a lease using CancelLease.
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 execute the task.
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.
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
HttpTarget
HTTP target.
When specified as a Queue][target_type], all the tasks with
[HttpRequest] will be overridden according to the target.
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
LeaseTasksRequest
Request message for leasing tasks using LeaseTasks.
LeaseTasksResponse
Response message for leasing tasks using LeaseTasks.
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.
PathOverride
PathOverride.
Path message defines path override for HTTP targets.
PauseQueueRequest
Request message for PauseQueue.
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.
PullTarget
Pull target.
PurgeQueueRequest
Request message for PurgeQueue.
QueryOverride
QueryOverride.
Query message defines query override for HTTP targets.
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.
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
QueueStats
Statistics for a queue.
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.
RenewLeaseRequest
Request message for renewing a lease using RenewLease.
ResumeQueueRequest
Request message for ResumeQueue.
RetryConfig
Retry config.
These settings determine how a failed task attempt is retried.
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
RunTaskRequest
Request message for forcing a task to run now using RunTask.
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
TaskStatus
Status of the task.
UpdateQueueRequest
Request message for UpdateQueue.
UploadQueueYamlRequest
Request message for UploadQueueYaml.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UriOverride
Uri Override.
When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields