Class StudySpec.ParameterSpec.CategoricalValueSpec.Builder (3.28.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.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The values to add.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The values to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the values to add.

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

build()

public StudySpec.ParameterSpec.CategoricalValueSpec build()
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec

buildPartial()

public StudySpec.ParameterSpec.CategoricalValueSpec buildPartial()
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec

clear()

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clear()
Returns
TypeDescription
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
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.

clone()

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clone()
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

getDefaultInstanceForType()

public StudySpec.ParameterSpec.CategoricalValueSpec getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for defaultValue.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the defaultValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StudySpec.ParameterSpec.CategoricalValueSpec other)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(StudySpec.ParameterSpec.CategoricalValueSpec other)
Parameter
NameDescription
otherStudySpec.ParameterSpec.CategoricalValueSpec
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The defaultValue to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for defaultValue to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ParameterSpec.CategoricalValueSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The values to set.

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec.Builder

This builder for chaining.