Package com.google.cloud.aiplatform.v1

Class StudySpec.ParameterSpec.CategoricalValueSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

StudySpec.ParameterSpec

public static final class StudySpec.ParameterSpec.CategoricalValueSpec
extends com.google.protobuf.GeneratedMessageV3
implements StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

 Value specification for a parameter in `CATEGORICAL` type.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StudySpec.ParameterSpec.CategoricalValueSpec.Builder	Value specification for a parameter in `CATEGORICAL` type.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_VALUE_FIELD_NUMBER
static int	VALUES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static StudySpec.ParameterSpec.CategoricalValueSpec	getDefaultInstance()
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.Parser<StudySpec.ParameterSpec.CategoricalValueSpec>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StudySpec.ParameterSpec.CategoricalValueSpec.Builder	newBuilder()
static StudySpec.ParameterSpec.CategoricalValueSpec.Builder	newBuilder(StudySpec.ParameterSpec.CategoricalValueSpec prototype)
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	newBuilderForType()
protected StudySpec.ParameterSpec.CategoricalValueSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseDelimitedFrom(InputStream input)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(byte[] data)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(com.google.protobuf.ByteString data)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(InputStream input)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(ByteBuffer data)
static StudySpec.ParameterSpec.CategoricalValueSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StudySpec.ParameterSpec.CategoricalValueSpec>	parser()
StudySpec.ParameterSpec.CategoricalValueSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(ByteBuffer data)
                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(ByteBuffer data,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(com.google.protobuf.ByteString data)
                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(com.google.protobuf.ByteString data,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(byte[] data)
                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(byte[] data,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(InputStream input)
                                                              throws IOException

Throws:

IOException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseDelimitedFrom(InputStream input)
                                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseDelimitedFrom(InputStream input,
                                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                       throws IOException

Throws:

IOException

parseFrom

public static StudySpec.ParameterSpec.CategoricalValueSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StudySpec.ParameterSpec.CategoricalValueSpec.Builder newBuilder()

newBuilder

public static StudySpec.ParameterSpec.CategoricalValueSpec.Builder newBuilder(StudySpec.ParameterSpec.CategoricalValueSpec prototype)

toBuilder

public StudySpec.ParameterSpec.CategoricalValueSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StudySpec.ParameterSpec.CategoricalValueSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StudySpec.ParameterSpec.CategoricalValueSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<StudySpec.ParameterSpec.CategoricalValueSpec> parser()

getParserForType

public com.google.protobuf.Parser<StudySpec.ParameterSpec.CategoricalValueSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public StudySpec.ParameterSpec.CategoricalValueSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder