Package com.google.cloud.aiplatform.v1

Interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StudySpec.ParameterSpec.CategoricalValueSpec, StudySpec.ParameterSpec.CategoricalValueSpec.Builder
Enclosing class:
StudySpec.ParameterSpec
public static interface StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    getValues(int index)
    Required.
    com.google.protobuf.ByteString
    getValuesBytes(int index)
    Required.
    int
    getValuesCount()
    Required.
    List<String>
    getValuesList()
    Required.
    boolean
    hasDefaultValue()
    A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getValuesList

      List<String> getValuesList()
       Required. The list of possible categories.
      repeated string values = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the values.

    • getValuesCount

      int getValuesCount()
       Required. The list of possible categories.
      repeated string values = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of values.

    • getValues

      String getValues(int index)
       Required. The list of possible categories.
      repeated string values = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The values at the given index.

    • getValuesBytes

      com.google.protobuf.ByteString getValuesBytes(int index)
       Required. The list of possible categories.
      repeated string values = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the values at the given index.

    • hasDefaultValue

      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:
      Whether the defaultValue field is set.

    • getDefaultValue

      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:
      The defaultValue.

    • getDefaultValueBytes

      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;
      Returns:
      The bytes for defaultValue.