Cloud Dataplex v1 API - Class Task (2.13.0)

public sealed class Task : IMessage<Task>, IEquatable<Task>, IDeepCloneable<Task>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class Task.

A task represents a user-visible job.

Inheritance

object > Task

Implements

IMessage Task, IEquatable Task, IDeepCloneable Task, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

Task()

public Task()

Task(Task)

public Task(Task other)

Parameter
Name	Description
`other`	`Task`

Properties

ConfigCase

public Task.ConfigOneofCase ConfigCase { get; }

Property Value
Type	Description
`TaskConfigOneofCase`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time when the task was created.

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

Optional. Description of the task.

Property Value
Type	Description
`string`

DisplayName

public string DisplayName { get; set; }

Optional. User friendly display name.

Property Value
Type	Description
`string`

ExecutionSpec

public Task.Types.ExecutionSpec ExecutionSpec { get; set; }

Required. Spec related to how a task is executed.

Property Value
Type	Description
`TaskTypesExecutionSpec`

ExecutionStatus

public Task.Types.ExecutionStatus ExecutionStatus { get; set; }

Output only. Status of the latest task executions.

Property Value
Type	Description
`TaskTypesExecutionStatus`

Labels

public MapField<string, string> Labels { get; }

Optional. User-defined labels for the task.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.

Property Value
Type	Description
`string`

Notebook

public Task.Types.NotebookTaskConfig Notebook { get; set; }

Config related to running scheduled Notebooks.

Property Value
Type	Description
`TaskTypesNotebookTaskConfig`

Spark

public Task.Types.SparkTaskConfig Spark { get; set; }

Config related to running custom Spark tasks.

Property Value
Type	Description
`TaskTypesSparkTaskConfig`

State

public State State { get; set; }

Output only. Current state of the task.

Property Value
Type	Description
`State`

TaskName

public TaskName TaskName { get; set; }

TaskName-typed view over the Name resource name property.

Property Value
Type	Description
`TaskName`

TriggerSpec

public Task.Types.TriggerSpec TriggerSpec { get; set; }

Required. Spec related to how often and when a task should be triggered.

Property Value
Type	Description
`TaskTypesTriggerSpec`

Uid

public string Uid { get; set; }

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.

Property Value
Type	Description
`string`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time when the task was last updated.

Property Value
Type	Description
`Timestamp`