Class PipelineJob.RuntimeConfig (3.21.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
TypeDescription
int

GCS_OUTPUT_DIRECTORY_FIELD_NUMBER

public static final int GCS_OUTPUT_DIRECTORY_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_ARTIFACTS_FIELD_NUMBER

public static final int INPUT_ARTIFACTS_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETER_VALUES_FIELD_NUMBER

public static final int PARAMETER_VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PipelineJob.RuntimeConfig getDefaultInstance()
Returns
TypeDescription
PipelineJob.RuntimeConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PipelineJob.RuntimeConfig.Builder newBuilder()
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

newBuilder(PipelineJob.RuntimeConfig prototype)

public static PipelineJob.RuntimeConfig.Builder newBuilder(PipelineJob.RuntimeConfig prototype)
Parameter
NameDescription
prototypePipelineJob.RuntimeConfig
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

parseDelimitedFrom(InputStream input)

public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PipelineJob.RuntimeConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PipelineJob.RuntimeConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PipelineJob.RuntimeConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PipelineJob.RuntimeConfig> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

containsParameters(String key)

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PipelineJob.RuntimeConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for gcsOutputDirectory.

getInputArtifacts()

public Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifacts()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValuePipelineJob.RuntimeConfig.InputArtifact
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
PipelineJob.RuntimeConfig.InputArtifact

getParameterValues()

public Map<String,Value> getParameterValues()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
Value

getParameters()

public Map<String,Value> getParameters()

Use #getParametersMap() instead.

Returns
TypeDescription
Map<String,Value>

getParametersCount()

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
TypeDescription
int

getParametersMap()

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
TypeDescription
Map<String,Value>

getParametersOrDefault(String key, Value defaultValue)

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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getParametersOrThrow(String key)

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
NameDescription
keyString
Returns
TypeDescription
Value

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PipelineJob.RuntimeConfig.Builder newBuilderForType()
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PipelineJob.RuntimeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PipelineJob.RuntimeConfig.Builder toBuilder()
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException