Class StudySpec.ParameterSpec.CategoricalValueSpec.Builder (3.43.0)

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

Value specification for a parameter in CATEGORICAL type.

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

Static Methods

getDescriptor()

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

Methods

addAllValues(Iterable<String> values)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder addAllValues(Iterable<String> values)

Required. The list of possible categories.

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

Parameter
Name Description
values Iterable<String>

The values to add.

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

addValues(String value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder addValues(String value)

Required. The list of possible categories.

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

Parameter
Name Description
value String

The values to add.

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

addValuesBytes(ByteString value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder addValuesBytes(ByteString value)

Required. The list of possible categories.

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

Parameter
Name Description
value ByteString

The bytes of the values to add.

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clear()
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

clearDefaultValue()

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearDefaultValue()

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
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

clearValues()

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearValues()

Required. The list of possible categories.

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

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StudySpec.ParameterSpec.CategoricalValueSpec other)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(StudySpec.ParameterSpec.CategoricalValueSpec other)
Parameter
Name Description
other StudySpec.ParameterSpec.CategoricalValueSpec
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

setDefaultValue(String value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder setDefaultValue(String value)

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;

Parameter
Name Description
value String

The defaultValue to set.

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

setDefaultValueBytes(ByteString value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder setDefaultValueBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for defaultValue to set.

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ParameterSpec.CategoricalValueSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

setValues(int index, String value)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder setValues(int index, String value)

Required. The list of possible categories.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The values to set.

Returns
Type Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.