Package ai.shipeasy.admin.model

Class UpdateExperimentRequest

java.lang.Object
ai.shipeasy.admin.model.UpdateExperimentRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class UpdateExperimentRequest extends Object
Body for `PATCH /api/admin/experiments/{id}`. Partial — only supplied fields change. `allocation_pct`, `groups`, `salt`, `universe`, `params` are immutable while the experiment is running (stop first).

  • Field Details

  • Constructor Details

    • UpdateExperimentRequest

      public UpdateExperimentRequest()

  • Method Details

    • name

      public UpdateExperimentRequest name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Stable experiment key. Single segment or `folder.name` (a-z, 0-9, `_`/`-`; max 128 chars). Used by SDKs as `Shipeasy.getExperiment(user, '<name>')`. Immutable after create.
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • description

      public UpdateExperimentRequest description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Get description
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • hypothesis

      public UpdateExperimentRequest hypothesis(@Nullable String hypothesis)

    • getHypothesis

      @Nullable public String getHypothesis()
      Get hypothesis
      Returns:
      hypothesis

    • setHypothesis

      public void setHypothesis(@Nullable String hypothesis)

    • tag

      public UpdateExperimentRequest tag(@Nullable String tag)

    • getTag

      @Nullable public String getTag()
      Get tag
      Returns:
      tag

    • setTag

      public void setTag(@Nullable String tag)

    • ownerEmail

      public UpdateExperimentRequest ownerEmail(@Nullable String ownerEmail)

    • getOwnerEmail

      @Nullable public String getOwnerEmail()
      Get ownerEmail
      Returns:
      ownerEmail

    • setOwnerEmail

      public void setOwnerEmail(@Nullable String ownerEmail)

    • audience

      public UpdateExperimentRequest audience(@Nullable String audience)

    • getAudience

      @Nullable public String getAudience()
      Get audience
      Returns:
      audience

    • setAudience

      public void setAudience(@Nullable String audience)

    • bucketBy

      public UpdateExperimentRequest bucketBy(@Nullable String bucketBy)

    • getBucketBy

      @Nullable public String getBucketBy()
      User-attribute name used as the bucketing key — e.g. `user_id` (default), `session_id`, `device_id`, or a custom attribute like `company_id` to keep a whole org on one variant. Defaults to `user_id` when omitted.
      Returns:
      bucketBy

    • setBucketBy

      public void setBucketBy(@Nullable String bucketBy)

    • folder

      public UpdateExperimentRequest 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)

    • targetingGate

      public UpdateExperimentRequest targetingGate(@Nullable String targetingGate)

    • getTargetingGate

      @Nullable public String getTargetingGate()
      Get targetingGate
      Returns:
      targetingGate

    • setTargetingGate

      public void setTargetingGate(@Nullable String targetingGate)

    • allocationPct

      public UpdateExperimentRequest allocationPct(@Nullable Integer allocationPct)

    • getAllocationPct

      @Nullable public Integer getAllocationPct()
      Basis-points allocation (0–10000). Use `allocation_percent` (0–100) for percent. Immutable while the experiment is running. minimum: 0 maximum: 10000
      Returns:
      allocationPct

    • setAllocationPct

      public void setAllocationPct(@Nullable Integer allocationPct)

    • allocationPercent

      public UpdateExperimentRequest allocationPercent(@Nullable BigDecimal allocationPercent)

    • getAllocationPercent

      @Nullable public BigDecimal getAllocationPercent()
      Allocation as a **percentage** (0–100). Friendlier alias for `allocation_pct`; converted to basis points server-side. Wins over `allocation_pct` if both are supplied. Immutable while running. minimum: 0 maximum: 100
      Returns:
      allocationPercent

    • setAllocationPercent

      public void setAllocationPercent(@Nullable BigDecimal allocationPercent)

    • salt

      public UpdateExperimentRequest salt(@Nullable String salt)

    • getSalt

      @Nullable public String getSalt()
      Hash salt. Immutable while running.
      Returns:
      salt

    • setSalt

      public void setSalt(@Nullable String salt)

    • universe

      public UpdateExperimentRequest universe(@Nullable String universe)

    • getUniverse

      @Nullable public String getUniverse()
      New universe name. Immutable while running. Returns `422` if the universe doesn't exist.
      Returns:
      universe

    • setUniverse

      public void setUniverse(@Nullable String universe)

    • params

      public UpdateExperimentRequest params(@Nullable Map<String,UpdateExperimentRequest.InnerEnum> params)

    • putParamsItem

      public UpdateExperimentRequest putParamsItem(String key, UpdateExperimentRequest.InnerEnum paramsItem)

    • getParams

      @Nullable public Map<String,UpdateExperimentRequest.InnerEnum> getParams()
      Map of param-name → scalar type. Defines the shape of `groups[].params`. Example: `{ headline: 'string', show_cta: 'bool' }`.
      Returns:
      params

    • setParams

      public void setParams(@Nullable Map<String,UpdateExperimentRequest.InnerEnum> params)

    • groups

      public UpdateExperimentRequest groups(@Nullable List<ListExperimentsResponseDataInnerGroupsInner> groups)

    • addGroupsItem

      public UpdateExperimentRequest addGroupsItem(ListExperimentsResponseDataInnerGroupsInner groupsItem)

    • getGroups

      @Nullable public List<ListExperimentsResponseDataInnerGroupsInner> getGroups()
      Replacement groups. Weights must sum to 10000. Immutable while running.
      Returns:
      groups

    • setGroups

      public void setGroups(@Nullable List<ListExperimentsResponseDataInnerGroupsInner> groups)

    • significanceThreshold

      public UpdateExperimentRequest significanceThreshold(@Nullable BigDecimal significanceThreshold)

    • getSignificanceThreshold

      @Nullable public BigDecimal getSignificanceThreshold()
      Get significanceThreshold minimum: 0.00010 maximum: 0.5
      Returns:
      significanceThreshold

    • setSignificanceThreshold

      public void setSignificanceThreshold(@Nullable BigDecimal significanceThreshold)

    • minRuntimeDays

      public UpdateExperimentRequest minRuntimeDays(@Nullable Integer minRuntimeDays)

    • getMinRuntimeDays

      @Nullable public Integer getMinRuntimeDays()
      Get minRuntimeDays minimum: 0 maximum: 365
      Returns:
      minRuntimeDays

    • setMinRuntimeDays

      public void setMinRuntimeDays(@Nullable Integer minRuntimeDays)

    • minSampleSize

      public UpdateExperimentRequest minSampleSize(@Nullable Integer minSampleSize)

    • getMinSampleSize

      @Nullable public Integer getMinSampleSize()
      Get minSampleSize minimum: 1 maximum: 9007199254740991
      Returns:
      minSampleSize

    • setMinSampleSize

      public void setMinSampleSize(@Nullable Integer minSampleSize)

    • sequentialTesting

      public UpdateExperimentRequest sequentialTesting(@Nullable Boolean sequentialTesting)

    • getSequentialTesting

      @Nullable public Boolean getSequentialTesting()
      Get sequentialTesting
      Returns:
      sequentialTesting

    • setSequentialTesting

      public void setSequentialTesting(@Nullable Boolean sequentialTesting)

    • goalMetric

      public UpdateExperimentRequest goalMetric(@Nullable ExperimentInlineMetric goalMetric)

    • getGoalMetric

      @Nullable public ExperimentInlineMetric getGoalMetric()
      Replaces the goal metric — DSL `query` or `event` (+`aggregation`/`value`) the server compiles (event auto-upserted).
      Returns:
      goalMetric

    • setGoalMetric

      public void setGoalMetric(@Nullable ExperimentInlineMetric goalMetric)

    • guardrailMetrics

      public UpdateExperimentRequest guardrailMetrics(@Nullable List<ExperimentInlineMetric> guardrailMetrics)

    • addGuardrailMetricsItem

      public UpdateExperimentRequest addGuardrailMetricsItem(ExperimentInlineMetric guardrailMetricsItem)

    • getGuardrailMetrics

      @Nullable public List<ExperimentInlineMetric> getGuardrailMetrics()
      Replaces the guardrail set wholesale (event auto-upserted per entry).
      Returns:
      guardrailMetrics

    • setGuardrailMetrics

      public void setGuardrailMetrics(@Nullable List<ExperimentInlineMetric> guardrailMetrics)

    • putAdditionalProperty

      public UpdateExperimentRequest putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the UpdateExperimentRequest instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

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

    • fromJson

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

    • toJson

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