Google Cloud Dataplex V1 Client - Class Task (0.8.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Task.

A task represents a user-visible job.

Generated from protobuf message google.cloud.dataplex.v1.Task

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` 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`	`string` 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` Output only. The time when the task was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time when the task was last updated.
`↳ description`	`string` Optional. Description of the task.
`↳ display_name`	`string` Optional. User friendly display name.
`↳ state`	`int` Output only. Current state of the task.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. User-defined labels for the task.
`↳ trigger_spec`	`Google\Cloud\Dataplex\V1\Task\TriggerSpec` Required. Spec related to how often and when a task should be triggered.
`↳ execution_spec`	`Google\Cloud\Dataplex\V1\Task\ExecutionSpec` Required. Spec related to how a task is executed.
`↳ execution_status`	`Google\Cloud\Dataplex\V1\Task\ExecutionStatus` Output only. Status of the latest task executions.
`↳ spark`	`Google\Cloud\Dataplex\V1\Task\SparkTaskConfig` Config related to running custom Spark tasks.
`↳ notebook`	`Google\Cloud\Dataplex\V1\Task\NotebookTaskConfig` Config related to running scheduled Notebooks.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

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.

Returns
Type	Description
`string`

setUid

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time when the task was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the task was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDescription

Optional. Description of the task.

Returns
Type	Description
`string`

setDescription

Optional. Description of the task.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Optional. User friendly display name.

Returns
Type	Description
`string`

setDisplayName

Optional. User friendly display name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. Current state of the task.

Returns
Type	Description
`int`

setState

Output only. Current state of the task.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getLabels

Optional. User-defined labels for the task.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. User-defined labels for the task.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getTriggerSpec

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

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Task\TriggerSpec\|null`

hasTriggerSpec

clearTriggerSpec

setTriggerSpec

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

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Task\TriggerSpec`

Returns
Type	Description
`$this`

getExecutionSpec

Required. Spec related to how a task is executed.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Task\ExecutionSpec\|null`

hasExecutionSpec

clearExecutionSpec

setExecutionSpec

Required. Spec related to how a task is executed.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Task\ExecutionSpec`

Returns
Type	Description
`$this`

getExecutionStatus

Output only. Status of the latest task executions.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Task\ExecutionStatus\|null`

hasExecutionStatus

clearExecutionStatus

setExecutionStatus

Output only. Status of the latest task executions.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Task\ExecutionStatus`

Returns
Type	Description
`$this`

getSpark

Config related to running custom Spark tasks.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Task\SparkTaskConfig\|null`

hasSpark

setSpark

Config related to running custom Spark tasks.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Task\SparkTaskConfig`

Returns
Type	Description
`$this`

getNotebook

Config related to running scheduled Notebooks.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Task\NotebookTaskConfig\|null`

hasNotebook

setNotebook

Config related to running scheduled Notebooks.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Task\NotebookTaskConfig`

Returns
Type	Description
`$this`

getConfig

Returns
Type	Description
`string`