Cloud AI Platform v1 API - Class PipelineJob.Types.RuntimeConfig (2.5.0)

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

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

The runtime config of a PipelineJob.

Inheritance

Object > PipelineJob.Types.RuntimeConfig

Implements

IMessage<PipelineJob.Types.RuntimeConfig>, IEquatable<PipelineJob.Types.RuntimeConfig>, IDeepCloneable<PipelineJob.Types.RuntimeConfig>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

RuntimeConfig()

public RuntimeConfig()

RuntimeConfig(PipelineJob.Types.RuntimeConfig)

public RuntimeConfig(PipelineJob.Types.RuntimeConfig other)

Parameter
Name	Description
`other`	`PipelineJob.Types.RuntimeConfig`

Properties

FailurePolicy

public PipelineFailurePolicy FailurePolicy { get; set; }

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.

Property Value
Type	Description
`PipelineFailurePolicy`

GcsOutputDirectory

public string GcsOutputDirectory { get; set; }

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.

Property Value
Type	Description
`String`

InputArtifacts

public MapField<string, PipelineJob.Types.RuntimeConfig.Types.InputArtifact> InputArtifacts { get; }

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

Property Value
Type	Description
`MapField<String, PipelineJob.Types.RuntimeConfig.Types.InputArtifact>`

Parameters

[Obsolete]
public MapField<string, Value> Parameters { get; }

Deprecated. Use [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values] instead. The runtime parameters of the PipelineJob. The parameters will be passed into [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.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.

Property Value
Type	Description
`MapField<String, Value>`

ParameterValues

public MapField<string, Value> ParameterValues { get; }

The runtime parameters of the PipelineJob. The parameters will be passed into [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.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.

Property Value
Type	Description
`MapField<String, Value>`