Package com.google.cloud.aiplatform.v1

Interface StudySpec.MetricSpecOrBuilder

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

  • Method Details

    • getMetricId

      String getMetricId()
       Required. The ID of the metric. Must not contain whitespaces and must be
 unique amongst all MetricSpecs.
      string metric_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The metricId.

    • getMetricIdBytes

      com.google.protobuf.ByteString getMetricIdBytes()
       Required. The ID of the metric. Must not contain whitespaces and must be
 unique amongst all MetricSpecs.
      string metric_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for metricId.

    • getGoalValue

      int getGoalValue()
       Required. The optimization goal of the metric.
      .google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for goal.

    • getGoal

      StudySpec.MetricSpec.GoalType getGoal()
       Required. The optimization goal of the metric.
      .google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The goal.

    • hasSafetyConfig

      boolean hasSafetyConfig()
       Used for safe search. In the case, the metric will be a safety
 metric. You must provide a separate metric for objective metric.
      optional .google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
      Returns:
      Whether the safetyConfig field is set.

    • getSafetyConfig

      StudySpec.MetricSpec.SafetyMetricConfig getSafetyConfig()
       Used for safe search. In the case, the metric will be a safety
 metric. You must provide a separate metric for objective metric.
      optional .google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
      Returns:
      The safetyConfig.

    • getSafetyConfigOrBuilder

      StudySpec.MetricSpec.SafetyMetricConfigOrBuilder getSafetyConfigOrBuilder()
       Used for safe search. In the case, the metric will be a safety
 metric. You must provide a separate metric for objective metric.
      optional .google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;