Interface PipelineJob.RuntimeConfigOrBuilder (3.47.0) 

public static interface PipelineJob.RuntimeConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsInputArtifacts(String key)

public abstract boolean containsInputArtifacts(String key)

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

map<string, .google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsParameterValues(String key)

public abstract boolean containsParameterValues(String key)

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.

map<string, .google.protobuf.Value> parameter_values = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsParameters(String key) (deprecated)

public abstract boolean containsParameters(String key)

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.

map<string, .google.cloud.aiplatform.v1beta1.Value> parameters = 1 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
boolean

getFailurePolicy()

public abstract PipelineFailurePolicy 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.

.google.cloud.aiplatform.v1beta1.PipelineFailurePolicy failure_policy = 4;

Returns
Type Description
PipelineFailurePolicy

The failurePolicy.

getFailurePolicyValue()

public abstract int getFailurePolicyValue()

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.

.google.cloud.aiplatform.v1beta1.PipelineFailurePolicy failure_policy = 4;

Returns
Type Description
int

The enum numeric value on the wire for failurePolicy.

getGcsOutputDirectory()

public abstract String 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.

string gcs_output_directory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The gcsOutputDirectory.

getGcsOutputDirectoryBytes()

public abstract ByteString getGcsOutputDirectoryBytes()

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.

string gcs_output_directory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for gcsOutputDirectory.

getInputArtifacts() (deprecated)

public abstract Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifacts()

Use #getInputArtifactsMap() instead.

Returns
Type Description
Map<String,InputArtifact>

getInputArtifactsCount()

public abstract int getInputArtifactsCount()

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

map<string, .google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;

Returns
Type Description
int

getInputArtifactsMap()

public abstract Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifactsMap()

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

map<string, .google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;

Returns
Type Description
Map<String,InputArtifact>

getInputArtifactsOrDefault(String key, PipelineJob.RuntimeConfig.InputArtifact defaultValue)

public abstract PipelineJob.RuntimeConfig.InputArtifact getInputArtifactsOrDefault(String key, PipelineJob.RuntimeConfig.InputArtifact defaultValue)

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

map<string, .google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;

Parameters
Name Description
key String
defaultValue PipelineJob.RuntimeConfig.InputArtifact
Returns
Type Description
PipelineJob.RuntimeConfig.InputArtifact

getInputArtifactsOrThrow(String key)

public abstract PipelineJob.RuntimeConfig.InputArtifact getInputArtifactsOrThrow(String key)

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

map<string, .google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;

Parameter
Name Description
key String
Returns
Type Description
PipelineJob.RuntimeConfig.InputArtifact

getParameterValues() (deprecated)

public abstract Map<String,Value> getParameterValues()

Use #getParameterValuesMap() instead.

Returns
Type Description
Map<String,Value>

getParameterValuesCount()

public abstract int getParameterValuesCount()

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.

map<string, .google.protobuf.Value> parameter_values = 3;

Returns
Type Description
int

getParameterValuesMap()

public abstract Map<String,Value> getParameterValuesMap()

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.

map<string, .google.protobuf.Value> parameter_values = 3;

Returns
Type Description
Map<String,Value>

getParameterValuesOrDefault(String key, Value defaultValue)

public abstract Value getParameterValuesOrDefault(String key, Value defaultValue)

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.

map<string, .google.protobuf.Value> parameter_values = 3;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getParameterValuesOrThrow(String key)

public abstract Value getParameterValuesOrThrow(String key)

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.

map<string, .google.protobuf.Value> parameter_values = 3;

Parameter
Name Description
key String
Returns
Type Description
Value

getParameters() (deprecated)

public abstract Map<String,Value> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,Value>

getParametersCount() (deprecated)

public abstract int getParametersCount()

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.

map<string, .google.cloud.aiplatform.v1beta1.Value> parameters = 1 [deprecated = true];

Returns
Type Description
int

getParametersMap() (deprecated)

public abstract Map<String,Value> getParametersMap()

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.

map<string, .google.cloud.aiplatform.v1beta1.Value> parameters = 1 [deprecated = true];

Returns
Type Description
Map<String,Value>

getParametersOrDefault(String key, Value defaultValue) (deprecated)

public abstract Value getParametersOrDefault(String key, Value defaultValue)

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.

map<string, .google.cloud.aiplatform.v1beta1.Value> parameters = 1 [deprecated = true];

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getParametersOrThrow(String key) (deprecated)

public abstract Value getParametersOrThrow(String key)

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.

map<string, .google.cloud.aiplatform.v1beta1.Value> parameters = 1 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
Value