- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
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.
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
↳ start_time
↳ end_time
↳ update_time
↳ pipeline_spec
↳ state
int
Output only. The detailed state of the job.
↳ job_detail
↳ 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. - vertex-ai-pipelines-run-billing-id
, user set value will get overrided.
↳ runtime_config
↳ encryption_spec
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 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 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.
↳ 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
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.
string
setName
Output only. The resource name of the PipelineJob.
var
string
$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.
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.
var
string
$this
getCreateTime
Output only. Pipeline creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Pipeline creation time.
$this
getStartTime
Output only. Pipeline start time.
hasStartTime
clearStartTime
setStartTime
Output only. Pipeline start time.
$this
getEndTime
Output only. Pipeline end time.
hasEndTime
clearEndTime
setEndTime
Output only. Pipeline end time.
$this
getUpdateTime
Output only. Timestamp when this PipelineJob was most recently updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this PipelineJob was most recently updated.
$this
getPipelineSpec
The spec of the pipeline.
hasPipelineSpec
clearPipelineSpec
setPipelineSpec
The spec of the pipeline.
$this
getState
Output only. The detailed state of the job.
int
setState
Output only. The detailed state of the job.
var
int
$this
getJobDetail
Output only. The details of pipeline run. Not available in the list view.
hasJobDetail
clearJobDetail
setJobDetail
Output only. The details of pipeline run. Not available in the list view.
$this
getError
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
hasError
clearError
setError
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
$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.
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.
$this
getRuntimeConfig
Runtime config of the pipeline.
hasRuntimeConfig
clearRuntimeConfig
setRuntimeConfig
Runtime config of the pipeline.
$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.
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.
$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.
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.
var
string
$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.
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.
var
string
$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'].
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'].
var
string[]
$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 .
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 .
var
string
$this
getTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
hasTemplateMetadata
clearTemplateMetadata
setTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
$this
getScheduleName
Output only. The schedule resource name.
Only returned if the Pipeline is created by Schedule API.
string
setScheduleName
Output only. The schedule resource name.
Only returned if the Pipeline is created by Schedule API.
var
string
$this
getPreflightValidations
Optional. Whether to do component level validations before job creation.
bool
setPreflightValidations
Optional. Whether to do component level validations before job creation.
var
bool
$this
