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()
Methods
public PipelineJob.RuntimeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public PipelineJob.RuntimeConfig build()
public PipelineJob.RuntimeConfig buildPartial()
public PipelineJob.RuntimeConfig.Builder clear()
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;
public PipelineJob.RuntimeConfig.Builder clearField(Descriptors.FieldDescriptor field)
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];
public PipelineJob.RuntimeConfig.Builder clearInputArtifacts()
public PipelineJob.RuntimeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public PipelineJob.RuntimeConfig.Builder clearParameterValues()
public PipelineJob.RuntimeConfig.Builder clearParameters()
public PipelineJob.RuntimeConfig.Builder clone()
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 |
|---|
| Name | Description |
key | String
|
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
|
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
|
public PipelineJob.RuntimeConfig getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
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;
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()
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 | |
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;
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;
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
|
public Map<String,PipelineJob.RuntimeConfig.InputArtifact> getMutableInputArtifacts()
Use alternate mutation accessors instead.
public Map<String,Value> getMutableParameterValues()
Use alternate mutation accessors instead.
public Map<String,Value> getMutableParameters()
Use alternate mutation accessors instead.
public Map<String,Value> getParameterValues()
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 | |
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;
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 | |
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 | |
public Map<String,Value> getParameters()
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 | |
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];
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 | |
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 | |
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
protected MapField internalGetMutableMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public PipelineJob.RuntimeConfig.Builder mergeFrom(PipelineJob.RuntimeConfig other)
public PipelineJob.RuntimeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public PipelineJob.RuntimeConfig.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
public final PipelineJob.RuntimeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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;
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;
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];
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;
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;
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];
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
|
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
|
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
|
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;
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.
|
public PipelineJob.RuntimeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
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.
|
public PipelineJob.RuntimeConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public final PipelineJob.RuntimeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
