com.google.cloud.aiplatform.v1

Class StudySpec.MetricSpec.SafetyMetricConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.SafetyMetricConfig.Builder>

com.google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig.Builder

All Implemented Interfaces:

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

Enclosing class:

StudySpec.MetricSpec.SafetyMetricConfig

public static final class StudySpec.MetricSpec.SafetyMetricConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.MetricSpec.SafetyMetricConfig.Builder>
implements StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

 Used in safe optimization to specify threshold levels and risk tolerance.
 

Protobuf type google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig

Method Summary

Modifier and Type	Method and Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StudySpec.MetricSpec.SafetyMetricConfig	build()
StudySpec.MetricSpec.SafetyMetricConfig	buildPartial()
StudySpec.MetricSpec.SafetyMetricConfig.Builder	clear()
StudySpec.MetricSpec.SafetyMetricConfig.Builder	clearDesiredMinSafeTrialsFraction() Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort).
StudySpec.MetricSpec.SafetyMetricConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	clearSafetyThreshold() Safety threshold (boundary value between safe and unsafe).
StudySpec.MetricSpec.SafetyMetricConfig.Builder	clone()
StudySpec.MetricSpec.SafetyMetricConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getDesiredMinSafeTrialsFraction() Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort).
double	getSafetyThreshold() Safety threshold (boundary value between safe and unsafe).
boolean	hasDesiredMinSafeTrialsFraction() Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StudySpec.MetricSpec.SafetyMetricConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	mergeFrom(com.google.protobuf.Message other)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	mergeFrom(StudySpec.MetricSpec.SafetyMetricConfig other)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	setDesiredMinSafeTrialsFraction(double value) Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort).
StudySpec.MetricSpec.SafetyMetricConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
StudySpec.MetricSpec.SafetyMetricConfig.Builder	setSafetyThreshold(double value) Safety threshold (boundary value between safe and unsafe).
StudySpec.MetricSpec.SafetyMetricConfig.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.SafetyMetricConfig.Builder>

clear

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

getDefaultInstanceForType

public StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(StudySpec.MetricSpec.SafetyMetricConfig 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.SafetyMetricConfig.Builder>

mergeFrom

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

Throws:

IOException

getSafetyThreshold

public double getSafetyThreshold()

 Safety threshold (boundary value between safe and unsafe). NOTE that if
 you leave SafetyMetricConfig unset, a default value of 0 will be used.
 

double safety_threshold = 1;

Specified by:

getSafetyThreshold in interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

Returns:

The safetyThreshold.

setSafetyThreshold

public StudySpec.MetricSpec.SafetyMetricConfig.Builder setSafetyThreshold(double value)

 Safety threshold (boundary value between safe and unsafe). NOTE that if
 you leave SafetyMetricConfig unset, a default value of 0 will be used.
 

double safety_threshold = 1;

Parameters:

value - The safetyThreshold to set.

Returns:

This builder for chaining.

clearSafetyThreshold

public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearSafetyThreshold()

 Safety threshold (boundary value between safe and unsafe). NOTE that if
 you leave SafetyMetricConfig unset, a default value of 0 will be used.
 

double safety_threshold = 1;

Returns:

This builder for chaining.

hasDesiredMinSafeTrialsFraction

public boolean hasDesiredMinSafeTrialsFraction()

 Desired minimum fraction of safe trials (over total number of trials)
 that should be targeted by the algorithm at any time during the
 study (best effort). This should be between 0.0 and 1.0 and a value of
 0.0 means that there is no minimum and an algorithm proceeds without
 targeting any specific fraction. A value of 1.0 means that the
 algorithm attempts to only Suggest safe Trials.
 

optional double desired_min_safe_trials_fraction = 2;

Specified by:

hasDesiredMinSafeTrialsFraction in interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

Returns:

Whether the desiredMinSafeTrialsFraction field is set.

getDesiredMinSafeTrialsFraction

public double getDesiredMinSafeTrialsFraction()

 Desired minimum fraction of safe trials (over total number of trials)
 that should be targeted by the algorithm at any time during the
 study (best effort). This should be between 0.0 and 1.0 and a value of
 0.0 means that there is no minimum and an algorithm proceeds without
 targeting any specific fraction. A value of 1.0 means that the
 algorithm attempts to only Suggest safe Trials.
 

optional double desired_min_safe_trials_fraction = 2;

Specified by:

getDesiredMinSafeTrialsFraction in interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

Returns:

The desiredMinSafeTrialsFraction.

setDesiredMinSafeTrialsFraction

public StudySpec.MetricSpec.SafetyMetricConfig.Builder setDesiredMinSafeTrialsFraction(double value)

 Desired minimum fraction of safe trials (over total number of trials)
 that should be targeted by the algorithm at any time during the
 study (best effort). This should be between 0.0 and 1.0 and a value of
 0.0 means that there is no minimum and an algorithm proceeds without
 targeting any specific fraction. A value of 1.0 means that the
 algorithm attempts to only Suggest safe Trials.
 

optional double desired_min_safe_trials_fraction = 2;

Parameters:

value - The desiredMinSafeTrialsFraction to set.

Returns:

This builder for chaining.

clearDesiredMinSafeTrialsFraction

public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearDesiredMinSafeTrialsFraction()

 Desired minimum fraction of safe trials (over total number of trials)
 that should be targeted by the algorithm at any time during the
 study (best effort). This should be between 0.0 and 1.0 and a value of
 0.0 means that there is no minimum and an algorithm proceeds without
 targeting any specific fraction. A value of 1.0 means that the
 algorithm attempts to only Suggest safe Trials.
 

optional double desired_min_safe_trials_fraction = 2;

Returns:

This builder for chaining.

setUnknownFields

public final StudySpec.MetricSpec.SafetyMetricConfig.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.SafetyMetricConfig.Builder>

mergeUnknownFields

public final StudySpec.MetricSpec.SafetyMetricConfig.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.SafetyMetricConfig.Builder>