com.google.cloud.aiplatform.v1

Class StudySpec.ParameterSpec.CategoricalValueSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

com.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec.Builder

All Implemented Interfaces:

StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StudySpec.ParameterSpec.CategoricalValueSpec

public static final class StudySpec.ParameterSpec.CategoricalValueSpec.Builder
extends com.google.protobuf.GeneratedMessage.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

Method Summary

Modifier and Type	Method and Description
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	addAllValues(Iterable<String> values) Required.
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	addValues(String value) Required.
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	addValuesBytes(com.google.protobuf.ByteString value) Required.
StudySpec.ParameterSpec.CategoricalValueSpec	build()
StudySpec.ParameterSpec.CategoricalValueSpec	buildPartial()
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	clear()
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	clearDefaultValue() A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	clearValues() Required.
StudySpec.ParameterSpec.CategoricalValueSpec	getDefaultInstanceForType()
String	getDefaultValue() A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.
com.google.protobuf.ByteString	getDefaultValueBytes() A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getValues(int index) Required.
com.google.protobuf.ByteString	getValuesBytes(int index) Required.
int	getValuesCount() Required.
com.google.protobuf.ProtocolStringList	getValuesList() Required.
boolean	hasDefaultValue() A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	mergeFrom(com.google.protobuf.Message other)
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	mergeFrom(StudySpec.ParameterSpec.CategoricalValueSpec other)
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	setDefaultValue(String value) A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	setDefaultValueBytes(com.google.protobuf.ByteString value) A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	setValues(int index, String value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

clear

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

getDefaultInstanceForType

public StudySpec.ParameterSpec.CategoricalValueSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public StudySpec.ParameterSpec.CategoricalValueSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public StudySpec.ParameterSpec.CategoricalValueSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

mergeFrom

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(StudySpec.ParameterSpec.CategoricalValueSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

mergeFrom

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.ParameterSpec.CategoricalValueSpec.Builder>

Throws:

IOException

getValuesList

public com.google.protobuf.ProtocolStringList getValuesList()

 Required. The list of possible categories.
 

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

Specified by:

getValuesList in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Returns:

A list containing the values.

getValuesCount

public int getValuesCount()

 Required. The list of possible categories.
 

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

Specified by:

getValuesCount in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Returns:

The count of values.

getValues

public String getValues(int index)

 Required. The list of possible categories.
 

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

Specified by:

getValues in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The values at the given index.

getValuesBytes

public com.google.protobuf.ByteString getValuesBytes(int index)

 Required. The list of possible categories.
 

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

Specified by:

getValuesBytes in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the values at the given index.

setValues

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:

index - The index to set the value at.

value - The values to set.

Returns:

This builder for chaining.

addValues

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

 Required. The list of possible categories.
 

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

Parameters:

value - The values to add.

Returns:

This builder for chaining.

addAllValues

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

 Required. The list of possible categories.
 

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

Parameters:

values - The values to add.

Returns:

This builder for chaining.

clearValues

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder clearValues()

 Required. The list of possible categories.
 

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

Returns:

This builder for chaining.

addValuesBytes

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder addValuesBytes(com.google.protobuf.ByteString value)

 Required. The list of possible categories.
 

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

Parameters:

value - The bytes of the values to add.

Returns:

This builder for chaining.

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;

Specified by:

hasDefaultValue in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Returns:

Whether the defaultValue field is set.

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;

Specified by:

getDefaultValue in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Returns:

The defaultValue.

getDefaultValueBytes

public com.google.protobuf.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;

Specified by:

getDefaultValueBytes in interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

Returns:

The bytes for defaultValue.

setDefaultValue

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;

Parameters:

value - The defaultValue to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setDefaultValueBytes

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder setDefaultValueBytes(com.google.protobuf.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;

Parameters:

value - The bytes for defaultValue to set.

Returns:

This builder for chaining.