Interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder (3.56.0)

Version latest

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.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
Type	Description
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
Type	Description
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
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 abstract 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 abstract 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 abstract List<String> getValuesList()

Required. The list of possible categories.

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

Returns
Type	Description
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
Type	Description
boolean	Whether the defaultValue field is set.