Class RuntimeConfig (1.37.0)

  RuntimeConfig 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 ) 
 

The runtime config of a PipelineJob.

Attributes

Name
Description
parameters
MutableMapping[str, google.cloud.aiplatform_v1.types.Value ]
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.
gcs_output_directory
str
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.
parameter_values
MutableMapping[str, google.protobuf.struct_pb2.Value]
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.
failure_policy
google.cloud.aiplatform_v1.types.PipelineFailurePolicy
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.
input_artifacts
MutableMapping[str, google.cloud.aiplatform_v1.types.PipelineJob.RuntimeConfig.InputArtifact ]
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.

Classes

InputArtifact

  InputArtifact 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 ) 
 

InputArtifactsEntry

  InputArtifactsEntry 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 ) 
 

The abstract base class for a message.

Parameters
Name
Description
kwargs
dict

Keys and values corresponding to the fields of the message.

mapping
Union[dict, .Message ]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields
Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ParameterValuesEntry

  ParameterValuesEntry 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 ) 
 

The abstract base class for a message.

Parameters
Name
Description
kwargs
dict

Keys and values corresponding to the fields of the message.

mapping
Union[dict, .Message ]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields
Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ParametersEntry

  ParametersEntry 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 ) 
 

The abstract base class for a message.

Parameters
Name
Description
kwargs
dict

Keys and values corresponding to the fields of the message.

mapping
Union[dict, .Message ]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields
Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Methods

RuntimeConfig

  RuntimeConfig 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 ) 
 

The runtime config of a PipelineJob.