Class StudySpec.ParameterSpec.Builder (3.19.0)

public static final class StudySpec.ParameterSpec.Builder extends GeneratedMessageV3.Builder<StudySpec.ParameterSpec.Builder> implements StudySpec.ParameterSpecOrBuilder

Represents a single parameter to optimize.

Protobuf type google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec

Static Methods

getDescriptor()

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

Methods

addAllConditionalParameterSpecs(Iterable<? extends StudySpec.ParameterSpec.ConditionalParameterSpec> values)

public StudySpec.ParameterSpec.Builder addAllConditionalParameterSpecs(Iterable<? extends StudySpec.ParameterSpec.ConditionalParameterSpec> values)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec>
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addConditionalParameterSpecs(StudySpec.ParameterSpec.ConditionalParameterSpec value)

public StudySpec.ParameterSpec.Builder addConditionalParameterSpecs(StudySpec.ParameterSpec.ConditionalParameterSpec value)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
valueStudySpec.ParameterSpec.ConditionalParameterSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addConditionalParameterSpecs(StudySpec.ParameterSpec.ConditionalParameterSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder addConditionalParameterSpecs(StudySpec.ParameterSpec.ConditionalParameterSpec.Builder builderForValue)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
builderForValueStudySpec.ParameterSpec.ConditionalParameterSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec value)

public StudySpec.ParameterSpec.Builder addConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec value)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameters
NameDescription
indexint
valueStudySpec.ParameterSpec.ConditionalParameterSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder addConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec.Builder builderForValue)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameters
NameDescription
indexint
builderForValueStudySpec.ParameterSpec.ConditionalParameterSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addConditionalParameterSpecsBuilder()

public StudySpec.ParameterSpec.ConditionalParameterSpec.Builder addConditionalParameterSpecsBuilder()

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpec.Builder

addConditionalParameterSpecsBuilder(int index)

public StudySpec.ParameterSpec.ConditionalParameterSpec.Builder addConditionalParameterSpecsBuilder(int index)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public StudySpec.ParameterSpec build()
Returns
TypeDescription
StudySpec.ParameterSpec

buildPartial()

public StudySpec.ParameterSpec buildPartial()
Returns
TypeDescription
StudySpec.ParameterSpec

clear()

public StudySpec.ParameterSpec.Builder clear()
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

clearCategoricalValueSpec()

public StudySpec.ParameterSpec.Builder clearCategoricalValueSpec()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

clearConditionalParameterSpecs()

public StudySpec.ParameterSpec.Builder clearConditionalParameterSpecs()

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

clearDiscreteValueSpec()

public StudySpec.ParameterSpec.Builder clearDiscreteValueSpec()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

clearDoubleValueSpec()

public StudySpec.ParameterSpec.Builder clearDoubleValueSpec()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public StudySpec.ParameterSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

clearIntegerValueSpec()

public StudySpec.ParameterSpec.Builder clearIntegerValueSpec()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.ParameterSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

clearParameterId()

public StudySpec.ParameterSpec.Builder clearParameterId()

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

This builder for chaining.

clearParameterValueSpec()

public StudySpec.ParameterSpec.Builder clearParameterValueSpec()
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

clearScaleType()

public StudySpec.ParameterSpec.Builder clearScaleType()

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

This builder for chaining.

clone()

public StudySpec.ParameterSpec.Builder clone()
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

getCategoricalValueSpec()

public StudySpec.ParameterSpec.CategoricalValueSpec getCategoricalValueSpec()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec

The categoricalValueSpec.

getCategoricalValueSpecBuilder()

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder getCategoricalValueSpecBuilder()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

getCategoricalValueSpecOrBuilder()

public StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder getCategoricalValueSpecOrBuilder()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

getConditionalParameterSpecs(int index)

public StudySpec.ParameterSpec.ConditionalParameterSpec getConditionalParameterSpecs(int index)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpec

getConditionalParameterSpecsBuilder(int index)

public StudySpec.ParameterSpec.ConditionalParameterSpec.Builder getConditionalParameterSpecsBuilder(int index)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpec.Builder

getConditionalParameterSpecsBuilderList()

public List<StudySpec.ParameterSpec.ConditionalParameterSpec.Builder> getConditionalParameterSpecsBuilderList()

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
List<Builder>

getConditionalParameterSpecsCount()

public int getConditionalParameterSpecsCount()

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
int

getConditionalParameterSpecsList()

public List<StudySpec.ParameterSpec.ConditionalParameterSpec> getConditionalParameterSpecsList()

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
List<ConditionalParameterSpec>

getConditionalParameterSpecsOrBuilder(int index)

public StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder getConditionalParameterSpecsOrBuilder(int index)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder

getConditionalParameterSpecsOrBuilderList()

public List<? extends StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder> getConditionalParameterSpecsOrBuilderList()

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder>

getDefaultInstanceForType()

public StudySpec.ParameterSpec getDefaultInstanceForType()
Returns
TypeDescription
StudySpec.ParameterSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDiscreteValueSpec()

public StudySpec.ParameterSpec.DiscreteValueSpec getDiscreteValueSpec()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec

The discreteValueSpec.

getDiscreteValueSpecBuilder()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder getDiscreteValueSpecBuilder()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

getDiscreteValueSpecOrBuilder()

public StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder getDiscreteValueSpecOrBuilder()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder

getDoubleValueSpec()

public StudySpec.ParameterSpec.DoubleValueSpec getDoubleValueSpec()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
StudySpec.ParameterSpec.DoubleValueSpec

The doubleValueSpec.

getDoubleValueSpecBuilder()

public StudySpec.ParameterSpec.DoubleValueSpec.Builder getDoubleValueSpecBuilder()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
StudySpec.ParameterSpec.DoubleValueSpec.Builder

getDoubleValueSpecOrBuilder()

public StudySpec.ParameterSpec.DoubleValueSpecOrBuilder getDoubleValueSpecOrBuilder()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
StudySpec.ParameterSpec.DoubleValueSpecOrBuilder

getIntegerValueSpec()

public StudySpec.ParameterSpec.IntegerValueSpec getIntegerValueSpec()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.IntegerValueSpec

The integerValueSpec.

getIntegerValueSpecBuilder()

public StudySpec.ParameterSpec.IntegerValueSpec.Builder getIntegerValueSpecBuilder()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.IntegerValueSpec.Builder

getIntegerValueSpecOrBuilder()

public StudySpec.ParameterSpec.IntegerValueSpecOrBuilder getIntegerValueSpecOrBuilder()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.IntegerValueSpecOrBuilder

getParameterId()

public String getParameterId()

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The parameterId.

getParameterIdBytes()

public ByteString getParameterIdBytes()

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for parameterId.

getParameterValueSpecCase()

public StudySpec.ParameterSpec.ParameterValueSpecCase getParameterValueSpecCase()
Returns
TypeDescription
StudySpec.ParameterSpec.ParameterValueSpecCase

getScaleType()

public StudySpec.ParameterSpec.ScaleType getScaleType()

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Returns
TypeDescription
StudySpec.ParameterSpec.ScaleType

The scaleType.

getScaleTypeValue()

public int getScaleTypeValue()

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for scaleType.

hasCategoricalValueSpec()

public boolean hasCategoricalValueSpec()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
boolean

Whether the categoricalValueSpec field is set.

hasDiscreteValueSpec()

public boolean hasDiscreteValueSpec()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
boolean

Whether the discreteValueSpec field is set.

hasDoubleValueSpec()

public boolean hasDoubleValueSpec()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
boolean

Whether the doubleValueSpec field is set.

hasIntegerValueSpec()

public boolean hasIntegerValueSpec()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
boolean

Whether the integerValueSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCategoricalValueSpec(StudySpec.ParameterSpec.CategoricalValueSpec value)

public StudySpec.ParameterSpec.Builder mergeCategoricalValueSpec(StudySpec.ParameterSpec.CategoricalValueSpec value)

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Parameter
NameDescription
valueStudySpec.ParameterSpec.CategoricalValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

mergeDiscreteValueSpec(StudySpec.ParameterSpec.DiscreteValueSpec value)

public StudySpec.ParameterSpec.Builder mergeDiscreteValueSpec(StudySpec.ParameterSpec.DiscreteValueSpec value)

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Parameter
NameDescription
valueStudySpec.ParameterSpec.DiscreteValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

mergeDoubleValueSpec(StudySpec.ParameterSpec.DoubleValueSpec value)

public StudySpec.ParameterSpec.Builder mergeDoubleValueSpec(StudySpec.ParameterSpec.DoubleValueSpec value)

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Parameter
NameDescription
valueStudySpec.ParameterSpec.DoubleValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

mergeFrom(StudySpec.ParameterSpec other)

public StudySpec.ParameterSpec.Builder mergeFrom(StudySpec.ParameterSpec other)
Parameter
NameDescription
otherStudySpec.ParameterSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public StudySpec.ParameterSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

mergeIntegerValueSpec(StudySpec.ParameterSpec.IntegerValueSpec value)

public StudySpec.ParameterSpec.Builder mergeIntegerValueSpec(StudySpec.ParameterSpec.IntegerValueSpec value)

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Parameter
NameDescription
valueStudySpec.ParameterSpec.IntegerValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ParameterSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

removeConditionalParameterSpecs(int index)

public StudySpec.ParameterSpec.Builder removeConditionalParameterSpecs(int index)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setCategoricalValueSpec(StudySpec.ParameterSpec.CategoricalValueSpec value)

public StudySpec.ParameterSpec.Builder setCategoricalValueSpec(StudySpec.ParameterSpec.CategoricalValueSpec value)

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Parameter
NameDescription
valueStudySpec.ParameterSpec.CategoricalValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setCategoricalValueSpec(StudySpec.ParameterSpec.CategoricalValueSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder setCategoricalValueSpec(StudySpec.ParameterSpec.CategoricalValueSpec.Builder builderForValue)

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Parameter
NameDescription
builderForValueStudySpec.ParameterSpec.CategoricalValueSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec value)

public StudySpec.ParameterSpec.Builder setConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec value)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameters
NameDescription
indexint
valueStudySpec.ParameterSpec.ConditionalParameterSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder setConditionalParameterSpecs(int index, StudySpec.ParameterSpec.ConditionalParameterSpec.Builder builderForValue)

A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameters
NameDescription
indexint
builderForValueStudySpec.ParameterSpec.ConditionalParameterSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setDiscreteValueSpec(StudySpec.ParameterSpec.DiscreteValueSpec value)

public StudySpec.ParameterSpec.Builder setDiscreteValueSpec(StudySpec.ParameterSpec.DiscreteValueSpec value)

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Parameter
NameDescription
valueStudySpec.ParameterSpec.DiscreteValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setDiscreteValueSpec(StudySpec.ParameterSpec.DiscreteValueSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder setDiscreteValueSpec(StudySpec.ParameterSpec.DiscreteValueSpec.Builder builderForValue)

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Parameter
NameDescription
builderForValueStudySpec.ParameterSpec.DiscreteValueSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setDoubleValueSpec(StudySpec.ParameterSpec.DoubleValueSpec value)

public StudySpec.ParameterSpec.Builder setDoubleValueSpec(StudySpec.ParameterSpec.DoubleValueSpec value)

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Parameter
NameDescription
valueStudySpec.ParameterSpec.DoubleValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setDoubleValueSpec(StudySpec.ParameterSpec.DoubleValueSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder setDoubleValueSpec(StudySpec.ParameterSpec.DoubleValueSpec.Builder builderForValue)

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Parameter
NameDescription
builderForValueStudySpec.ParameterSpec.DoubleValueSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIntegerValueSpec(StudySpec.ParameterSpec.IntegerValueSpec value)

public StudySpec.ParameterSpec.Builder setIntegerValueSpec(StudySpec.ParameterSpec.IntegerValueSpec value)

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Parameter
NameDescription
valueStudySpec.ParameterSpec.IntegerValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setIntegerValueSpec(StudySpec.ParameterSpec.IntegerValueSpec.Builder builderForValue)

public StudySpec.ParameterSpec.Builder setIntegerValueSpec(StudySpec.ParameterSpec.IntegerValueSpec.Builder builderForValue)

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Parameter
NameDescription
builderForValueStudySpec.ParameterSpec.IntegerValueSpec.Builder
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

setParameterId(String value)

public StudySpec.ParameterSpec.Builder setParameterId(String value)

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The parameterId to set.

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

This builder for chaining.

setParameterIdBytes(ByteString value)

public StudySpec.ParameterSpec.Builder setParameterIdBytes(ByteString value)

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for parameterId to set.

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

This builder for chaining.

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

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

setScaleType(StudySpec.ParameterSpec.ScaleType value)

public StudySpec.ParameterSpec.Builder setScaleType(StudySpec.ParameterSpec.ScaleType value)

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Parameter
NameDescription
valueStudySpec.ParameterSpec.ScaleType

The scaleType to set.

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

This builder for chaining.

setScaleTypeValue(int value)

public StudySpec.ParameterSpec.Builder setScaleTypeValue(int value)

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Parameter
NameDescription
valueint

The enum numeric value on the wire for scaleType to set.

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ParameterSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides