Cloud AI Platform v1 API - Class PipelineJob (3.11.0) 

public sealed class PipelineJob : IMessage<PipelineJob>, IEquatable<PipelineJob>, IDeepCloneable<PipelineJob>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class PipelineJob.

An instance of a machine learning PipelineJob.

Inheritance

object > PipelineJob

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PipelineJob()

public PipelineJob()

PipelineJob(PipelineJob)

public PipelineJob(PipelineJob other)
Parameter
Name Description
other PipelineJob

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Pipeline creation time.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.

Property Value
Type Description
EncryptionSpec

EndTime

public Timestamp EndTime { get; set; }

Output only. Pipeline end time.

Property Value
Type Description
Timestamp

Error

public Status Error { get; set; }

Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.

Property Value
Type Description
Status

JobDetail

public PipelineJobDetail JobDetail { get; set; }

Output only. The details of pipeline run. Not available in the list view.

Property Value
Type Description
PipelineJobDetail

Labels

public MapField<string, string> Labels { get; }

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.
Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Output only. The resource name of the PipelineJob.

Property Value
Type Description
string

Network

public string Network { get; set; }

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.

Property Value
Type Description
string

NetworkAsNetworkName

public NetworkName NetworkAsNetworkName { get; set; }

NetworkName-typed view over the Network resource name property.

Property Value
Type Description
NetworkName

PipelineJobName

public PipelineJobName PipelineJobName { get; set; }

PipelineJobName-typed view over the Name resource name property.

Property Value
Type Description
PipelineJobName

PipelineSpec

public Struct PipelineSpec { get; set; }

The spec of the pipeline.

Property Value
Type Description
Struct

PreflightValidations

public bool PreflightValidations { get; set; }

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

Property Value
Type Description
bool

ReservedIpRanges

public RepeatedField<string> ReservedIpRanges { get; }

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

Property Value
Type Description
RepeatedFieldstring

RuntimeConfig

public PipelineJob.Types.RuntimeConfig RuntimeConfig { get; set; }

Runtime config of the pipeline.

Property Value
Type Description
PipelineJobTypesRuntimeConfig

ScheduleName

public string ScheduleName { get; set; }

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

Property Value
Type Description
string

ServiceAccount

public string ServiceAccount { get; set; }

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.

Property Value
Type Description
string

StartTime

public Timestamp StartTime { get; set; }

Output only. Pipeline start time.

Property Value
Type Description
Timestamp

State

public PipelineState State { get; set; }

Output only. The detailed state of the job.

Property Value
Type Description
PipelineState

TemplateMetadata

public PipelineTemplateMetadata TemplateMetadata { get; set; }

Output only. Pipeline template metadata. Will fill up fields if [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported template registry.

Property Value
Type Description
PipelineTemplateMetadata

TemplateUri

public string TemplateUri { get; set; }

A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp