--- title: "POST /v1/{+parent}/pipelineJobs" method: POST path: "/v1/{+parent}/pipelineJobs" tags: ["projects"] --- # POST /v1/{+parent}/pipelineJobs `POST /v1/{+parent}/pipelineJobs` Creates a PipelineJob. A PipelineJob will run immediately when created. ## Path parameters - `parent` string, required ## Query parameters - `pipelineJobId` string ## Request body - GoogleCloudAiplatformV1PipelineJob — An instance of a machine learning PipelineJob. - `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](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) 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. - `jobDetail` GoogleCloudAiplatformV1PipelineJobDetail — The runtime detail of PipelineJob. - `pipelineContext` GoogleCloudAiplatformV1Context — Instance of a general context. - `schemaTitle` string — The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. - `schemaVersion` string — The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. - `parentContexts` string[] — Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts. - `metadata` object — Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. - `createTime` string, google-datetime — Output only. Timestamp when this Context was created. - `displayName` string — User provided display name of the Context. May be up to 128 Unicode characters. - `name` string — Immutable. The resource name of the Context. - `description` string — Description of the Context - `updateTime` string, google-datetime — Output only. Timestamp when this Context was last updated. - `labels` object — The labels with user-defined metadata to organize your Contexts. 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. No more than 64 user labels can be associated with one Context (System labels are excluded). - `etag` string — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. - `pipelineRunContext` GoogleCloudAiplatformV1Context — Instance of a general context. - `schemaTitle` string — The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. - `schemaVersion` string — The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. - `parentContexts` string[] — Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts. - `metadata` object — Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. - `createTime` string, google-datetime — Output only. Timestamp when this Context was created. - `displayName` string — User provided display name of the Context. May be up to 128 Unicode characters. - `name` string — Immutable. The resource name of the Context. - `description` string — Description of the Context - `updateTime` string, google-datetime — Output only. Timestamp when this Context was last updated. - `labels` object — The labels with user-defined metadata to organize your Contexts. 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. No more than 64 user labels can be associated with one Context (System labels are excluded). - `etag` string — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. - `taskDetails` GoogleCloudAiplatformV1PipelineTaskDetail[] — Output only. The runtime details of the tasks under the pipeline. - `execution` GoogleCloudAiplatformV1Execution — Instance of a general execution. - `updateTime` string, google-datetime — Output only. Timestamp when this Execution was last updated. - `labels` object — The labels with user-defined metadata to organize your Executions. 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. No more than 64 user labels can be associated with one Execution (System labels are excluded). - `etag` string — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. - `schemaTitle` string — The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. - `schemaVersion` string — The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. - `state` 'STATE_UNSPECIFIED' | 'NEW' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CACHED' | 'CANCELLED' — The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions. - `metadata` object — Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. - `createTime` string, google-datetime — Output only. Timestamp when this Execution was created. - `displayName` string — User provided display name of the Execution. May be up to 128 Unicode characters. - `name` string — Output only. The resource name of the Execution. - `description` string — Description of the Execution - `outputs` object — Output only. The runtime output artifacts of the task. - `createTime` string, google-datetime — Output only. Task create time. - `inputs` object — Output only. The runtime input artifacts of the task. - `state` 'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'CANCEL_PENDING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'SKIPPED' | 'NOT_TRIGGERED' — Output only. State of the task. - `taskUniqueName` string — Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task". - `pipelineTaskStatus` GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus[] — Output only. A list of task status. This field keeps a record of task status evolving over time. - `state` 'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'CANCEL_PENDING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'SKIPPED' | 'NOT_TRIGGERED' — Output only. The state of the task. - `error` GoogleRpcStatus — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer — The status code, which should be an enum value of google.rpc.Code. - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use. - `updateTime` string, google-datetime — Output only. Update time of this status. - `taskName` string — Output only. The user specified name of the task that is defined in pipeline_spec. - `taskId` string, int64 — Output only. The system generated ID of the task. - `parentTaskId` string, int64 — 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. - `error` GoogleRpcStatus — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer — The status code, which should be an enum value of google.rpc.Code. - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use. - `executorDetail` GoogleCloudAiplatformV1PipelineTaskExecutorDetail — The runtime detail of a pipeline executor. - `containerDetail` GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail — The detail of a container execution. It contains the job names of the lifecycle of a container execution. - `mainJob` string — Output only. The name of the CustomJob for the main container execution. - `failedPreCachingCheckJobs` string[] — Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order. - `failedMainJobs` string[] — Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order. - `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` GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail — The detailed info for a custom job executor. - `job` string — Output only. The name of the CustomJob. - `failedJobs` string[] — Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order. - `startTime` string, google-datetime — Output only. Task start time. - `endTime` string, google-datetime — Output only. Task end time. - `name` string — Output only. The resource name of the PipelineJob. - `error` GoogleRpcStatus — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer — The status code, which should be an enum value of google.rpc.Code. - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use. - `pscInterfaceConfig` GoogleCloudAiplatformV1PscInterfaceConfig — Configuration for PSC-I. - `networkAttachment` string — Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. - `dnsPeeringConfigs` GoogleCloudAiplatformV1DnsPeeringConfig[] — Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. - `domain` string — Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. - `targetProject` string — Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. - `targetNetwork` string — Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. - `displayName` string — The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. - `endTime` string, google-datetime — Output only. Pipeline end time. - `preflightValidations` boolean — Optional. Whether to do component level validations before job creation. - `encryptionSpec` GoogleCloudAiplatformV1EncryptionSpec — Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. - `kmsKeyName` string — Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. - `startTime` string, 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. - `reservedIpRanges` string[] — 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']. - `scheduleName` string — Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. - `createTime` string, google-datetime — Output only. Pipeline creation time. - `pipelineSpec` object — 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`. - `runtimeConfig` GoogleCloudAiplatformV1PipelineJobRuntimeConfig — The runtime config of a PipelineJob. - `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}/{task_id}/{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` object — 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. - `inputArtifacts` object — The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. - `parameters` object — 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. - `failurePolicy` 'PIPELINE_FAILURE_POLICY_UNSPECIFIED' | 'PIPELINE_FAILURE_POLICY_FAIL_SLOW' | 'PIPELINE_FAILURE_POLICY_FAIL_FAST' — 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. - `templateUri` string — 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. - `labels` object — 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. - `templateMetadata` GoogleCloudAiplatformV1PipelineTemplateMetadata — Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. - `version` string — The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...". - `updateTime` string, google-datetime — Output only. Timestamp when this PipelineJob was most recently updated. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/aiplatform.md) · [All operations](https://skmtc.net/google/apis/aiplatform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/aiplatform/versions/b608d71b91f0/schema)