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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public PipelineJob.RuntimeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public PipelineJob.RuntimeConfig build()
Returns
public PipelineJob.RuntimeConfig buildPartial()
Returns
public PipelineJob.RuntimeConfig.Builder clear()
Returns
Overrides
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
public PipelineJob.RuntimeConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
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
public PipelineJob.RuntimeConfig.Builder clearInputArtifacts()
Returns
public PipelineJob.RuntimeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public PipelineJob.RuntimeConfig.Builder clearParameterValues()
Returns
public PipelineJob.RuntimeConfig.Builder clearParameters()
Returns
public PipelineJob.RuntimeConfig.Builder clone()
Returns
Overrides
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
Returns
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
Returns
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
Returns
public PipelineJob.RuntimeConfig getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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
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.
|
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.
|
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.
|
public Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifacts()
Returns
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
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
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
Returns
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
Returns
public Map<String,PipelineJob.RuntimeConfig.InputArtifact> getMutableInputArtifacts()
Use alternate mutation accessors instead.
Returns
public Map<String,Value> getMutableParameterValues()
Use alternate mutation accessors instead.
Returns
public Map<String,Value> getMutableParameters()
Use alternate mutation accessors instead.
Returns
public Map<String,Value> getParameterValues()
Returns
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
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;
Returns
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;
Parameters
Returns
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
Returns
public Map<String,Value> getParameters()
Returns
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
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];
Returns
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];
Parameters
Returns
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
Returns
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public PipelineJob.RuntimeConfig.Builder mergeFrom(PipelineJob.RuntimeConfig other)
Parameter
Returns
public PipelineJob.RuntimeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public PipelineJob.RuntimeConfig.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final PipelineJob.RuntimeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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
Returns
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;
Parameter
Returns
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];
Parameter
Returns
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
Returns
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;
Parameters
Returns
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];
Parameters
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
public PipelineJob.RuntimeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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
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
public PipelineJob.RuntimeConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final PipelineJob.RuntimeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides