Show / Hide Table of Contents

Class GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig

The runtime config of a PipelineJob.

Inheritance
object
GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1beta1.Data
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig : IDirectResponseSchema

Properties

DefaultRuntime

Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.

Declaration
[JsonProperty("defaultRuntime")]
public virtual GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime DefaultRuntime { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FailurePolicy

Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.

Declaration
[JsonProperty("failurePolicy")]
public virtual string FailurePolicy { get; set; }
Property Value
Type Description
string

GcsOutputDirectory

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.

Declaration
[JsonProperty("gcsOutputDirectory")]
public virtual string GcsOutputDirectory { get; set; }
Property Value
Type Description
string

InputArtifacts

The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.

Declaration
[JsonProperty("inputArtifacts")]
public virtual IDictionary<string, GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact> InputArtifacts { get; set; }
Property Value
Type Description
IDictionary<string, GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact>

ParameterValues

The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.

Declaration
[JsonProperty("parameterValues")]
public virtual IDictionary<string, object> ParameterValues { get; set; }
Property Value
Type Description
IDictionary<string, object>

Parameters

Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Declaration
[JsonProperty("parameters")]
public virtual IDictionary<string, GoogleCloudAiplatformV1beta1Value> Parameters { get; set; }
Property Value
Type Description
IDictionary<string, GoogleCloudAiplatformV1beta1Value>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX