Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class RuntimeConfig.
The runtime config of a PipelineJob.
Generated from protobuf message google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parameters |
array|Google\Protobuf\Internal\MapField
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 |
↳ gcs_output_directory |
string
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 |
↳ parameter_values |
array|Google\Protobuf\Internal\MapField
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 |
↳ failure_policy |
int
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 |
array|Google\Protobuf\Internal\MapField
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. |
getParameters
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.
Generated from protobuf field map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setParameters
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.
Generated from protobuf field map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGcsOutputDirectory
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.
Generated from protobuf field string gcs_output_directory = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setGcsOutputDirectory
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.
Generated from protobuf field string gcs_output_directory = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameterValues
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.
Generated from protobuf field map<string, .google.protobuf.Value> parameter_values = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setParameterValues
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.
Generated from protobuf field map<string, .google.protobuf.Value> parameter_values = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFailurePolicy
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.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineFailurePolicy failure_policy = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setFailurePolicy
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.
Generated from protobuf field .google.cloud.aiplatform.v1.PipelineFailurePolicy failure_policy = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputArtifacts
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
Generated from protobuf field map<string, .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setInputArtifacts
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
Generated from protobuf field map<string, .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |