Interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder (3.6.0)

public static interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDefaultValue()

public abstract 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
TypeDescription
String

The defaultValue.

getDefaultValueBytes()

public abstract 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
TypeDescription
ByteString

The bytes for defaultValue.

getValues(int index)

public abstract String getValues(int index)

Required. The list of possible categories.

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The values at the given index.

getValuesBytes(int index)

public abstract ByteString getValuesBytes(int index)

Required. The list of possible categories.

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the values at the given index.

getValuesCount()

public abstract int getValuesCount()

Required. The list of possible categories.

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

Returns
TypeDescription
int

The count of values.

getValuesList()

public abstract List<String> getValuesList()

Required. The list of possible categories.

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

Returns
TypeDescription
List<String>

A list containing the values.

hasDefaultValue()

public abstract 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
TypeDescription
boolean

Whether the defaultValue field is set.