Class StudySpec.MetricSpec.Builder (3.37.0)

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.v1.StudySpec.MetricSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MetricSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

build()

public StudySpec.MetricSpec build()
Returns
TypeDescription
StudySpec.MetricSpec

buildPartial()

public StudySpec.MetricSpec buildPartial()
Returns
TypeDescription
StudySpec.MetricSpec

clear()

public StudySpec.MetricSpec.Builder clear()
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StudySpec.MetricSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

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
TypeDescription
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
TypeDescription
StudySpec.MetricSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.MetricSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

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
TypeDescription
StudySpec.MetricSpec.Builder

clone()

public StudySpec.MetricSpec.Builder clone()
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

getDefaultInstanceForType()

public StudySpec.MetricSpec getDefaultInstanceForType()
Returns
TypeDescription
StudySpec.MetricSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

Whether the safetyConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StudySpec.MetricSpec other)

public StudySpec.MetricSpec.Builder mergeFrom(StudySpec.MetricSpec other)
Parameter
NameDescription
otherStudySpec.MetricSpec
Returns
TypeDescription
StudySpec.MetricSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.MetricSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StudySpec.MetricSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

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
NameDescription
valueStudySpec.MetricSpec.SafetyMetricConfig
Returns
TypeDescription
StudySpec.MetricSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MetricSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MetricSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

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
NameDescription
valueStudySpec.MetricSpec.GoalType

The goal to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for goal to set.

Returns
TypeDescription
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
NameDescription
valueString

The metricId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for metricId to set.

Returns
TypeDescription
StudySpec.MetricSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StudySpec.MetricSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

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
NameDescription
valueStudySpec.MetricSpec.SafetyMetricConfig
Returns
TypeDescription
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
NameDescription
builderForValueStudySpec.MetricSpec.SafetyMetricConfig.Builder
Returns
TypeDescription
StudySpec.MetricSpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MetricSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides