Class StudySpec.ParameterSpec.DiscreteValueSpec (3.45.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.v1.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
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StudySpec.ParameterSpec.DiscreteValueSpec getDefaultInstance()
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilder()
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

newBuilder(StudySpec.ParameterSpec.DiscreteValueSpec prototype)

public static StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilder(StudySpec.ParameterSpec.DiscreteValueSpec prototype)
Parameter
Name Description
prototype StudySpec.ParameterSpec.DiscreteValueSpec
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec.DiscreteValueSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public StudySpec.ParameterSpec.DiscreteValueSpec getDefaultInstanceForType()
Returns
Type Description
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
Type Description
double

The defaultValue.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the defaultValue field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilderForType()
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ParameterSpec.DiscreteValueSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StudySpec.ParameterSpec.DiscreteValueSpec.Builder toBuilder()
Returns
Type Description
StudySpec.ParameterSpec.DiscreteValueSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException