Class StudySpec.ParameterSpec.DiscreteValueSpec.Builder (3.36.0)

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

Value specification for a parameter in DISCRETE type.

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

Static Methods

getDescriptor()

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

Methods

addAllValues(Iterable<? extends Double> values)

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder addAllValues(Iterable<? extends Double> values)

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends java.lang.Double>

The values to add.

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addValues(double value)

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder addValues(double value)

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuedouble

The values to add.

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

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

clearDefaultValue()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder clearDefaultValue()

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

optional double default_value = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearValues()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder clearValues()

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

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

getDefaultValue()

public double getDefaultValue()

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

optional double default_value = 3;

Returns
TypeDescription
double

The defaultValue.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getValues(int index)

public double getValues(int index)

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
double

The values at the given index.

getValuesCount()

public int getValuesCount()

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The count of values.

getValuesList()

public List<Double> getValuesList()

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Double>

A list containing the values.

hasDefaultValue()

public boolean hasDefaultValue()

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

optional double default_value = 3;

Returns
TypeDescription
boolean

Whether the defaultValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StudySpec.ParameterSpec.DiscreteValueSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDefaultValue(double value)

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder setDefaultValue(double value)

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

optional double default_value = 3;

Parameter
NameDescription
valuedouble

The defaultValue to set.

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setValues(int index, double value)

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder setValues(int index, double value)

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint

The index to set the value at.

valuedouble

The values to set.

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

This builder for chaining.