Class Task (2.12.1)

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

A unit of scheduled work.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
`name`	`str` 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
`app_engine_http_request`	`google.cloud.tasks_v2.types.AppEngineHttpRequest` HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set. This field is a member of `oneof`_ `message_type`.
`http_request`	`google.cloud.tasks_v2.types.HttpRequest` HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. This field is a member of `oneof`_ `message_type`.
`schedule_time`	`google.protobuf.timestamp_pb2.Timestamp` The time when the task is scheduled to be attempted or retried. `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.
`dispatch_deadline`	`google.protobuf.duration_pb2.Duration` The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: - For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. - For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the request has the default deadline. The default deadline depends on the `scaling type
`dispatch_count`	`int` Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
`response_count`	`int` Output only. The number of attempts which have received a response.
`first_attempt`	`google.cloud.tasks_v2.types.Attempt` Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
`last_attempt`	`google.cloud.tasks_v2.types.Attempt` Output only. The status of the task's last attempt.
`view`	`google.cloud.tasks_v2.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.

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 [body in
    AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
    Bodies 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
    <xref uid="google.cloud.tasks.v2.Task.View.FULL">FULL</xref> requires
    `cloudtasks.tasks.fullView` `Google
    IAM <https://cloud.google.com/iam/>`__ permission on the
    <xref uid="google.cloud.tasks.v2.Queue">Queue</xref> resource.