Module types (1.4.0)

API documentation for tasks_v2beta2.types module.

Request message for acknowledging a task using AcknowledgeTask.

Required. The task's current schedule time, available in the [ schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time ] returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.

API documentation for tasks_v2beta2.types.Any class.

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][google.cloud.tasks.v2beta2.Queue.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][google.cloud.tasks.v2beta2.AppEngineHttpTarget.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.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.

Task-level setting for App Engine routing. If set, [app_engi ne_routing_override][google.cloud.tasks.v2beta2.AppEngineHtt pTarget.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.AppEngi neHttpRequest.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.v2beta2.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 [payload][g oogle.cloud.tasks.v2beta2.AppEngineHttpRequest.payload], 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.v2beta2.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://clou d.google.com/appengine/docs/python/taskqueue/push/creating- 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.

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

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

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][google.cloud.tasks.v2beta2.AppEngi neRouting.service], [version][google.cloud.tasks.v2beta2.AppEn gineRouting.version], and [instance][google.cloud.tasks.v2beta 2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEng ineRouting.service], [version][google.cloud.tasks.v2beta2.AppE ngineRouting.version], and [instance][google.cloud.tasks.v2bet a2.AppEngineRouting.instance] are the empty string.

Output only. The host that the task is sent to. For more information, see How Requests are Routed <https://cloud.google.com/appengine/docs/standard/python/how- requests-are-routed>_. The host is constructed as: - host = [application_domain_name]\ `| [service] + '.'

• [application_domain_name]\| [version] + '.' + [application_domain_name]\| [version_dot_service]+ '.' + [application_domain_name]\| [instance] + '.' + [application_domain_name]\| [instance_dot_service] + '.' + [application_domain_name]\| [instance_dot_version] + '.' + [application_domain_name]`| [instance_dot_version_dot_service] + '.' + [application_domain_name] - application_domain_name = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. - service = service
• version = version
• version_dot_service = version + '.' + service
• instance = [instance][google.cloud.tasks.v2beta2.App EngineRouting.instance] - instance_dot_service = [ins tance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] + '.' + service
• instance_dot_version = [instance][google.cloud.tasks .v2beta2.AppEngineRouting.instance] + '.' + version
• instance_dot_version_dot_service = [instance][google .cloud.tasks.v2beta2.AppEngineRouting.instance] + '.' + version + '.' + service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If [instance] [google.cloud.tasks.v2beta2.AppEngineRouting.instance] is empty, then the task will be sent to an instance which is available when the task is attempted. If [service][google.clo ud.tasks.v2beta2.AppEngineRouting.service], [version][google.c loud.tasks.v2beta2.AppEngineRouting.version], or [instance][go ogle.cloud.tasks.v2beta2.AppEngineRouting.instance] is invalid, then the task will be sent to the default version of the default service when the task is attempted.

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 target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.

API documentation for tasks_v2beta2.types.AuditConfig class.

API documentation for tasks_v2beta2.types.AuditConfigDelta class.

API documentation for tasks_v2beta2.types.AuditLogConfig class.

API documentation for tasks_v2beta2.types.Binding class.

API documentation for tasks_v2beta2.types.BindingDelta class.

Request message for canceling a lease using CancelLease.

Required. The task's current schedule time, available in the [ schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time ] returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.

Request message for CreateQueue.

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

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 [schedul e_time][google.cloud.tasks.v2beta2.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 completed 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 completed. 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 completed. 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.

Request message for DeleteQueue.

Request message for deleting a task using DeleteTask.

API documentation for tasks_v2beta2.types.Duration class.

API documentation for tasks_v2beta2.types.Empty class.

API documentation for tasks_v2beta2.types.Expr class.

API documentation for tasks_v2beta2.types.FieldMask class.

API documentation for tasks_v2beta2.types.GetIamPolicyRequest class.

API documentation for tasks_v2beta2.types.GetPolicyOptions class.

Request message for GetQueue.

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.

Request message for leasing tasks using LeaseTasks.

The maximum number of tasks to lease. The system will make a best effort to return as close to as max_tasks as possible. The largest that max_tasks can be is 1000. The maximum total size of a [lease tasks response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.

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.

Response message for leasing tasks using LeaseTasks.

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 "app_engine_http_target: *". 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.v2beta2.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.

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.v2beta 2.ListQueuesRequest.page_token]. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours.

Request message for listing tasks using ListTasks.

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.

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.v2beta2.ListTasksResponse. next_page_token] returned from the previous call to ListTasks method. The page token is valid for only 2 hours.

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.v2beta 2.ListTasksRequest.page_token]. If the next_page_token is empty, there are no more results.

Request message for PauseQueue.

API documentation for tasks_v2beta2.types.Policy class.

API documentation for tasks_v2beta2.types.PolicyDelta class.

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][google.cloud.tasks.v2beta2.Queue.pull_target] set.

The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes <ht tps://cloud.google.com/appengine/docs/standard/java/javadoc/co m/google/appengine/api/taskqueue/TaskOptions.html#tag- byte:A->_, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.

Pull target.

Request message for PurgeQueue.

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.

Caller-specified and required in [CreateQueue][google.cloud.ta sks.v2beta2.CloudTasks.CreateQueue][], after which the queue config type becomes output only, though fields within the config are mutable. The queue's target. The target applies to all tasks in the queue.

Pull target. A pull queue is a queue that has a PullTarget.

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.v2beta2.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueu e][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the App Engine Task Queue SDK, or the Cloud Console <https://cloud.goo gle.com/appengine/docs/standard/python/taskqueue/push/deleting -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.

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_tasks_di spatched_per_second][google.cloud.tasks.v2beta2.RateLimits.m ax_tasks_dispatched_per_second]. Cloud Tasks will pick the value of max_burst_size based on the value of [max_ta sks_dispatched_per_second][google.cloud.tasks.v2beta2.RateL imits.max_tasks_dispatched_per_second]. For App Engine queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket\_size <https://cloud.go ogle.com/appengine/docs/standard/python/config/queueref#bucket _size>. Since max_burst_size is output only, if [Update Queue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called on a queue created by queue.yaml/xml, max_burst_size will be reset based on the value of [max_t asks_dispatched_per_second][google.cloud.tasks.v2beta2.Rate Limits.max_tasks_dispatched_per_second], regardless of whether [max_tasks_dispatched_per_second][google.cloud.tas ks.v2beta2.RateLimits.max_tasks_dispatched_per_second] is updated.

Request message for renewing a lease using RenewLease.

Required. The task's current schedule time, available in the [ schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time ] returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.

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.

Request message for ResumeQueue.

Retry config.

These settings determine how a failed task attempt is retried.

The maximum number of attempts for a task. Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_attempts - 1 retries). Must be > 0.

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.v2beta2.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. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. 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.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.Re tryConfig.min_backoff] and [max_backoff][google.cloud.tasks. v2beta2.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. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. 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>_.

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

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.

API documentation for tasks_v2beta2.types.SetIamPolicyRequest class.

API documentation for tasks_v2beta2.types.Status class.

A unit of scheduled work.

Required. The task's payload is used by the task's target to process the task. A payload is valid only if it is compatible with the queue's target.

LeaseTasks to process the task. Can be set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue. A pull task is a task that has PullMessage set.

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

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

Status of the task.

Output only. The number of attempts which have received a response. This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].

Output only. The status of the task's last attempt. This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].

API documentation for tasks_v2beta2.types.TestIamPermissionsRequest class.

API documentation for tasks_v2beta2.types.TestIamPermissionsResponse class.

API documentation for tasks_v2beta2.types.Timestamp class.

Request message for UpdateQueue.

A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.