Class PipelineJob.RuntimeConfig.Builder (2.7.4)

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.v1.PipelineJob.RuntimeConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.RuntimeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

build()

public PipelineJob.RuntimeConfig build()
Returns
TypeDescription
PipelineJob.RuntimeConfig

buildPartial()

public PipelineJob.RuntimeConfig buildPartial()
Returns
TypeDescription
PipelineJob.RuntimeConfig

clear()

public PipelineJob.RuntimeConfig.Builder clear()
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PipelineJob.RuntimeConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

clearGcsOutputDirectory()

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
TypeDescription
PipelineJob.RuntimeConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PipelineJob.RuntimeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

clearParameterValues()

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

clearParameters()

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

clone()

public PipelineJob.RuntimeConfig.Builder clone()
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

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

getDefaultInstanceForType()

public PipelineJob.RuntimeConfig getDefaultInstanceForType()
Returns
TypeDescription
PipelineJob.RuntimeConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getMutableParameterValues()

public Map<String,Value> getMutableParameterValues()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Value>

getMutableParameters()

public Map<String,Value> getMutableParameters()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Value>

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PipelineJob.RuntimeConfig other)

public PipelineJob.RuntimeConfig.Builder mergeFrom(PipelineJob.RuntimeConfig other)
Parameter
NameDescription
otherPipelineJob.RuntimeConfig
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PipelineJob.RuntimeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PipelineJob.RuntimeConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.RuntimeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

putAllParameterValues(Map<String,Value> values)

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
NameDescription
valuesMap<String,Value>
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

putAllParameters(Map<String,Value> values)

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

Parameter
NameDescription
valuesMap<String,Value>
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

putParameterValues(String key, Value value)

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
NameDescription
keyString
valueValue
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

putParameters(String key, Value value)

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

Parameters
NameDescription
keyString
valueValue
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

removeParameterValues(String key)

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
NameDescription
keyString
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

removeParameters(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.RuntimeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

setGcsOutputDirectory(String value)

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
NameDescription
valueString

The gcsOutputDirectory to set.

Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

This builder for chaining.

setGcsOutputDirectoryBytes(ByteString value)

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
NameDescription
valueByteString

The bytes for gcsOutputDirectory to set.

Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PipelineJob.RuntimeConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.RuntimeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PipelineJob.RuntimeConfig.Builder
Overrides