Interface StudySpec.MetricSpecOrBuilder (3.20.0)

public static interface StudySpec.MetricSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGoal()

public abstract 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
TypeDescription
StudySpec.MetricSpec.GoalType

The goal.

getGoalValue()

public abstract int getGoalValue()

Required. The optimization goal of the metric.

.google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for goal.

getMetricId()

public abstract 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
TypeDescription
String

The metricId.

getMetricIdBytes()

public abstract 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
TypeDescription
ByteString

The bytes for metricId.

getSafetyConfig()

public abstract 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
TypeDescription
StudySpec.MetricSpec.SafetyMetricConfig

The safetyConfig.

getSafetyConfigOrBuilder()

public abstract 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;

Returns
TypeDescription
StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

hasSafetyConfig()

public abstract 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
TypeDescription
boolean

Whether the safetyConfig field is set.