Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a PipelineJob. A PipelineJob will run immediately when created.

post/v1/{+parent}/pipelineJobs

Path parameters

parentstring required

Required. The resource name of the Location to create the PipelineJob in. Format: projects/{project}/locations/{location}

Query parameters

pipelineJobIdstring

The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /a-z-/.

Request body

serviceAccountstring

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.

networkstring

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

namestring

Output only. The resource name of the PipelineJob.

displayNamestring

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

endTimestring google-datetime

Output only. Pipeline end time.

preflightValidationsboolean

Optional. Whether to do component level validations before job creation.

startTimestring google-datetime

Output only. Pipeline start time.

state'PIPELINE_STATE_UNSPECIFIED' | 'PIPELINE_STATE_QUEUED' | 'PIPELINE_STATE_PENDING' | 'PIPELINE_STATE_RUNNING' | 'PIPELINE_STATE_SUCCEEDED' | 'PIPELINE_STATE_FAILED' | 'PIPELINE_STATE_CANCELLING' | 'PIPELINE_STATE_CANCELLED' | 'PIPELINE_STATE_PAUSED'

Output only. The detailed state of the job.

reservedIpRangesstring[]

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'].

scheduleNamestring

Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.

createTimestring google-datetime

Output only. Pipeline creation time.

pipelineSpecobject

A compiled definition of a pipeline, represented as a JSON object. Defines the structure of the pipeline, including its components, tasks, and parameters. This specification is generated by compiling a pipeline function defined in Python using the Kubeflow Pipelines SDK.

templateUristring

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.

labelsobject

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. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.

updateTimestring google-datetime

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

Response

Successful response