Package ai.shipeasy.admin.model

Class ExperimentInlineMetric

java.lang.Object
ai.shipeasy.admin.model.ExperimentInlineMetric
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExperimentInlineMetric extends Object
Inline metric — a DSL `query`, or an `event` (+ `aggregation`/`value`) the server compiles into one.

  • Field Details

  • Constructor Details

    • ExperimentInlineMetric

      public ExperimentInlineMetric()

  • Method Details

    • name

      public ExperimentInlineMetric name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Stable metric key. Single segment or `folder.name`; lowercase letters, digits, `_`/`-`; max 128 chars.
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • query

      public ExperimentInlineMetric query(@Nullable String query)

    • getQuery

      @Nullable public String getQuery()
      Metric DSL string. Provide this OR `event`.
      Returns:
      query

    • setQuery

      public void setQuery(@Nullable String query)

    • event

      public ExperimentInlineMetric event(@Nullable String event)

    • getEvent

      @Nullable public String getEvent()
      Event name to build the metric from server-side. Auto-created if missing.
      Returns:
      event

    • setEvent

      public void setEvent(@Nullable String event)

    • aggregation

      public ExperimentInlineMetric aggregation(@Nullable ExperimentInlineMetric.AggregationEnum aggregation)

    • getAggregation

      @Nullable public ExperimentInlineMetric.AggregationEnum getAggregation()
      Reducer for the `event` form. Defaults to `count_users`.
      Returns:
      aggregation

    • setAggregation

      public void setAggregation(@Nullable ExperimentInlineMetric.AggregationEnum aggregation)

    • value

      public ExperimentInlineMetric value(@Nullable String value)

    • getValue

      @Nullable public String getValue()
      Numeric event property for `sum`/`avg` (with `event`).
      Returns:
      value

    • setValue

      public void setValue(@Nullable String value)

    • minEffectOfInterest

      public ExperimentInlineMetric minEffectOfInterest(@Nullable BigDecimal minEffectOfInterest)

    • getMinEffectOfInterest

      @Nullable public BigDecimal getMinEffectOfInterest()
      Per-experiment override of the metric's default minimum effect of interest (relative, 0–1) — the smallest change worth acting on for this experiment's decision. `null`/omitted inherits the metric default. For a guardrail, the non-inferiority margin.
      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 ExperimentInlineMetric

    • fromJson

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

    • toJson

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