- 1.32.1 (latest)
- 1.32.0
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PipelineTaskDetail.
The runtime detail of a task execution.
Generated from protobuf message google.cloud.aiplatform.v1.PipelineTaskDetail
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ task_id |
int|string
Output only. The system generated ID of the task. |
↳ parent_task_id |
int|string
Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level. |
↳ task_name |
string
Output only. The user specified name of the task that is defined in pipeline_spec. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Task create time. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. Task start time. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Task end time. |
↳ executor_detail |
PipelineTaskExecutorDetail
Output only. The detailed execution info. |
↳ state |
int
Output only. State of the task. |
↳ execution |
Execution
Output only. The execution metadata of the task. |
↳ error |
Google\Rpc\Status
Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. |
↳ pipeline_task_status |
array<PipelineTaskDetail\PipelineTaskStatus>
Output only. A list of task status. This field keeps a record of task status evolving over time. |
↳ inputs |
array|Google\Protobuf\Internal\MapField
Output only. The runtime input artifacts of the task. |
↳ outputs |
array|Google\Protobuf\Internal\MapField
Output only. The runtime output artifacts of the task. |
↳ task_unique_name |
string
Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task". |
getTaskId
Output only. The system generated ID of the task.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTaskId
Output only. The system generated ID of the task.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParentTaskId
Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setParentTaskId
Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskName
Output only. The user specified name of the task that is defined in pipeline_spec.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTaskName
Output only. The user specified name of the task that is defined in pipeline_spec.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Task create time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Task create time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. Task start time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. Task start time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. Task end time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. Task end time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecutorDetail
Output only. The detailed execution info.
| Returns | |
|---|---|
| Type | Description |
PipelineTaskExecutorDetail|null |
|
hasExecutorDetail
clearExecutorDetail
setExecutorDetail
Output only. The detailed execution info.
| Parameter | |
|---|---|
| Name | Description |
var |
PipelineTaskExecutorDetail
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the task.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the task.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecution
Output only. The execution metadata of the task.
| Returns | |
|---|---|
| Type | Description |
Execution|null |
|
hasExecution
clearExecution
setExecution
Output only. The execution metadata of the task.
| Parameter | |
|---|---|
| Name | Description |
var |
Execution
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getError
Output only. The error that occurred during task execution.
Only populated when the task's state is FAILED or CANCELLED.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null |
|
hasError
clearError
setError
Output only. The error that occurred during task execution.
Only populated when the task's state is FAILED or CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPipelineTaskStatus
Output only. A list of task status. This field keeps a record of task status evolving over time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPipelineTaskStatus
Output only. A list of task status. This field keeps a record of task status evolving over time.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PipelineTaskDetail\PipelineTaskStatus>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputs
Output only. The runtime input artifacts of the task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setInputs
Output only. The runtime input artifacts of the task.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputs
Output only. The runtime output artifacts of the task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setOutputs
Output only. The runtime output artifacts of the task.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskUniqueName
Output only. The unique name of a task.
This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
| Returns | |
|---|---|
| Type | Description |
string |
|
setTaskUniqueName
Output only. The unique name of a task.
This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|