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
Methods
__construct
Constructor.
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
↳ spark
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}.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
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}.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
var
string
$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.
Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getCreateTime
Output only. The time when the task was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the task was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. The time when the task was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the task was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getDescription
Optional. Description of the task.
Generated from protobuf field string description = 5 [(.google.api.field_behavior) = OPTIONAL];
string
setDescription
Optional. Description of the task.
Generated from protobuf field string description = 5 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getDisplayName
Optional. User friendly display name.
Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
string
setDisplayName
Optional. User friendly display name.
Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getState
Output only. Current state of the task.
Generated from protobuf field .google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. Current state of the task.
Generated from protobuf field .google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
getLabels
Optional. User-defined labels for the task.
Generated from protobuf field map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\MapField
setLabels
Optional. User-defined labels for the task.
Generated from protobuf field map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
var
array|Google\Protobuf\Internal\MapField
$this
getTriggerSpec
Required. Spec related to how often and when a task should be triggered.
Generated from protobuf field .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
hasTriggerSpec
clearTriggerSpec
setTriggerSpec
Required. Spec related to how often and when a task should be triggered.
Generated from protobuf field .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
$this
getExecutionSpec
Required. Spec related to how a task is executed.
Generated from protobuf field .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
hasExecutionSpec
clearExecutionSpec
setExecutionSpec
Required. Spec related to how a task is executed.
Generated from protobuf field .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
$this
getSpark
Config related to running custom Spark tasks.
Generated from protobuf field .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
hasSpark
setSpark
Config related to running custom Spark tasks.
Generated from protobuf field .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
$this
getConfig
string
