Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PipelineJob.
An instance of a machine learning PipelineJob.
Generated from protobuf message google.cloud.aiplatform.v1.PipelineJob
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of the PipelineJob. |
↳ display_name |
string
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Pipeline creation time. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. Pipeline start time. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Pipeline end time. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this PipelineJob was most recently updated. |
↳ pipeline_spec |
Google\Protobuf\Struct
The spec of the pipeline. |
↳ state |
int
Output only. The detailed state of the job. |
↳ job_detail |
Google\Cloud\AIPlatform\V1\PipelineJobDetail
Output only. The details of pipeline run. Not available in the list view. |
↳ error |
Google\Rpc\Status
Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. - |
↳ runtime_config |
Google\Cloud\AIPlatform\V1\PipelineJob\RuntimeConfig
Runtime config of the pipeline. |
↳ encryption_spec |
Google\Cloud\AIPlatform\V1\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. |
↳ service_account |
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 |
↳ network |
string
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, |
↳ reserved_ip_ranges |
array
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']. |
↳ template_uri |
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. |
↳ template_metadata |
Google\Cloud\AIPlatform\V1\PipelineTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. |
↳ schedule_name |
string
Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. |
↳ preflight_validations |
bool
Optional. Whether to do component level validations before job creation. |
getName
Output only. The resource name of the PipelineJob.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The resource name of the PipelineJob.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The display name of the Pipeline.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The display name of the Pipeline.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Pipeline creation time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Pipeline creation time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. Pipeline start time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. Pipeline start time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. Pipeline end time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. Pipeline end time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when this PipelineJob was most recently updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this PipelineJob was most recently updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPipelineSpec
The spec of the pipeline.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasPipelineSpec
clearPipelineSpec
setPipelineSpec
The spec of the pipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The detailed state of the job.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The detailed state of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJobDetail
Output only. The details of pipeline run. Not available in the list view.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\PipelineJobDetail|null |
|
hasJobDetail
clearJobDetail
setJobDetail
Output only. The details of pipeline run. Not available in the list view.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\PipelineJobDetail
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getError
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null |
|
hasError
clearError
setError
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuntimeConfig
Runtime config of the pipeline.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\PipelineJob\RuntimeConfig|null |
|
hasRuntimeConfig
clearRuntimeConfig
setRuntimeConfig
Runtime config of the pipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\PipelineJob\RuntimeConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionSpec
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EncryptionSpec|null |
|
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\EncryptionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceAccount
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetwork
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNetwork
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReservedIpRanges
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'].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setReservedIpRanges
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'].
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTemplateUri
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTemplateUri
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\PipelineTemplateMetadata|null |
|
hasTemplateMetadata
clearTemplateMetadata
setTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\PipelineTemplateMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScheduleName
Output only. The schedule resource name.
Only returned if the Pipeline is created by Schedule API.
| Returns | |
|---|---|
| Type | Description |
string |
|
setScheduleName
Output only. The schedule resource name.
Only returned if the Pipeline is created by Schedule API.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreflightValidations
Optional. Whether to do component level validations before job creation.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setPreflightValidations
Optional. Whether to do component level validations before job creation.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|