As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Tasks v2beta2 API

class google.cloud.tasks_v2beta2.types.AcknowledgeTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for acknowledging a task using [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].

name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Type

str

schedule_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.tasks_v2beta2.types.AppEngineHttpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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][google.cloud.tasks.v2beta2.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 and how routing is affected by dispatch files. 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.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineRouting.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 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][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.

http_method

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

The app’s request handler for the task’s target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.

Type

google.cloud.tasks_v2beta2.types.HttpMethod

app_engine_routing

Task-level setting for App Engine routing.

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

Type

google.cloud.tasks_v2beta2.types.AppEngineRouting

relative_url

The relative URL.

The relative URL must begin with “/” and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path “/” will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.

Type

str

headers

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][google.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. 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][google.cloud.tasks.v2beta2.Task]. For more information, see the [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] documentation.

Type

MutableMapping[str, str]

payload

Payload.

The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta2.HttpMethod].

Type

bytes

class HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.tasks_v2beta2.types.AppEngineHttpTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

App Engine HTTP target.

The task will be delivered to the App Engine application hostname specified by its [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]. The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] explains how the task’s host URL is constructed.

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

Overrides for the [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].

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

Type

google.cloud.tasks_v2beta2.types.AppEngineRouting

class google.cloud.tasks_v2beta2.types.AppEngineRouting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.

service

App service.

By default, the task is sent to the service which is the default service when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string.

Type

str

version

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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string.

Type

str

instance

App instance.

By default, the task is sent to an instance which is available when the task is attempted.

Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

Type

str

host

Output only. The host that the task is sent to.

For more information, see 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][google.cloud.tasks.v2beta2.AppEngineRouting.service]

• version = [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

• version_dot_service = [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + '.' + [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

• instance = [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]

• instance_dot_service = [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] + '.' + [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

• instance_dot_version = [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

• instance_dot_version_dot_service = [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + '.' + [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty, then the task will be sent to the service which is the default service when the task is attempted.

If [version][google.cloud.tasks.v2beta2.AppEngineRouting.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.cloud.tasks.v2beta2.AppEngineRouting.service], [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], or [instance][google.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.

Type

str

class google.cloud.tasks_v2beta2.types.AttemptStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of a task attempt.

schedule_time

Output only. The time that this attempt was scheduled.

schedule_time will be truncated to the nearest microsecond.

Type

google.protobuf.timestamp_pb2.Timestamp

dispatch_time

Output only. The time that this attempt was dispatched.

dispatch_time will be truncated to the nearest microsecond.

Type

google.protobuf.timestamp_pb2.Timestamp

response_time

Output only. The time that this attempt response was received.

response_time will be truncated to the nearest microsecond.

Type

google.protobuf.timestamp_pb2.Timestamp

response_status

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.

Type

google.rpc.status_pb2.Status

class google.cloud.tasks_v2beta2.types.BufferTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

LINT.IfChange Request message for [BufferTask][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

queue

Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

The queue must already exist.

Type

str

task_id

Optional. Task ID for the task being created. If not provided, a random task ID is assigned to the task.

Type

str

body

Optional. Body of the HTTP request.

The body can take any generic value. The value is written to the [HttpRequest][payload] of the [Task].

Type

google.api.httpbody_pb2.HttpBody

class google.cloud.tasks_v2beta2.types.BufferTaskResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for [BufferTask][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

task

The created task.

Type

google.cloud.tasks_v2beta2.types.Task

class google.cloud.tasks_v2beta2.types.CancelLeaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for canceling a lease using [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].

name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Type

str

schedule_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

class google.cloud.tasks_v2beta2.types.CreateQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].

parent

Required. The location name in which the queue will be created. For example: projects/PROJECT_ID/locations/LOCATION_ID

The list of allowed locations can be obtained by calling Cloud Tasks’ implementation of [ListLocations][google.cloud.location.Locations.ListLocations].

Type

str

queue

Required. The queue to create.

[Queue’s name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.

Type

google.cloud.tasks_v2beta2.types.Queue

class google.cloud.tasks_v2beta2.types.CreateTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

parent

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

The queue must already exist.

Type

str

task

Required. The task to add.

Task names have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID. The user can optionally specify a task [name][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.Task.name].

If [schedule_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 ~1 hour 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 ~9 days after the original task was deleted or completed.

Because there is an extra lookup cost to identify duplicate task names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.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.

Type

google.cloud.tasks_v2beta2.types.Task

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

class google.cloud.tasks_v2beta2.types.DeleteQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].

name

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Type

str

class google.cloud.tasks_v2beta2.types.DeleteTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].

name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Type

str

class google.cloud.tasks_v2beta2.types.GetQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].

name

Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Type

str

read_mask

Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.tasks_v2beta2.types.GetTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].

name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Type

str

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

class google.cloud.tasks_v2beta2.types.HttpMethod(value)

Bases: proto.enums.Enum

The HTTP method used to execute 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

class google.cloud.tasks_v2beta2.types.HttpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

url

Required. The full url path that the request will be sent to.

This string must begin with either “http://” or “https://”. Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.

Type

str

http_method

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

Type

google.cloud.tasks_v2beta2.types.HttpMethod

headers

HTTP request headers.

This map contains the header field names and values. Headers can be set when running the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

These headers represent a subset of the headers that will accompany the task’s HTTP request. Some HTTP request headers will be ignored or replaced.

A partial list of headers that will be ignored or replaced is:

• Any header that is prefixed with “X-CloudTasks-” will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.

• Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].

• Content-Length: This will be computed by Cloud Tasks.

• User-Agent: This will be set to "Google-Cloud-Tasks".

• X-Google-*: Google use only.

• X-AppEngine-*: Google use only.

Content-Type won’t be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, Content-Type can be set to "application/octet-stream" or "application/json".

Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

The size of the headers must be less than 80KB.

Type

MutableMapping[str, str]

body

HTTP request body.

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

Type

bytes

oauth_token

If specified, an OAuth token 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.

This field is a member of oneof authorization_header.

Type

google.cloud.tasks_v2beta2.types.OAuthToken

oidc_token

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

This field is a member of oneof authorization_header.

Type

google.cloud.tasks_v2beta2.types.OidcToken

class HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.tasks_v2beta2.types.HttpTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

uri_override

Uri override.

When specified, overrides the execution Uri for all the tasks in the queue.

Type

google.cloud.tasks_v2beta2.types.UriOverride

http_method

The HTTP method to use for the request.

When specified, it overrides [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.http_method] for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.

Type

google.cloud.tasks_v2beta2.types.HttpMethod

header_overrides

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

These headers represent a subset of the headers that will accompany the task’s HTTP request. Some HTTP request headers will be ignored or replaced.

A partial list of headers that will be ignored or replaced is:

• Any header that is prefixed with “X-CloudTasks-” will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.

• Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].

• Content-Length: This will be computed by Cloud Tasks.

• User-Agent: This will be set to "Google-CloudTasks".

• X-Google-*: Google use only.

• X-AppEngine-*: Google use only.

Content-Type won’t be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, Content-Type can be set to "application/octet-stream" or "application/json".

Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

Type

MutableSequence[google.cloud.tasks_v2beta2.types.HttpTarget.HeaderOverride]

oauth_token

If specified, an OAuth token 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.

This field is a member of oneof authorization_header.

Type

google.cloud.tasks_v2beta2.types.OAuthToken

oidc_token

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

This field is a member of oneof authorization_header.

Type

google.cloud.tasks_v2beta2.types.OidcToken

class Header(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines a header message. A header can have a key and a value.

key

The key of the header.

Type

str

value

The value of the header.

Type

str

class HeaderOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wraps the Header object.

header

header embodying a key and a value.

Type

google.cloud.tasks_v2beta2.types.HttpTarget.Header

class google.cloud.tasks_v2beta2.types.LeaseTasksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

parent

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Type

str

max_tasks

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.

Type

int

lease_duration

Required. The duration of the lease.

Each task returned in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will have its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the current time plus the lease_duration. The task is leased until its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the task will not be returned to another [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call before its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].

After the worker has successfully finished the work associated with the task, the worker must call via [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that another worker can retry it.

The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.

Type

google.protobuf.duration_pb2.Duration

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

filter

filter can be used to specify a subset of tasks to lease.

When filter is set to tag=<my-tag> then the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to <my-tag>. <my-tag> must be less than 500 characters.

When filter is set to tag_function=oldest_tag(), only tasks which have the same tag as the task with the oldest [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned.

Grammar Syntax:

• filter = "tag=" tag | "tag_function=" function

• tag = string

• function = "oldest_tag()"

The oldest_tag() function returns tasks which have the same tag as the oldest task (ordered by schedule time).

SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren’t UTF-8 encoded can’t be used in the [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task’s [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks.

Type

str

class google.cloud.tasks_v2beta2.types.LeaseTasksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

tasks

The leased tasks.

Type

MutableSequence[google.cloud.tasks_v2beta2.types.Task]

class google.cloud.tasks_v2beta2.types.ListQueuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].

parent

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

Type

str

filter

filter can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.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.

Sample filter “app_engine_http_target: *”.

Note that using filters might cause fewer queues than the requested_page size to be returned.

Type

str

page_size

Requested page size.

The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] in the response to determine if more queues exist.

Type

int

page_token

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 [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] returned from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] method. It is an error to switch the value of the [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages.

Type

str

read_mask

Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.tasks_v2beta2.types.ListQueuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].

queues

The list of queues.

Type

MutableSequence[google.cloud.tasks_v2beta2.types.Queue]

next_page_token

A token to retrieve next page of results.

To return the next page of results, call [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] with this value as the [page_token][google.cloud.tasks.v2beta2.ListQueuesRequest.page_token].

If the next_page_token is empty, there are no more results.

The page token is valid for only 2 hours.

Type

str

class google.cloud.tasks_v2beta2.types.ListTasksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].

parent

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

Type

str

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

page_size

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

Type

int

page_token

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 [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] returned from the previous call to [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] method.

The page token is valid for only 2 hours.

Type

str

class google.cloud.tasks_v2beta2.types.ListTasksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].

tasks

The list of tasks.

Type

MutableSequence[google.cloud.tasks_v2beta2.types.Task]

next_page_token

A token to retrieve next page of results.

To return the next page of results, call [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] with this value as the [page_token][google.cloud.tasks.v2beta2.ListTasksRequest.page_token].

If the next_page_token is empty, there are no more results.

Type

str

class google.cloud.tasks_v2beta2.types.OAuthToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

service_account_email

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

Type

str

scope

OAuth scope to be used for generating OAuth access token. If not specified, “https://www.googleapis.com/auth/cloud-platform” will be used.

Type

str

class google.cloud.tasks_v2beta2.types.OidcToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

service_account_email

Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

Type

str

audience

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

Type

str

class google.cloud.tasks_v2beta2.types.PathOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

PathOverride.

Path message defines path override for HTTP targets.

path

The URI path (e.g., /users/1234). Default is an empty string.

Type

str

class google.cloud.tasks_v2beta2.types.PauseQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].

name

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Type

str

class google.cloud.tasks_v2beta2.types.PullMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The pull message contains data that can be used by the caller of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.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.

payload

A data payload consumed by the worker to execute the task.

Type

bytes

tag

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][google.cloud.tasks.v2beta2.LeaseTasksRequest.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, 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.

Type

str

class google.cloud.tasks_v2beta2.types.PullTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Pull target.

class google.cloud.tasks_v2beta2.types.PurgeQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].

name

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Type

str

class google.cloud.tasks_v2beta2.types.QueryOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

QueryOverride.

Query message defines query override for HTTP targets.

query_params

The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.

Type

str

class google.cloud.tasks_v2beta2.types.Queue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only.

The queue name.

The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

• PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects

• LOCATION_ID is the canonical ID for the queue’s location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. For more information, see https://cloud.google.com/about/locations/.

• QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

Type

str

app_engine_http_target

App Engine HTTP target.

An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].

This field is a member of oneof target_type.

Type

google.cloud.tasks_v2beta2.types.AppEngineHttpTarget

pull_target

Pull target.

A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].

This field is a member of oneof target_type.

Type

google.cloud.tasks_v2beta2.types.PullTarget

http_target

An http_target is used to override the target values for HTTP tasks.

This field is a member of oneof target_type.

Type

google.cloud.tasks_v2beta2.types.HttpTarget

rate_limits

Rate limits for task dispatches.

[rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both control task attempts however they control how tasks are attempted in different ways:

• [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry).

• [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the second attempt, third attempt, etc).

Type

google.cloud.tasks_v2beta2.types.RateLimits

retry_config

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.

Type

google.cloud.tasks_v2beta2.types.RetryConfig

state

Output only. The state of the queue.

state can only be changed by called [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading queue.yaml/xml. [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change state.

Type

google.cloud.tasks_v2beta2.types.Queue.State

purge_time

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 [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the App Engine Task Queue SDK, or the Cloud Console.

Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.

Type

google.protobuf.timestamp_pb2.Timestamp

task_ttl

The maximum amount of time that a task will be retained in this queue.

Queues created by Cloud Tasks have a default task_ttl of 31 days. After a task has lived for task_ttl, the task will be deleted regardless of whether it was dispatched or not.

The task_ttl for queues created via queue.yaml/xml is equal to the maximum duration because there is a storage quota for these queues. To view the maximum valid duration, see the documentation for [Duration][google.protobuf.Duration].

Type

google.protobuf.duration_pb2.Duration

tombstone_ttl

The task tombstone time to live (TTL).

After a task is deleted or completed, the task’s tombstone is retained for the length of time specified by tombstone_ttl. The tombstone is used by task de-duplication; another task with the same name can’t be created until the tombstone has expired. For more information about task de-duplication, see the documentation for [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].

Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

Type

google.protobuf.duration_pb2.Duration

stats

Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.

Type

google.cloud.tasks_v2beta2.types.QueueStats

class State(value)

Bases: proto.enums.Enum

State of the queue.

Values:

STATE_UNSPECIFIED (0):

Unspecified state.

RUNNING (1):

The queue is running. Tasks can be dispatched.

If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and tasks may not be dispatched for a few minutes until the queue has been re-activated.

PAUSED (2):

Tasks are paused by the user. If the queue is paused then Cloud Tasks will stop delivering tasks from it, but more tasks can still be added to it by the user. When a pull queue is paused, all [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION].

DISABLED (3):

The queue is disabled.

A queue becomes DISABLED when queue.yaml or queue.xml is uploaded which does not contain the queue. You cannot directly disable a queue.

When a queue is disabled, tasks can still be added to a queue but the tasks are not dispatched and [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls return a FAILED_PRECONDITION error.

To permanently delete this queue and all of its tasks, call [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].

class google.cloud.tasks_v2beta2.types.QueueStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Statistics for a queue.

tasks_count

Output only. An estimation of the number of tasks in the queue, that is, the tasks in the queue that haven’t been executed, the tasks in the queue which the queue has dispatched but has not yet received a reply for, and the failed tasks that the queue is retrying.

Type

int

oldest_estimated_arrival_time

Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.

Type

google.protobuf.timestamp_pb2.Timestamp

executed_last_minute_count

Output only. The number of tasks that the queue has dispatched and received a reply for during the last minute. This variable counts both successful and non-successful executions.

Type

int

concurrent_dispatches_count

Output only. The number of requests that the queue has dispatched but has not received a reply for yet.

Type

int

effective_execution_rate

Output only. The current maximum number of tasks per second executed by the queue. The maximum value of this variable is controlled by the RateLimits of the Queue. However, this value could be less to avoid overloading the endpoints tasks in the queue are targeting.

Type

float

class google.cloud.tasks_v2beta2.types.RateLimits(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

max_tasks_dispatched_per_second

The maximum rate at which tasks are dispatched from this queue.

If unspecified when the queue is created, Cloud Tasks will pick the default.

• For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum allowed value is 500.

• This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the max_tasks_dispatched_per_second limit, a maximum of 10 QPS of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are allowed per pull queue.

This field has the same meaning as rate in queue.yaml/xml.

Type

float

max_burst_size

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 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_dispatches_per_second][RateLimits.max_dispatches_per_second].

The default value of max_burst_size is picked by Cloud Tasks based on the value of [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

The maximum value of max_burst_size is 500.

For App Engine queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket_size. If [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called on a queue without explicitly setting a value for max_burst_size, max_burst_size value will get updated if [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is updating [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

Type

int

max_concurrent_tasks

The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.

If unspecified when the queue is created, Cloud Tasks will pick the default.

The maximum allowed value is 5,000.

This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which indicates no limit. No other queue types can have max_concurrent_tasks set to -1.

This field has the same meaning as max_concurrent_requests in queue.yaml/xml.

Type

int

class google.cloud.tasks_v2beta2.types.RenewLeaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].

name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Type

str

schedule_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

lease_duration

Required. The desired new lease duration, starting from now.

The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.

Type

google.protobuf.duration_pb2.Duration

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

class google.cloud.tasks_v2beta2.types.ResumeQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].

name

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Type

str

class google.cloud.tasks_v2beta2.types.RetryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

max_attempts

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.

This field is a member of oneof num_attempts.

Type

int

unlimited_attempts

If true, then the number of attempts is unlimited.

This field is a member of oneof num_attempts.

Type

bool

max_retry_duration

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.

Type

google.protobuf.duration_pb2.Duration

min_backoff

A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue’s [RetryConfig][google.cloud.tasks.v2beta2.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].

min_backoff will be truncated to the nearest second.

This field has the same meaning as min_backoff_seconds in queue.yaml/xml.

Type

google.protobuf.duration_pb2.Duration

max_backoff

A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue’s [RetryConfig][google.cloud.tasks.v2beta2.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.

Type

google.protobuf.duration_pb2.Duration

max_doublings

The time between retries will double max_doublings times.

A task’s retry interval starts at [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then doubles max_doublings times, then increases linearly, and finally retries at intervals of [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times.

For example, if [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s, [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] is 300s, and max_doublings is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] until the task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ….

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

This field has the same meaning as max_doublings in queue.yaml/xml.

Type

int

class google.cloud.tasks_v2beta2.types.RunTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].

name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Type

str

response_view

The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

Type

google.cloud.tasks_v2beta2.types.Task.View

class google.cloud.tasks_v2beta2.types.Task(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

The task name.

The task name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

• PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects

• LOCATION_ID is the canonical ID for the task’s location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. For more information, see https://cloud.google.com/about/locations/.

• QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

• TASK_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

Type

str

app_engine_http_request

App Engine HTTP request that is sent to the task’s target. Can be set only if [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set on the queue.

An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set.

This field is a member of oneof payload_type.

Type

google.cloud.tasks_v2beta2.types.AppEngineHttpRequest

pull_message

[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.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][google.cloud.tasks.v2beta2.PullMessage] set.

This field is a member of oneof payload_type.

Type

google.cloud.tasks_v2beta2.types.PullMessage

http_request

HTTP request that is sent to the task’s target.

An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.

This field is a member of oneof payload_type.

Type

google.cloud.tasks_v2beta2.types.HttpRequest

schedule_time

The time when the task is scheduled to be attempted.

For App Engine queues, this is when the task will be attempted or retried.

For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

schedule_time will be truncated to the nearest microsecond.

Type

google.protobuf.timestamp_pb2.Timestamp

create_time

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

Type

google.protobuf.timestamp_pb2.Timestamp

status

Output only. The task status.

Type

google.cloud.tasks_v2beta2.types.TaskStatus

view

Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] has been returned.

Type

google.cloud.tasks_v2beta2.types.Task.View

class View(value)

Bases: proto.enums.Enum

The view specifies a subset of [Task][google.cloud.tasks.v2beta2.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.

Values:

VIEW_UNSPECIFIED (0):

Unspecified. Defaults to BASIC.

BASIC (1):

The basic view omits fields which can be large or can contain sensitive data.

This view does not include the ([payload in AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] and [payload in PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]). These payloads are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.

FULL (2):

All information is returned.

Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Queue][google.cloud.tasks.v2beta2.Queue] resource.

class google.cloud.tasks_v2beta2.types.TaskStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Status of the task.

attempt_dispatch_count

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

Type

int

attempt_response_count

Output only. The number of attempts which have received a response.

This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].

Type

int

first_attempt_status

Output only. The status of the task’s first attempt.

Only [dispatch_time][google.cloud.tasks.v2beta2.AttemptStatus.dispatch_time] will be set. The other [AttemptStatus][google.cloud.tasks.v2beta2.AttemptStatus] information is not retained by Cloud Tasks.

This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].

Type

google.cloud.tasks_v2beta2.types.AttemptStatus

last_attempt_status

Output only. The status of the task’s last attempt.

This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].

Type

google.cloud.tasks_v2beta2.types.AttemptStatus

class google.cloud.tasks_v2beta2.types.UpdateQueueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].

queue

Required. The queue to create or update.

The queue’s [name][google.cloud.tasks.v2beta2.Queue.name] must be specified.

Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue’s [name][google.cloud.tasks.v2beta2.Queue.name] cannot be changed.

Type

google.cloud.tasks_v2beta2.types.Queue

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.tasks_v2beta2.types.UploadQueueYamlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [UploadQueueYaml][google.cloud.tasks.v2beta2.CloudTasks.UploadQueueYaml].

app_id

Required. The App ID is supplied as an HTTP parameter. Unlike internal usage of App ID, it does not include a region prefix. Rather, the App ID represents the Project ID against which to make the request.

Type

str

http_body

The http body contains the queue.yaml file which used to update queue lists

This field is a member of oneof _http_body.

Type

google.api.httpbody_pb2.HttpBody

class google.cloud.tasks_v2beta2.types.UriOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Uri Override.

When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

scheme

Scheme override.

When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).

This field is a member of oneof _scheme.

Type

google.cloud.tasks_v2beta2.types.UriOverride.Scheme

host

Host override.

When specified, replaces the host part of the task URL. For example, if the task URL is “https://www.google.com,” and host value is set to “example.net”, the overridden URI will be changed to “https://example.net.” Host value cannot be an empty string (INVALID_ARGUMENT).

This field is a member of oneof _host.

Type

str

port

Port override.

When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.

This field is a member of oneof _port.

Type

int

path_override

URI path.

When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.

Type

google.cloud.tasks_v2beta2.types.PathOverride

query_override

URI Query.

When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.

Type

google.cloud.tasks_v2beta2.types.QueryOverride

uri_override_enforce_mode

URI Override Enforce Mode

When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.

Type

google.cloud.tasks_v2beta2.types.UriOverride.UriOverrideEnforceMode

class Scheme(value)

Bases: proto.enums.Enum

The Scheme for an HTTP request. By default, it is HTTPS.

Values:

SCHEME_UNSPECIFIED (0):

Scheme unspecified. Defaults to HTTPS.

HTTP (1):

Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.

HTTPS (2):

Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca.

class UriOverrideEnforceMode(value)

Bases: proto.enums.Enum

UriOverrideEnforceMode mode is to define enforcing mode for the override modes.

Values:

URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED (0):

OverrideMode Unspecified. Defaults to ALWAYS.

IF_NOT_EXISTS (1):

In the IF_NOT_EXISTS mode, queue-level configuration is only applied where task-level configuration does not exist.

ALWAYS (2):

In the ALWAYS mode, queue-level configuration overrides all task-level configuration