public static final class PipelineJob.RuntimeConfig extends GeneratedMessageV3 implements PipelineJob.RuntimeConfigOrBuilder
The runtime config of a PipelineJob.
Protobuf type google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int FAILURE_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int GCS_OUTPUT_DIRECTORY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INPUT_ARTIFACTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARAMETER_VALUES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static PipelineJob.RuntimeConfig getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static PipelineJob.RuntimeConfig.Builder newBuilder()
public static PipelineJob.RuntimeConfig.Builder newBuilder(PipelineJob.RuntimeConfig prototype)
public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input)
public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PipelineJob.RuntimeConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static PipelineJob.RuntimeConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PipelineJob.RuntimeConfig parseFrom(ByteString data)
public static PipelineJob.RuntimeConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input)
public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PipelineJob.RuntimeConfig parseFrom(InputStream input)
public static PipelineJob.RuntimeConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data)
public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<PipelineJob.RuntimeConfig> parser()
Methods
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.v1.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.v1.Value> parameters = 1 [deprecated = true];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public PipelineJob.RuntimeConfig getDefaultInstanceForType()
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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;
| Parameter |
|---|
| Name | Description |
key | String
|
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.v1.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.v1.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.v1.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.v1.Value> parameters = 1 [deprecated = true];
| Parameter |
|---|
| Name | Description |
key | String
|
| Returns |
|---|
| Type | Description |
Value | |
public Parser<PipelineJob.RuntimeConfig> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public PipelineJob.RuntimeConfig.Builder newBuilderForType()
protected PipelineJob.RuntimeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public PipelineJob.RuntimeConfig.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
