REST Resource: projects.locations.pipelineJobs

Resource: PipelineJob

An instance of a machine learning PipelineJob.

JSON representation 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "pipelineSpec": {
    object
  },
  "state": enum (PipelineState),
  "jobDetail": {
    object (PipelineJobDetail)
  },
  "error": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "runtimeConfig": {
    object (RuntimeConfig)
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  },
  "serviceAccount": string,
  "network": string
}
Fields
name

string

Output only. The resource name of the PipelineJob.
displayName

string

The display name of the Pipeline. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
createTime

string (Timestamp format)

Output only. Pipeline creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. Pipeline start time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. Pipeline end time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Timestamp when this PipelineJob was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
pipelineSpec

object (Struct format)

Required. The spec of the pipeline.
state

enum (PipelineState)

Output only. The detailed state of the job.
jobDetail

object (PipelineJobDetail)

Output only. The details of pipeline run. Not available in the list view.
error

object (Status)

Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
labels

map (key: string, value: string)

The labels with user-defined metadata to organize PipelineJob.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.
runtimeConfig

object (RuntimeConfig)

Runtime config of the pipeline.
encryptionSpec

object (EncryptionSpec)

Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
serviceAccount

string

The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account

Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
network

string

The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name.

Private services access must already be configured for the network. Pipeline job will apply the network configuration to the GCP resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.

PipelineJobDetail

The runtime detail of PipelineJob.

JSON representation 
{
  "pipelineContext": {
    object (Context)
  },
  "pipelineRunContext": {
    object (Context)
  },
  "taskDetails": [
    {
      object (PipelineTaskDetail)
    }
  ]
}
Fields
pipelineContext

object (Context)

Output only. The context of the pipeline.
pipelineRunContext

object (Context)

Output only. The context of the current pipeline run.
taskDetails[]

object (PipelineTaskDetail)

Output only. The runtime details of the tasks under the pipeline.

PipelineTaskDetail

The runtime detail of a task execution.

JSON representation 
{
  "taskId": string,
  "parentTaskId": string,
  "taskName": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "executorDetail": {
    object (PipelineTaskExecutorDetail)
  },
  "state": enum (State),
  "execution": {
    object (Execution)
  },
  "error": {
    object (Status)
  },
  "pipelineTaskStatus": [
    {
      object (PipelineTaskStatus)
    }
  ],
  "inputs": {
    string: {
      object (ArtifactList)
    },
    ...
  },
  "outputs": {
    string: {
      object (ArtifactList)
    },
    ...
  }
}
Fields
taskId

string (int64 format)

Output only. The system generated ID of the task.
parentTaskId

string (int64 format)

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

string

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

string (Timestamp format)

Output only. Task create time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. Task start time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. Task end time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
executorDetail

object (PipelineTaskExecutorDetail)

Output only. The detailed execution info.
state

enum (State)

Output only. State of the task.
execution

object (Execution)

Output only. The execution metadata of the task.
error

object (Status)

Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
pipelineTaskStatus[]

object (PipelineTaskStatus)

Output only. A list of task status. This field keeps a record of task status evolving over time.
inputs

map (key: string, value: object (ArtifactList))

Output only. The runtime input artifacts of the task.
outputs

map (key: string, value: object (ArtifactList))

Output only. The runtime output artifacts of the task.

PipelineTaskExecutorDetail

The runtime detail of a pipeline executor.

JSON representation 
{

  // Union field details can be only one of the following:
  "containerDetail": {
    object (ContainerDetail)
  },
  "customJobDetail": {
    object (CustomJobDetail)
  }
  // End of list of possible types for union field details.
}
Fields

Union field details.

details can be only one of the following:
containerDetail

object (ContainerDetail)

Output only. The detailed info for a container executor.
customJobDetail
(deprecated)

object (CustomJobDetail)

Output only. The detailed info for a custom job executor.

ContainerDetail

The detail of a container execution. It contains the job names of the lifecycle of a container execution.

JSON representation 
{
  "mainJob": string,
  "preCachingCheckJob": string
}
Fields
mainJob

string

Output only. The name of the CustomJob for the main container execution.
preCachingCheckJob

string

Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.

CustomJobDetail

The detailed info for a custom job executor.

JSON representation 
{
  "job": string
}
Fields
job

string

Output only. The name of the CustomJob.

State

Specifies state of TaskExecution

Enums
STATE_UNSPECIFIED Unspecified.
PENDING Specifies pending state for the task.
RUNNING Specifies task is being executed.
SUCCEEDED Specifies task completed successfully.
CANCEL_PENDING Specifies Task cancel is in pending state.
CANCELLING Specifies task is being cancelled.
CANCELLED Specifies task was cancelled.
FAILED Specifies task failed.
SKIPPED Specifies task was skipped due to cache hit.
NOT_TRIGGERED Specifies that the task was not triggered because the task's trigger policy is not satisfied. The trigger policy is specified in the condition field of PipelineJob.pipeline_spec.

PipelineTaskStatus

A single record of the task status.

JSON representation 
{
  "updateTime": string,
  "state": enum (State),
  "error": {
    object (Status)
  }
}
Fields
updateTime

string (Timestamp format)

Output only. Update time of this status.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The state of the task.
error

object (Status)

Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.

ArtifactList

A list of artifact metadata.

JSON representation 
{
  "artifacts": [
    {
      object (Artifact)
    }
  ]
}
Fields
artifacts[]

object (Artifact)

Output only. A list of artifact metadata.

RuntimeConfig

The runtime config of a PipelineJob.

JSON representation 
{
  "parameters": {
    string: {
      object (Value)
    },
    ...
  },
  "gcsOutputDirectory": string,
  "parameterValues": {
    string: value,
    ...
  }
}
Fields
parameters
(deprecated)

map (key: string, value: object (Value))

Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
gcsOutputDirectory

string

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{taskId}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
parameterValues

map (key: string, value: value (Value format))

The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.

Value

Value is the value of the field.

JSON representation 
{

  // Union field value can be only one of the following:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string
  // End of list of possible types for union field value.
}
Fields

Union field value.

value can be only one of the following:
intValue

string (int64 format)

An integer value.
doubleValue

number

A double value.
stringValue

string

A string value.

Methods

cancel

 Cancels a PipelineJob.

create

 Creates a PipelineJob.

delete

 Deletes a PipelineJob.

get

 Gets a PipelineJob.

list

 Lists PipelineJobs in a Location.