Google Cloud Ai Platform V1 Client - Class PipelineTaskDetail (1.0.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 \ V1

Methods

__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 Google\Cloud\AIPlatform\V1\PipelineTaskExecutorDetail

Output only. The detailed execution info.
↳ state int

Output only. State of the task.
↳ execution Google\Cloud\AIPlatform\V1\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<Google\Cloud\AIPlatform\V1\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.

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
Google\Cloud\AIPlatform\V1\PipelineTaskExecutorDetail|null

hasExecutorDetail

clearExecutorDetail

setExecutorDetail

Output only. The detailed execution info.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\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
Google\Cloud\AIPlatform\V1\Execution|null

hasExecution

clearExecution

setExecution

Output only. The execution metadata of the task.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\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<Google\Cloud\AIPlatform\V1\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