public static final class StudySpec.MetricSpec.Builder extends GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder> implements StudySpec.MetricSpecOrBuilder
Represents a metric to optimize.
Protobuf type google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public StudySpec.MetricSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public StudySpec.MetricSpec build()
public StudySpec.MetricSpec buildPartial()
public StudySpec.MetricSpec.Builder clear()
Overrides
public StudySpec.MetricSpec.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public StudySpec.MetricSpec.Builder clearGoal()
Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
public StudySpec.MetricSpec.Builder clearMetricId()
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];
public StudySpec.MetricSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public StudySpec.MetricSpec.Builder clearSafetyConfig()
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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public StudySpec.MetricSpec.Builder clone()
Overrides
public StudySpec.MetricSpec getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
public StudySpec.MetricSpec.GoalType getGoal()
Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
public int getGoalValue()
Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for goal.
|
public 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 |
| Type |
Description |
String |
The metricId.
|
public 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 |
| Type |
Description |
ByteString |
The bytes for metricId.
|
public 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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public StudySpec.MetricSpec.SafetyMetricConfig.Builder getSafetyConfigBuilder()
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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public 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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public 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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Returns |
| Type |
Description |
boolean |
Whether the safetyConfig field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public StudySpec.MetricSpec.Builder mergeFrom(StudySpec.MetricSpec other)
public StudySpec.MetricSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public StudySpec.MetricSpec.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public StudySpec.MetricSpec.Builder mergeSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig value)
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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public final StudySpec.MetricSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public StudySpec.MetricSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public StudySpec.MetricSpec.Builder setGoal(StudySpec.MetricSpec.GoalType value)
Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
public StudySpec.MetricSpec.Builder setGoalValue(int value)
Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
int
The enum numeric value on the wire for goal to set.
|
public StudySpec.MetricSpec.Builder setMetricId(String value)
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];
| Parameter |
| Name |
Description |
value |
String
The metricId to set.
|
public StudySpec.MetricSpec.Builder setMetricIdBytes(ByteString value)
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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for metricId to set.
|
public StudySpec.MetricSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public StudySpec.MetricSpec.Builder setSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig value)
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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public StudySpec.MetricSpec.Builder setSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig.Builder builderForValue)
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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
public final StudySpec.MetricSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
