Package 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.GeneratedMessage.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.GeneratedMessage.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 Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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.