StudySpec.MetricSpec.Builder (proto-google-cloud-aiplatform-v1 3.63.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
    - - com.google.cloud.aiplatform.v1.StudySpec.MetricSpec.Builder

All Implemented Interfaces:

StudySpec.MetricSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StudySpec.MetricSpec
```
public static final class StudySpec.MetricSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
implements StudySpec.MetricSpecOrBuilder
```
```
 Represents a metric to optimize.
 
```
Protobuf type google.cloud.aiplatform.v1.StudySpec.MetricSpec

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StudySpec.MetricSpec.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`StudySpec.MetricSpec`	`build()`
`StudySpec.MetricSpec`	`buildPartial()`
`StudySpec.MetricSpec.Builder`	`clear()`
`StudySpec.MetricSpec.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`StudySpec.MetricSpec.Builder`	`clearGoal()` Required.
`StudySpec.MetricSpec.Builder`	`clearMetricId()` Required.
`StudySpec.MetricSpec.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`StudySpec.MetricSpec.Builder`	`clearSafetyConfig()` Used for safe search.
`StudySpec.MetricSpec.Builder`	`clone()`
`StudySpec.MetricSpec`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`StudySpec.MetricSpec.GoalType`	`getGoal()` Required.
`int`	`getGoalValue()` Required.
`String`	`getMetricId()` Required.
`com.google.protobuf.ByteString`	`getMetricIdBytes()` Required.
`StudySpec.MetricSpec.SafetyMetricConfig`	`getSafetyConfig()` Used for safe search.
`StudySpec.MetricSpec.SafetyMetricConfig.Builder`	`getSafetyConfigBuilder()` Used for safe search.
`StudySpec.MetricSpec.SafetyMetricConfigOrBuilder`	`getSafetyConfigOrBuilder()` Used for safe search.
`boolean`	`hasSafetyConfig()` Used for safe search.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`StudySpec.MetricSpec.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`StudySpec.MetricSpec.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`StudySpec.MetricSpec.Builder`	`mergeFrom(StudySpec.MetricSpec other)`
`StudySpec.MetricSpec.Builder`	`mergeSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig value)` Used for safe search.
`StudySpec.MetricSpec.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`StudySpec.MetricSpec.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`StudySpec.MetricSpec.Builder`	`setGoal(StudySpec.MetricSpec.GoalType value)` Required.
`StudySpec.MetricSpec.Builder`	`setGoalValue(int value)` Required.
`StudySpec.MetricSpec.Builder`	`setMetricId(String value)` Required.
`StudySpec.MetricSpec.Builder`	`setMetricIdBytes(com.google.protobuf.ByteString value)` Required.
`StudySpec.MetricSpec.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`StudySpec.MetricSpec.Builder`	`setSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig.Builder builderForValue)` Used for safe search.
`StudySpec.MetricSpec.Builder`	`setSafetyConfig(StudySpec.MetricSpec.SafetyMetricConfig value)` Used for safe search.
`StudySpec.MetricSpec.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - clear
```
public StudySpec.MetricSpec.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - getDefaultInstanceForType
```
public StudySpec.MetricSpec getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public StudySpec.MetricSpec build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public StudySpec.MetricSpec buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public StudySpec.MetricSpec.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - setField
```
public StudySpec.MetricSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - clearField
```
public StudySpec.MetricSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - clearOneof
```
public StudySpec.MetricSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - setRepeatedField
```
public StudySpec.MetricSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - addRepeatedField
```
public StudySpec.MetricSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - mergeFrom
```
public StudySpec.MetricSpec.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.MetricSpec.Builder>
  - mergeFrom
```
public StudySpec.MetricSpec.Builder mergeFrom(StudySpec.MetricSpec other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - mergeFrom
```
public StudySpec.MetricSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.MetricSpec.Builder>
    
    Throws:
    
    IOException
  - 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];
    Specified by:
    
    getMetricId in interface StudySpec.MetricSpecOrBuilder
    
    Returns:
    
    The metricId.
  - getMetricIdBytes
```
public com.google.protobuf.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];
    Specified by:
    
    getMetricIdBytes in interface StudySpec.MetricSpecOrBuilder
    
    Returns:
    
    The bytes for metricId.
  - setMetricId
```
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];
    Parameters:
    
    value - The metricId to set.
    
    Returns:
    
    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:
    
    This builder for chaining.
  - setMetricIdBytes
```
public StudySpec.MetricSpec.Builder setMetricIdBytes(com.google.protobuf.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];
    Parameters:
    
    value - The bytes for metricId to set.
    
    Returns:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    getGoalValue in interface StudySpec.MetricSpecOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for goal.
  - setGoalValue
```
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];
    Parameters:
    
    value - The enum numeric value on the wire for goal to set.
    
    Returns:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    getGoal in interface StudySpec.MetricSpecOrBuilder
    
    Returns:
    
    The goal.
  - setGoal
```
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];
    Parameters:
    
    value - The goal to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - 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;
    Specified by:
    
    hasSafetyConfig in interface StudySpec.MetricSpecOrBuilder
    
    Returns:
    
    Whether the safetyConfig field is set.
  - 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;
    Specified by:
    
    getSafetyConfig in interface StudySpec.MetricSpecOrBuilder
    
    Returns:
    
    The safetyConfig.
  - setSafetyConfig
```
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;
  - setSafetyConfig
```
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;
  - mergeSafetyConfig
```
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;
  - 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;
  - 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;
  - 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;
    Specified by:
    
    getSafetyConfigOrBuilder in interface StudySpec.MetricSpecOrBuilder
  - setUnknownFields
```
public final StudySpec.MetricSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>
  - mergeUnknownFields
```
public final StudySpec.MetricSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.Builder>

Class StudySpec.MetricSpec.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getMetricId

getMetricIdBytes

setMetricId

clearMetricId

setMetricIdBytes

getGoalValue

setGoalValue

getGoal

setGoal

clearGoal

hasSafetyConfig

getSafetyConfig

setSafetyConfig

setSafetyConfig

mergeSafetyConfig

clearSafetyConfig

getSafetyConfigBuilder

getSafetyConfigOrBuilder

setUnknownFields

mergeUnknownFields