- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static interface PipelineJob.RuntimeConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 |
|
getDefaultRuntime()
public abstract PipelineJob.RuntimeConfig.DefaultRuntime getDefaultRuntime()Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.DefaultRuntime default_runtime = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PipelineJob.RuntimeConfig.DefaultRuntime |
The defaultRuntime. |
getDefaultRuntimeOrBuilder()
public abstract PipelineJob.RuntimeConfig.DefaultRuntimeOrBuilder getDefaultRuntimeOrBuilder()Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.DefaultRuntime default_runtime = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PipelineJob.RuntimeConfig.DefaultRuntimeOrBuilder |
|
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 |
|
hasDefaultRuntime()
public abstract boolean hasDefaultRuntime()Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.DefaultRuntime default_runtime = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the defaultRuntime field is set. |