Class GoogleCloudAiplatformV1beta1PipelineJob
An instance of a machine learning PipelineJob.
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1.Data
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class GoogleCloudAiplatformV1beta1PipelineJob : IDirectResponseSchema
Properties
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Pipeline creation time.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
DisplayName
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1beta1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1EncryptionSpec |
EndTime
object representation of EndTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type | Description |
---|---|
object |
EndTimeDateTimeOffset
DateTimeOffset representation of EndTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
EndTimeRaw
Output only. Pipeline end time.
Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
Error
Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type | Description |
---|---|
GoogleRpcStatus |
JobDetail
Output only. The details of pipeline run. Not available in the list view.
Declaration
[JsonProperty("jobDetail")]
public virtual GoogleCloudAiplatformV1beta1PipelineJobDetail JobDetail { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1PipelineJobDetail |
Labels
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.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Name
Output only. The resource name of the PipelineJob.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Network
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.
Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
Type | Description |
---|---|
string |
OriginalPipelineJobId
Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
Declaration
[JsonProperty("originalPipelineJobId")]
public virtual long? OriginalPipelineJobId { get; set; }
Property Value
Type | Description |
---|---|
long? |
PipelineSpec
The spec of the pipeline.
Declaration
[JsonProperty("pipelineSpec")]
public virtual IDictionary<string, object> PipelineSpec { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, object> |
PipelineTaskRerunConfigs
Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
Declaration
[JsonProperty("pipelineTaskRerunConfigs")]
public virtual IList<GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig> PipelineTaskRerunConfigs { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig> |
PreflightValidations
Optional. Whether to do component level validations before job creation.
Declaration
[JsonProperty("preflightValidations")]
public virtual bool? PreflightValidations { get; set; }
Property Value
Type | Description |
---|---|
bool? |
PscInterfaceConfig
Optional. Configuration for PSC-I for PipelineJob.
Declaration
[JsonProperty("pscInterfaceConfig")]
public virtual GoogleCloudAiplatformV1beta1PscInterfaceConfig PscInterfaceConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1PscInterfaceConfig |
ReservedIpRanges
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'].
Declaration
[JsonProperty("reservedIpRanges")]
public virtual IList<string> ReservedIpRanges { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
RuntimeConfig
Runtime config of the pipeline.
Declaration
[JsonProperty("runtimeConfig")]
public virtual GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig RuntimeConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig |
SatisfiesPzi
Output only. Reserved for future use.
Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SatisfiesPzs
Output only. Reserved for future use.
Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ScheduleName
Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
Declaration
[JsonProperty("scheduleName")]
public virtual string ScheduleName { get; set; }
Property Value
Type | Description |
---|---|
string |
ServiceAccount
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.
Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type | Description |
---|---|
string |
StartTime
object representation of StartTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
StartTimeDateTimeOffset
DateTimeOffset representation of StartTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
StartTimeRaw
Output only. Pipeline start time.
Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
State
Output only. The detailed state of the job.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |
TemplateMetadata
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
Declaration
[JsonProperty("templateMetadata")]
public virtual GoogleCloudAiplatformV1beta1PipelineTemplateMetadata TemplateMetadata { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1PipelineTemplateMetadata |
TemplateUri
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.
Declaration
[JsonProperty("templateUri")]
public virtual string TemplateUri { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Output only. Timestamp when this PipelineJob was most recently updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |