Class PipelineJob.RuntimeConfig (3.45.0)

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

Static Fields

FAILURE_POLICY_FIELD_NUMBER

public static final int FAILURE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

GCS_OUTPUT_DIRECTORY_FIELD_NUMBER

public static final int GCS_OUTPUT_DIRECTORY_FIELD_NUMBER
Field Value
Type Description
int

INPUT_ARTIFACTS_FIELD_NUMBER

public static final int INPUT_ARTIFACTS_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PARAMETER_VALUES_FIELD_NUMBER

public static final int PARAMETER_VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PipelineJob.RuntimeConfig getDefaultInstance()
Returns
Type Description
PipelineJob.RuntimeConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PipelineJob.RuntimeConfig.Builder newBuilder()
Returns
Type Description
PipelineJob.RuntimeConfig.Builder

newBuilder(PipelineJob.RuntimeConfig prototype)

public static PipelineJob.RuntimeConfig.Builder newBuilder(PipelineJob.RuntimeConfig prototype)
Parameter
Name Description
prototype PipelineJob.RuntimeConfig
Returns
Type Description
PipelineJob.RuntimeConfig.Builder

parseDelimitedFrom(InputStream input)

public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PipelineJob.RuntimeConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PipelineJob.RuntimeConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PipelineJob.RuntimeConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PipelineJob.RuntimeConfig> parser()
Returns
Type Description
Parser<RuntimeConfig>

Methods

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.v1.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.v1.Value> parameters = 1 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PipelineJob.RuntimeConfig getDefaultInstanceForType()
Returns
Type Description
PipelineJob.RuntimeConfig

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.v1.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.v1.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()
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.v1.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.v1.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.v1.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.v1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;

Parameter
Name Description
key String
Returns
Type Description
PipelineJob.RuntimeConfig.InputArtifact

getParameterValues() (deprecated)

public Map<String,Value> getParameterValues()
Returns
Type Description
Map<String,Value>

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;

Returns
Type Description
Map<String,Value>

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;

Parameters
Name Description
key String
defaultValue Value
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.

Returns
Type Description
Map<String,Value>

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.v1.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.v1.Value> parameters = 1 [deprecated = true];

Returns
Type Description
Map<String,Value>

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.v1.Value> parameters = 1 [deprecated = true];

Parameters
Name Description
key String
defaultValue Value
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.v1.Value> parameters = 1 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
Value

getParserForType()

public Parser<PipelineJob.RuntimeConfig> getParserForType()
Returns
Type Description
Parser<RuntimeConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PipelineJob.RuntimeConfig.Builder newBuilderForType()
Returns
Type Description
PipelineJob.RuntimeConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PipelineJob.RuntimeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PipelineJob.RuntimeConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PipelineJob.RuntimeConfig.Builder toBuilder()
Returns
Type Description
PipelineJob.RuntimeConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException