Class StudySpec.MetricSpec.Builder (3.34.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.v1beta1.StudySpec.MetricSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StudySpec.MetricSpec.Builder

Implements

StudySpec.MetricSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MetricSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public StudySpec.MetricSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGoal()

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];

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.

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.MetricSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

clone()

public StudySpec.MetricSpec.Builder clone()

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public StudySpec.MetricSpec getDefaultInstanceForType()

Returns
Type	Description
`StudySpec.MetricSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGoal()

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];

Returns
Type	Description
`StudySpec.MetricSpec.GoalType`	The goal.

getGoalValue()

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.

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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
Type	Description
`boolean`	Whether the safetyConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Parameter
Name	Description
`value`	`StudySpec.MetricSpec.SafetyMetricConfig`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MetricSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MetricSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGoal(StudySpec.MetricSpec.GoalType value)

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];

Parameter
Name	Description
`value`	`StudySpec.MetricSpec.GoalType` The 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.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.

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`	`String` The 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`	`ByteString` The bytes for metricId to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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.v1beta1.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.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Parameter
Name	Description
`builderForValue`	`StudySpec.MetricSpec.SafetyMetricConfig.Builder`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MetricSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`StudySpec.MetricSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)