Package ai.shipeasy.admin.model

Class UpdateMetricWithQuery

java.lang.Object
ai.shipeasy.admin.model.UpdateMetricWithQuery
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class UpdateMetricWithQuery extends Object
Update-metric variant that replaces the query with a `query` DSL string.

  • Field Details

  • Constructor Details

    • UpdateMetricWithQuery

      public UpdateMetricWithQuery()

  • Method Details

    • folder

      public UpdateMetricWithQuery folder(@Nullable String folder)

    • getFolder

      @Nullable public String getFolder()
      Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
      Returns:
      folder

    • setFolder

      public void setFolder(@Nullable String folder)

    • eventName

      public UpdateMetricWithQuery eventName(@Nullable String eventName)

    • getEventName

      @Nullable public String getEventName()
      Source event the query reads from.
      Returns:
      eventName

    • setEventName

      public void setEventName(@Nullable String eventName)

    • query

      public UpdateMetricWithQuery query(@Nonnull String query)

    • getQuery

      @Nonnull public String getQuery()
      Metric query DSL string, e.g. `sum(purchase, amount)`. The alternative to `query_ir`. Every label the query references — in filters, the value position, `by (…)`, or `without (…)` — must exist as a property on the tracked event's payload; a query over a label the event never carries validates fine but returns empty results.
      Returns:
      query

    • setQuery

      public void setQuery(@Nonnull String query)

    • winsorizePct

      public UpdateMetricWithQuery winsorizePct(@Nullable Integer winsorizePct)

    • getWinsorizePct

      @Nullable public Integer getWinsorizePct()
      Winsorise percentile (1–99) to clamp outliers. Defaults to 99. minimum: 1 maximum: 99
      Returns:
      winsorizePct

    • setWinsorizePct

      public void setWinsorizePct(@Nullable Integer winsorizePct)

    • defaultMinEffectOfInterest

      public UpdateMetricWithQuery defaultMinEffectOfInterest(@Nullable BigDecimal defaultMinEffectOfInterest)

    • getDefaultMinEffectOfInterest

      @Nullable public BigDecimal getDefaultMinEffectOfInterest()
      Default minimum effect of interest (relative, 0–1) — the smallest change in this metric worth acting on, used as the power-planning baseline. Intrinsic to the metric; an experiment overrides it per-attachment with `min_effect_of_interest` when a specific decision has a different cost/risk bar. `null` to omit.
      Returns:
      defaultMinEffectOfInterest

    • setDefaultMinEffectOfInterest

      public void setDefaultMinEffectOfInterest(@Nullable BigDecimal defaultMinEffectOfInterest)

    • direction

      public UpdateMetricWithQuery direction(@Nullable MetricDirection direction)

    • getDirection

      @Nullable public MetricDirection getDirection()
      Get direction
      Returns:
      direction

    • setDirection

      public void setDirection(@Nullable MetricDirection direction)

    • 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 UpdateMetricWithQuery

    • fromJson

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

    • toJson

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