Module types (1.5.2)

API documentation for tasks_v2.types module.

Classes

Any

API documentation for tasks_v2.types.Any class.

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][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 + [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 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][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.

Task-level setting for App Engine routing. - 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][AppEngineHt tpRequest.app_engine_routing].

HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: - User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: - Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-Type to a particular media type when the [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. For example, Content-Type can be set to "application/json". - Content-Length: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: - Host - X-Google-* - X-AppEngine-* In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers <https://cloud.google.com/tasks/docs/creating-appengine- handlers#reading_request_headers>_. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.

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

App version. By default, the task is sent to the version which is the default version 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.

Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed <https://cloud.google.com/appengine/docs/standard/python/how- requests-are-routed>_.

Attempt

The status of a task attempt.

Output only. The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.

Output only. The response from the worker for this attempt. If response_time is unset, then the task has not been attempted or is currently running and the response_status field is meaningless.

AuditConfig

API documentation for tasks_v2.types.AuditConfig class.

AuditConfigDelta

API documentation for tasks_v2.types.AuditConfigDelta class.

AuditLogConfig

API documentation for tasks_v2.types.AuditLogConfig class.

Binding

API documentation for tasks_v2.types.Binding class.

BindingDelta

API documentation for tasks_v2.types.BindingDelta class.

CreateQueueRequest

Request message for CreateQueue.

Required. The queue to create. [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue.

CreateTaskRequest

Request message for CreateTask.

Required. The task to add. Task names have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUE UE_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][google.cloud.tasks.v2.Task.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 executed recently then the call will fail with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS]. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for 1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for 9days after the original task was deleted or executed. 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.

DeleteQueueRequest

Request message for DeleteQueue.

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

Duration

API documentation for tasks_v2.types.Duration class.

Empty

API documentation for tasks_v2.types.Empty class.

Expr

API documentation for tasks_v2.types.Expr class.

FieldMask

API documentation for tasks_v2.types.FieldMask class.

GetIamPolicyRequest

API documentation for tasks_v2.types.GetIamPolicyRequest class.

GetPolicyOptions

API documentation for tasks_v2.types.GetPolicyOptions class.

GetQueueRequest

Request message for GetQueue.

GetTaskRequest

Request message for getting a task using GetTask.

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 <https://cloud.google.com/iam/>_ permission on the Task resource.

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

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

HTTP request body. A request body is allowed only if the [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

If specified, an OAuth token <https://developers.google.com/identity/protocols/OAuth2>_ 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.

ListQueuesRequest

Request message for ListQueues.

\ 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 <https://clo ud.google.com/logging/docs/view/advanced_filters>_. Sample filter "state: PAUSED". Note that using filters might cause fewer queues than the requested page_size to be returned.

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 [ne xt_page_token][google.cloud.tasks.v2.ListQueuesResponse.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.

ListQueuesResponse

Response message for ListQueues.

A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the [page_token][google.cloud.tasks.v2.ListQueu esRequest.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.

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 [ne xt_page_token][google.cloud.tasks.v2.ListTasksResponse.next _page_token] returned from the previous call to ListTasks method. The page token is valid for only 2 hours.

ListTasksResponse

Response message for listing tasks using ListTasks.

A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the [page_token][google.cloud.tasks.v2.ListTask sRequest.page_token]. If the next_page_token is empty, there are no more results.

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.

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

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

PauseQueueRequest

Request message for PauseQueue.

Policy

API documentation for tasks_v2.types.Policy class.

PolicyDelta

API documentation for tasks_v2.types.PolicyDelta class.

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.

Overrides for [task-level app_engine_routing][google.cloud.t asks.v2.AppEngineHttpRequest.app_engine_routing]. These settings apply only to [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this queue. Http tasks are not affected. If set, app_engine_routing_override is used for all [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the queue, no matter what the setting is for the [task-level app_ engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.ap p_engine_routing].

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 <https://cloud.google.com/appengine/docs/standar d/python/taskqueue/push/retrying-tasks>_.

Output only. The last time this queue was purged. All tasks that were [created][google.cloud.tasks.v2.Task.create_time] before this time were purged. A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console <https://clou d.google.com/appengine/docs/standard/python/taskqueue/push/del eting-tasks-and-queues#purging_all_tasks_from_a_queue>_. Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.

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.

Output only. 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 <https://wikipedia.org/wiki/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_dispatche s_per_second][google.cloud.tasks.v2.RateLimits.max_dispatch es_per_second]. Cloud Tasks will pick the value of max_burst_size based on the value of [max_dispatches_per _second][google.cloud.tasks.v2.RateLimits.max_dispatches_pe r_second]. For queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket\_size <https://cloud.google.com/appengine/docs/standar d/python/config/queueref#bucket_size>. Since max_burst_size is output only, if UpdateQueue is called on a queue created by queue.yaml/xml, max_burst_size will be reset based on the value of [max_d ispatches_per_second][google.cloud.tasks.v2.RateLimits.max_ dispatches_per_second], regardless of whether [max_dispatch es_per_second][google.cloud.tasks.v2.RateLimits.max_dispatc hes_per_second] is updated.

ResumeQueueRequest

Request message for ResumeQueue.

RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

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][google.cloud .tasks.v2.RetryConfig.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. max_retry_duration will be truncated to the nearest second. This field has the same meaning as task\_age\_limit in queue.yaml/xml <https://cloud.google.com/appengine/docs/sta ndard/python/config/queueref#retry_parameters>_.

A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.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. max_backoff will be truncated to the nearest second. This field has the same meaning as max\_backoff\_seconds in queue.yaml/xml <https://cloud.google.com/appengine/docs/standa rd/python/config/queueref#retry_parameters>_.

RunTaskRequest

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

SetIamPolicyRequest

API documentation for tasks_v2.types.SetIamPolicyRequest class.

StackdriverLoggingConfig

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

Status

API documentation for tasks_v2.types.Status class.

Task

A unit of scheduled work.

Required. The message to send to the worker.

HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.

Output only. The time that the task was created. create_time will be truncated to the nearest second.

Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.

Output only. The status of the task's first attempt. Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set. The other Attempt information is not retained by Cloud Tasks.

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