Package com.google.cloud.aiplatform.v1

Class StudySpec.ParameterSpec.CategoricalValueSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.GeneratedMessage implements StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder
 Value specification for a parameter in `CATEGORICAL` type.
Protobuf type google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec
See Also:

  • Field Details

    • VALUES_FIELD_NUMBER

      public static final int VALUES_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public StudySpec.ParameterSpec.CategoricalValueSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder