Class Task (2.16.0)

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_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. This field is a member of `oneof`_ `payload_type`.
`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. This field is a member of `oneof`_ `payload_type`.
`http_request`	`google.cloud.tasks_v2beta2.types.HttpRequest` HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. This field is a member of `oneof`_ `payload_type`.
`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.

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

Class Task (2.16.0)

Attributes

Classes

View