Class StudySpec.ParameterSpec.DiscreteValueSpec (3.20.0)

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

Value specification for a parameter in DISCRETE type.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StudySpec.ParameterSpec.DiscreteValueSpec

Static Fields

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StudySpec.ParameterSpec.DiscreteValueSpec getDefaultInstance()
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec

getDescriptor()

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

newBuilder()

public static StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilder()
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

newBuilder(StudySpec.ParameterSpec.DiscreteValueSpec prototype)

public static StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilder(StudySpec.ParameterSpec.DiscreteValueSpec prototype)
Parameter
NameDescription
prototypeStudySpec.ParameterSpec.DiscreteValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.ParameterSpec.DiscreteValueSpec> parser()
Returns
TypeDescription
Parser<DiscreteValueSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

getParserForType()

public Parser<StudySpec.ParameterSpec.DiscreteValueSpec> getParserForType()
Returns
TypeDescription
Parser<DiscreteValueSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilderForType()
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder toBuilder()
Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

writeTo(CodedOutputStream output)

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