- 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
Methods
__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
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.
↳ runtime_config
↳ 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 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.
↳ template_uri
↳ 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.
getName
Output only. The resource name of the PipelineJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the PipelineJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field string display_name = 2;
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.
Generated from protobuf field string display_name = 2;
var
string
$this
getCreateTime
Output only. Pipeline creation time.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Pipeline creation time.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getStartTime
Output only. Pipeline start time.
Generated from protobuf field .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasStartTime
clearStartTime
setStartTime
Output only. Pipeline start time.
Generated from protobuf field .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getEndTime
Output only. Pipeline end time.
Generated from protobuf field .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasEndTime
clearEndTime
setEndTime
Output only. Pipeline end time.
Generated from protobuf field .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. Timestamp when this PipelineJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this PipelineJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getPipelineSpec
The spec of the pipeline.
Generated from protobuf field .google.protobuf.Struct pipeline_spec = 7;
Google\Protobuf\Struct|null
hasPipelineSpec
clearPipelineSpec
setPipelineSpec
The spec of the pipeline.
Generated from protobuf field .google.protobuf.Struct pipeline_spec = 7;
var
Google\Protobuf\Struct
$this
getState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
getJobDetail
Output only. The details of pipeline run. Not available in the list view.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasJobDetail
clearJobDetail
setJobDetail
Output only. The details of pipeline run. Not available in the list view.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getError
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
Generated from protobuf field .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasError
clearError
setError
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
Generated from protobuf field .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
$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.
Generated from protobuf field map<string, string> labels = 11;
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.
Generated from protobuf field map<string, string> labels = 11;
var
array|Google\Protobuf\Internal\MapField
$this
getRuntimeConfig
Runtime config of the pipeline.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
hasRuntimeConfig
clearRuntimeConfig
setRuntimeConfig
Runtime config of the pipeline.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
$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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 16;
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 16;
$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.
Generated from protobuf field string service_account = 17;
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.
Generated from protobuf field string service_account = 17;
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.
Generated from protobuf field string network = 18 [(.google.api.resource_reference) = {
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.
Generated from protobuf field string network = 18 [(.google.api.resource_reference) = {
var
string
$this
getTemplateUri
A template uri from where the PipelineJob.pipeline_spec , if empty, will be downloaded.
Generated from protobuf field string template_uri = 19;
string
setTemplateUri
A template uri from where the PipelineJob.pipeline_spec , if empty, will be downloaded.
Generated from protobuf field string template_uri = 19;
var
string
$this
getTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasTemplateMetadata
clearTemplateMetadata
setTemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
