Package ai.shipeasy.admin.model

Class SetExperimentMetricsRequestMetricsInner

java.lang.Object
ai.shipeasy.admin.model.SetExperimentMetricsRequestMetricsInner
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class SetExperimentMetricsRequestMetricsInner extends Object
SetExperimentMetricsRequestMetricsInner

  • Field Details

  • Constructor Details

    • SetExperimentMetricsRequestMetricsInner

      public SetExperimentMetricsRequestMetricsInner()

  • Method Details

    • metricId

      public SetExperimentMetricsRequestMetricsInner metricId(@Nonnull String metricId)

    • getMetricId

      @Nonnull public String getMetricId()
      Existing metric id in the project.
      Returns:
      metricId

    • setMetricId

      public void setMetricId(@Nonnull String metricId)

    • role

      public SetExperimentMetricsRequestMetricsInner role(@Nonnull SetExperimentMetricsRequestMetricsInner.RoleEnum role)

    • getRole

      @Nonnull public SetExperimentMetricsRequestMetricsInner.RoleEnum getRole()
      Metric role. `goal` drives the decision, `guardrail` blocks ship if degraded, `secondary` is informational.
      Returns:
      role

    • setRole

      public void setRole(@Nonnull SetExperimentMetricsRequestMetricsInner.RoleEnum role)

    • minEffectOfInterest

      public SetExperimentMetricsRequestMetricsInner minEffectOfInterest(@Nullable BigDecimal minEffectOfInterest)

    • getMinEffectOfInterest

      @Nullable public BigDecimal getMinEffectOfInterest()
      Per-experiment override of the metric's `default_min_effect_of_interest` (relative, 0–1) — the smallest change worth acting on for THIS experiment's decision, which depends on the intervention's cost/risk. `null`/omitted falls back to the metric default. For a `guardrail` this is the non-inferiority margin (how large a regression is tolerated); for a `goal` it is the superiority threshold.
      Returns:
      minEffectOfInterest

    • setMinEffectOfInterest

      public void setMinEffectOfInterest(@Nullable BigDecimal minEffectOfInterest)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to SetExperimentMetricsRequestMetricsInner

    • fromJson

      public static SetExperimentMetricsRequestMetricsInner fromJson(String jsonString) throws IOException
      Create an instance of SetExperimentMetricsRequestMetricsInner given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of SetExperimentMetricsRequestMetricsInner
      Throws:
      IOException - if the JSON string is invalid with respect to SetExperimentMetricsRequestMetricsInner

    • toJson

      public String toJson()
      Convert an instance of SetExperimentMetricsRequestMetricsInner to an JSON string
      Returns:
      JSON string