Class Task (1.4.0)

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

A task represents a user-visible job.

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

NameDescription
name str
Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.
uid str
Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the task was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the task was last updated.
description str
Optional. Description of the task.
display_name str
Optional. User friendly display name.
state google.cloud.dataplex_v1.types.State
Output only. Current state of the task.
labels MutableMapping[str, str]
Optional. User-defined labels for the task.
trigger_spec google.cloud.dataplex_v1.types.Task.TriggerSpec
Required. Spec related to how often and when a task should be triggered.
execution_spec google.cloud.dataplex_v1.types.Task.ExecutionSpec
Required. Spec related to how a task is executed.
execution_status google.cloud.dataplex_v1.types.Task.ExecutionStatus
Output only. Status of the latest task executions.
spark google.cloud.dataplex_v1.types.Task.SparkTaskConfig
Config related to running custom Spark tasks. This field is a member of oneof_ config.
notebook google.cloud.dataplex_v1.types.Task.NotebookTaskConfig
Config related to running scheduled Notebooks. This field is a member of oneof_ config.

Classes

ExecutionSpec

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

Execution related settings, like retry and service_account.

ExecutionStatus

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

Status of the task execution (e.g. Jobs).

InfrastructureSpec

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

Configuration for the underlying infrastructure used to run workloads.

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

LabelsEntry

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

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

NotebookTaskConfig

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

Config for running scheduled notebooks.

SparkTaskConfig

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

User-specified config for running a Spark 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.

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

TriggerSpec

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