- 3.59.0 (latest)
- 3.58.0
- 3.57.0
- 3.56.0
- 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 final class PipelineJob.RuntimeConfig.Builder extends GeneratedMessageV3.Builder<PipelineJob.RuntimeConfig.Builder> implements PipelineJob.RuntimeConfigOrBuilder
The runtime config of a PipelineJob.
Protobuf type google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PipelineJob.RuntimeConfig.BuilderImplements
PipelineJob.RuntimeConfigOrBuilderInherited Members
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PipelineJob.RuntimeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
build()
public PipelineJob.RuntimeConfig build()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig |
buildPartial()
public PipelineJob.RuntimeConfig buildPartial()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig |
clear()
public PipelineJob.RuntimeConfig.Builder clear()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
clearDefaultRuntime()
public PipelineJob.RuntimeConfig.Builder clearDefaultRuntime()
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.Builder |
clearFailurePolicy()
public PipelineJob.RuntimeConfig.Builder clearFailurePolicy()
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 |
PipelineJob.RuntimeConfig.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PipelineJob.RuntimeConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
clearGcsOutputDirectory()
public PipelineJob.RuntimeConfig.Builder clearGcsOutputDirectory()
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 |
PipelineJob.RuntimeConfig.Builder |
This builder for chaining. |
clearInputArtifacts()
public PipelineJob.RuntimeConfig.Builder clearInputArtifacts()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public PipelineJob.RuntimeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
clearParameterValues()
public PipelineJob.RuntimeConfig.Builder clearParameterValues()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
clearParameters() (deprecated)
public PipelineJob.RuntimeConfig.Builder clearParameters()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
clone()
public PipelineJob.RuntimeConfig.Builder clone()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
containsInputArtifacts(String key)
public 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 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 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 |
getDefaultInstanceForType()
public PipelineJob.RuntimeConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig |
getDefaultRuntime()
public 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. |
getDefaultRuntimeBuilder()
public PipelineJob.RuntimeConfig.DefaultRuntime.Builder getDefaultRuntimeBuilder()
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.Builder |
getDefaultRuntimeOrBuilder()
public 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 |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFailurePolicy()
public 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 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 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 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 Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifacts()
Use #getInputArtifactsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,InputArtifact> |
getInputArtifactsCount()
public 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 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 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 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 |
getMutableInputArtifacts() (deprecated)
public Map<String,PipelineJob.RuntimeConfig.InputArtifact> getMutableInputArtifacts()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,InputArtifact> |
getMutableParameterValues() (deprecated)
public Map<String,Value> getMutableParameterValues()
Use alternate mutation accessors instead.
getMutableParameters() (deprecated)
public Map<String,Value> getMutableParameters()
Use alternate mutation accessors instead.
getParameterValues() (deprecated)
public Map<String,Value> getParameterValues()
Use #getParameterValuesMap() instead.
getParameterValuesCount()
public 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 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;
getParameterValuesOrDefault(String key, Value defaultValue)
public 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;
Returns | |
---|---|
Type | Description |
Value |
getParameterValuesOrThrow(String key)
public 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 Map<String,Value> getParameters()
Use #getParametersMap() instead.
getParametersCount() (deprecated)
public 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 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];
getParametersOrDefault(String key, Value defaultValue) (deprecated)
public 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];
Returns | |
---|---|
Type | Description |
Value |
getParametersOrThrow(String key) (deprecated)
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeDefaultRuntime(PipelineJob.RuntimeConfig.DefaultRuntime value)
public PipelineJob.RuntimeConfig.Builder mergeDefaultRuntime(PipelineJob.RuntimeConfig.DefaultRuntime value)
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];
Parameter | |
---|---|
Name | Description |
value |
PipelineJob.RuntimeConfig.DefaultRuntime |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
mergeFrom(PipelineJob.RuntimeConfig other)
public PipelineJob.RuntimeConfig.Builder mergeFrom(PipelineJob.RuntimeConfig other)
Parameter | |
---|---|
Name | Description |
other |
PipelineJob.RuntimeConfig |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PipelineJob.RuntimeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public PipelineJob.RuntimeConfig.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PipelineJob.RuntimeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
putAllInputArtifacts(Map<String,PipelineJob.RuntimeConfig.InputArtifact> values)
public PipelineJob.RuntimeConfig.Builder putAllInputArtifacts(Map<String,PipelineJob.RuntimeConfig.InputArtifact> values)
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 |
values |
Map<String,InputArtifact> |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
putAllParameterValues(Map<String,Value> values)
public PipelineJob.RuntimeConfig.Builder putAllParameterValues(Map<String,Value> values)
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 |
PipelineJob.RuntimeConfig.Builder |
putAllParameters(Map<String,Value> values) (deprecated)
public PipelineJob.RuntimeConfig.Builder putAllParameters(Map<String,Value> values)
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 |
PipelineJob.RuntimeConfig.Builder |
putInputArtifacts(String key, PipelineJob.RuntimeConfig.InputArtifact value)
public PipelineJob.RuntimeConfig.Builder putInputArtifacts(String key, PipelineJob.RuntimeConfig.InputArtifact value)
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 |
value |
PipelineJob.RuntimeConfig.InputArtifact |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
putInputArtifactsBuilderIfAbsent(String key)
public PipelineJob.RuntimeConfig.InputArtifact.Builder putInputArtifactsBuilderIfAbsent(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.Builder |
putParameterValues(String key, Value value)
public PipelineJob.RuntimeConfig.Builder putParameterValues(String key, Value 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.
map<string, .google.protobuf.Value> parameter_values = 3;
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
putParameterValuesBuilderIfAbsent(String key)
public Value.Builder putParameterValuesBuilderIfAbsent(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 |
Builder |
putParameters(String key, Value value) (deprecated)
public PipelineJob.RuntimeConfig.Builder putParameters(String key, Value 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.
map<string, .google.cloud.aiplatform.v1beta1.Value> parameters = 1 [deprecated = true];
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
putParametersBuilderIfAbsent(String key) (deprecated)
public Value.Builder putParametersBuilderIfAbsent(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.Builder |
removeInputArtifacts(String key)
public PipelineJob.RuntimeConfig.Builder removeInputArtifacts(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.Builder |
removeParameterValues(String key)
public PipelineJob.RuntimeConfig.Builder removeParameterValues(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 |
PipelineJob.RuntimeConfig.Builder |
removeParameters(String key) (deprecated)
public PipelineJob.RuntimeConfig.Builder removeParameters(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 |
PipelineJob.RuntimeConfig.Builder |
setDefaultRuntime(PipelineJob.RuntimeConfig.DefaultRuntime value)
public PipelineJob.RuntimeConfig.Builder setDefaultRuntime(PipelineJob.RuntimeConfig.DefaultRuntime value)
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];
Parameter | |
---|---|
Name | Description |
value |
PipelineJob.RuntimeConfig.DefaultRuntime |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
setDefaultRuntime(PipelineJob.RuntimeConfig.DefaultRuntime.Builder builderForValue)
public PipelineJob.RuntimeConfig.Builder setDefaultRuntime(PipelineJob.RuntimeConfig.DefaultRuntime.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
PipelineJob.RuntimeConfig.DefaultRuntime.Builder |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
setFailurePolicy(PipelineFailurePolicy value)
public PipelineJob.RuntimeConfig.Builder setFailurePolicy(PipelineFailurePolicy value)
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;
Parameter | |
---|---|
Name | Description |
value |
PipelineFailurePolicy The failurePolicy to set. |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
This builder for chaining. |
setFailurePolicyValue(int value)
public PipelineJob.RuntimeConfig.Builder setFailurePolicyValue(int value)
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;
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for failurePolicy to set. |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PipelineJob.RuntimeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
setGcsOutputDirectory(String value)
public PipelineJob.RuntimeConfig.Builder setGcsOutputDirectory(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The gcsOutputDirectory to set. |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
This builder for chaining. |
setGcsOutputDirectoryBytes(ByteString value)
public PipelineJob.RuntimeConfig.Builder setGcsOutputDirectoryBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for gcsOutputDirectory to set. |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PipelineJob.RuntimeConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PipelineJob.RuntimeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PipelineJob.RuntimeConfig.Builder |