Console
    Contact Us Start free

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

    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 PipelineJob.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.

    Generated from protobuf field int64 task_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    int|string

    setTaskId

    Output only. The system generated ID of the task.

    Generated from protobuf field int64 task_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field int64 parent_task_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field int64 parent_task_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getTaskName

    Output only. The user specified name of the task that is defined in PipelineJob.spec .

    Generated from protobuf field string task_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    string

    setTaskName

    Output only. The user specified name of the task that is defined in PipelineJob.spec .

    Generated from protobuf field string task_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Task create time.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Task create time.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getStartTime

    Output only. Task start time.

    Generated from protobuf field .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasStartTime

    clearStartTime

    setStartTime

    Output only. Task start time.

    Generated from protobuf field .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEndTime

    Output only. Task end time.

    Generated from protobuf field .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasEndTime

    clearEndTime

    setEndTime

    Output only. Task end time.

    Generated from protobuf field .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getExecutorDetail

    Output only. The detailed execution info.

    Generated from protobuf field .google.cloud.aiplatform.v1.PipelineTaskExecutorDetail executor_detail = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Cloud\AIPlatform\V1\PipelineTaskExecutorDetail |null

    hasExecutorDetail

    clearExecutorDetail

    setExecutorDetail

    Output only. The detailed execution info.

    Generated from protobuf field .google.cloud.aiplatform.v1.PipelineTaskExecutorDetail executor_detail = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Cloud\AIPlatform\V1\PipelineTaskExecutorDetail
    Returns
    Type
    Description
    $this

    getState

    Output only. State of the task.

    Generated from protobuf field .google.cloud.aiplatform.v1.PipelineTaskDetail.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    int

    setState

    Output only. State of the task.

    Generated from protobuf field .google.cloud.aiplatform.v1.PipelineTaskDetail.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getExecution

    Output only. The execution metadata of the task.

    Generated from protobuf field .google.cloud.aiplatform.v1.Execution execution = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Cloud\AIPlatform\V1\Execution |null

    hasExecution

    clearExecution

    setExecution

    Output only. The execution metadata of the task.

    Generated from protobuf field .google.cloud.aiplatform.v1.Execution execution = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field .google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field .google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    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.

    Generated from protobuf field map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setInputs

    Output only. The runtime input artifacts of the task.

    Generated from protobuf field map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    array|Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getOutputs

    Output only. The runtime output artifacts of the task.

    Generated from protobuf field map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setOutputs

    Output only. The runtime output artifacts of the task.

    Generated from protobuf field map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    array|Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: