public static final class StudySpec.MetricSpec.Builder extends GeneratedMessage.Builder<StudySpec.MetricSpec.Builder> implements StudySpec.MetricSpecOrBuilderRepresents a metric to optimize.
Protobuf type google.cloud.aiplatform.v1.StudySpec.MetricSpec
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > StudySpec.MetricSpec.BuilderImplements
StudySpec.MetricSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public StudySpec.MetricSpec build()| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec |
|
buildPartial()
public StudySpec.MetricSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec |
|
clear()
public StudySpec.MetricSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
clearGoal()
public StudySpec.MetricSpec.Builder clearGoal()Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
This builder for chaining. |
clearMetricId()
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];
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
This builder for chaining. |
clearSafetyConfig()
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
getDefaultInstanceForType()
public StudySpec.MetricSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getGoal()
public 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 | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.GoalType |
The goal. |
getGoalValue()
public int getGoalValue()Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for goal. |
getMetricId()
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. |
getMetricIdBytes()
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. |
getSafetyConfig()
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
The safetyConfig. |
getSafetyConfigBuilder()
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
|
getSafetyConfigOrBuilder()
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.SafetyMetricConfigOrBuilder |
|
hasSafetyConfig()
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the safetyConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(StudySpec.MetricSpec other)
public StudySpec.MetricSpec.Builder mergeFrom(StudySpec.MetricSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
StudySpec.MetricSpec |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StudySpec.MetricSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public StudySpec.MetricSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
mergeSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig value)
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StudySpec.MetricSpec.SafetyMetricConfig |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
setGoal(StudySpec.MetricSpec.GoalType value)
public StudySpec.MetricSpec.Builder setGoal(StudySpec.MetricSpec.GoalType value)Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StudySpec.MetricSpec.GoalTypeThe goal to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
This builder for chaining. |
setGoalValue(int value)
public StudySpec.MetricSpec.Builder setGoalValue(int value)Required. The optimization goal of the metric.
.google.cloud.aiplatform.v1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for goal to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
This builder for chaining. |
setMetricId(String value)
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 |
StringThe metricId to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
This builder for chaining. |
setMetricIdBytes(ByteString value)
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 |
ByteStringThe bytes for metricId to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
This builder for chaining. |
setSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig value)
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StudySpec.MetricSpec.SafetyMetricConfig |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|
setSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig.Builder builderForValue)
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec.Builder |
|