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 ( |
Fields | |
---|---|
name |
Output only. The resource name of the PipelineJob. |
displayName |
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
createTime |
Output only. Pipeline creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
startTime |
Output only. Pipeline start time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. Pipeline end time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
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: |
pipelineSpec |
The spec of the pipeline. |
state |
Output only. The detailed state of the job. |
jobDetail |
Output only. The details of pipeline run. Not available in the list view. |
error |
Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED. |
labels |
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. Note there is some reserved label key for Vertex AI Pipelines. - |
runtimeConfig |
Runtime config of the pipeline. |
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 |
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 |
network |
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. |
reservedIpRanges[] |
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. |
templateUri |
A template uri from where the |
templateMetadata |
Output only. Pipeline template metadata. Will fill up fields if |
scheduleName |
Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. |
preflightValidations |
Optional. Whether to do component level validations before job creation. |
PipelineJobDetail
The runtime detail of PipelineJob.
JSON representation |
---|
{ "pipelineContext": { object ( |
Fields | |
---|---|
pipelineContext |
Output only. The context of the pipeline. |
pipelineRunContext |
Output only. The context of the current pipeline run. |
taskDetails[] |
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 ( |
Fields | |
---|---|
taskId |
Output only. The system generated id of the task. |
parentTaskId |
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 |
Output only. The user specified name of the task that is defined in |
createTime |
Output only. Task create time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
startTime |
Output only. Task start time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. Task end time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
executorDetail |
Output only. The detailed execution info. |
state |
Output only. state of the task. |
execution |
Output only. The execution metadata of the task. |
error |
Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. |
pipelineTaskStatus[] |
Output only. A list of task status. This field keeps a record of task status evolving over time. |
inputs |
Output only. The runtime input artifacts of the task. |
outputs |
Output only. The runtime output artifacts of the task. |
PipelineTaskExecutorDetail
The runtime detail of a pipeline executor.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
containerDetail |
Output only. The detailed info for a container executor. |
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, "failedMainJobs": [ string ], "failedPreCachingCheckJobs": [ string ] } |
Fields | |
---|---|
mainJob |
Output only. The name of the |
preCachingCheckJob |
Output only. The name of the |
failedMainJobs[] |
Output only. The names of the previously failed |
failedPreCachingCheckJobs[] |
Output only. The names of the previously failed |
CustomJobDetail
The detailed info for a custom job executor.
JSON representation |
---|
{ "job": string, "failedJobs": [ string ] } |
Fields | |
---|---|
job |
Output only. The name of the |
failedJobs[] |
Output only. The names of the previously failed |
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 ( |
Fields | |
---|---|
updateTime |
Output only. Update time of this status. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. The state of the task. |
error |
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 ( |
Fields | |
---|---|
artifacts[] |
Output only. A list of artifact metadata. |
RuntimeConfig
The runtime config of a PipelineJob.
JSON representation |
---|
{ "parameters": { string: { object ( |
Fields | |
---|---|
parameters |
Deprecated. Use |
gcsOutputDirectory |
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 |
parameterValues |
The runtime parameters of the PipelineJob. The parameters will be passed into |
failurePolicy |
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion. |
inputArtifacts |
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. |
Value
value is the value of the field.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
intValue |
An integer value. |
doubleValue |
A double value. |
stringValue |
A string value. |
PipelineFailurePolicy
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
Enums | |
---|---|
PIPELINE_FAILURE_POLICY_UNSPECIFIED |
Default value, and follows fail slow behavior. |
PIPELINE_FAILURE_POLICY_FAIL_SLOW |
Indicates that the pipeline should continue to run until all possible tasks have been scheduled and completed. |
PIPELINE_FAILURE_POLICY_FAIL_FAST |
Indicates that the pipeline should stop scheduling new tasks after a task has failed. |
InputArtifact
The type of an input artifact.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
artifactId |
Artifact resource id from MLMD. Which is the last portion of an artifact resource name: |
PipelineTemplateMetadata
Pipeline template metadata if PipelineJob.template_uri
is from supported template registry. Currently, the only supported registry is Artifact Registry.
JSON representation |
---|
{ "version": string } |
Fields | |
---|---|
version |
The versionName in artifact registry. Will always be presented in output if the Format is "sha256:abcdef123456...". |
Methods |
|
---|---|
|
Batch cancel PipelineJobs. |
|
Batch deletes PipelineJobs The Operation is atomic. |
|
Cancels a PipelineJob. |
|
Creates a PipelineJob. |
|
Deletes a PipelineJob. |
|
Gets a PipelineJob. |
|
Lists PipelineJobs in a Location. |