Class StudySpec.ParameterSpec.CategoricalValueSpec (3.46.0)

public static final class StudySpec.ParameterSpec.CategoricalValueSpec extends GeneratedMessageV3 implements StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Value specification for a parameter in CATEGORICAL type.

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

Inheritance

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

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.CategoricalValueSpec getDefaultInstance()
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec

getDescriptor()

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

newBuilder()

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

newBuilder(StudySpec.ParameterSpec.CategoricalValueSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StudySpec.ParameterSpec.CategoricalValueSpec getDefaultInstanceForType()
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec

getDefaultValue()

public String getDefaultValue()

A default value for a CATEGORICAL parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point.

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

optional string default_value = 3;

Returns
Type Description
String

The defaultValue.

getDefaultValueBytes()

public ByteString getDefaultValueBytes()

A default value for a CATEGORICAL parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point.

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

optional string default_value = 3;

Returns
Type Description
ByteString

The bytes for defaultValue.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValues(int index)

public String getValues(int index)

Required. The list of possible categories.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The values at the given index.

getValuesBytes(int index)

public ByteString getValuesBytes(int index)

Required. The list of possible categories.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the values at the given index.

getValuesCount()

public int getValuesCount()

Required. The list of possible categories.

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

Returns
Type Description
int

The count of values.

getValuesList()

public ProtocolStringList getValuesList()

Required. The list of possible categories.

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

Returns
Type Description
ProtocolStringList

A list containing the values.

hasDefaultValue()

public boolean hasDefaultValue()

A default value for a CATEGORICAL parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point.

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

optional string 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.CategoricalValueSpec.Builder newBuilderForType()
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ParameterSpec.CategoricalValueSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.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.CategoricalValueSpec.Builder toBuilder()
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

writeTo(CodedOutputStream output)

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