Class Task (2.3.0)

Task(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A unit of scheduled work. .. attribute:: name

Optionally caller-specified in 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 <https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects>__
LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling 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

Attributes

Name	Description
`app_engine_http_request`	`google.cloud.tasks_v2beta2.types.AppEngineHttpRequest` App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
`pull_message`	`google.cloud.tasks_v2beta2.types.PullMessage` LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
`schedule_time`	`google.protobuf.timestamp_pb2.Timestamp` 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. `schedule_time` will be truncated to the nearest microsecond.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
`status`	`google.cloud.tasks_v2beta2.types.TaskStatus` Output only. The task status.
`view`	`google.cloud.tasks_v2beta2.types.Task.View` Output only. The view specifies which subset of the Task has been returned.

Classes

View

View(value)

The view specifies a subset of 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.