Package ai.shipeasy.admin.model

Class UpdateProjectRequest

java.lang.Object
ai.shipeasy.admin.model.UpdateProjectRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class UpdateProjectRequest extends Object
Body for `PATCH /api/admin/projects/{id}`. Partial — every field is optional; only supplied fields change. The project id in the path must match the caller's own project.

  • Field Details

  • Constructor Details

    • UpdateProjectRequest

      public UpdateProjectRequest()

  • Method Details

    • name

      public UpdateProjectRequest name(@Nullable String name)

    • getName

      @Nullable public String getName()
      New project name.
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • domain

      public UpdateProjectRequest domain(@Nullable String domain)

    • getDomain

      @Nullable public String getDomain()
      Lowercase bare hostname (e.g. `acme.com`, `app.acme.com`, `*.acme.com`), or `*` to allow any origin. Full URLs with `https://` are not accepted. The project is keyed by `(owner_email, domain)`, so a second call with the same domain returns the existing project.
      Returns:
      domain

    • setDomain

      public void setDomain(@Nullable String domain)

    • slug

      public UpdateProjectRequest slug(@Nullable String slug)

    • getSlug

      @Nullable public String getSlug()
      URL-safe identifier used in app URLs and SDK config. Lowercase letters, numbers, and hyphens; 2–48 chars; cannot start or end with a hyphen. The caller lowercases the raw slug before sending.
      Returns:
      slug

    • setSlug

      public void setSlug(@Nullable String slug)

    • defaultEnv

      public UpdateProjectRequest defaultEnv(@Nullable UpdateProjectRequest.DefaultEnvEnum defaultEnv)

    • getDefaultEnv

      @Nullable public UpdateProjectRequest.DefaultEnvEnum getDefaultEnv()
      Default environment new resources are scoped to.
      Returns:
      defaultEnv

    • setDefaultEnv

      public void setDefaultEnv(@Nullable UpdateProjectRequest.DefaultEnvEnum defaultEnv)

    • timezone

      public UpdateProjectRequest timezone(@Nullable String timezone)

    • getTimezone

      @Nullable public String getTimezone()
      IANA timezone the project's daily analysis runs in.
      Returns:
      timezone

    • setTimezone

      public void setTimezone(@Nullable String timezone)

    • statMethod

      public UpdateProjectRequest statMethod(@Nullable UpdateProjectRequest.StatMethodEnum statMethod)

    • getStatMethod

      @Nullable public UpdateProjectRequest.StatMethodEnum getStatMethod()
      Statistical method the experiment analyzer uses.
      Returns:
      statMethod

    • setStatMethod

      public void setStatMethod(@Nullable UpdateProjectRequest.StatMethodEnum statMethod)

    • sigThreshold

      public UpdateProjectRequest sigThreshold(@Nullable UpdateProjectRequest.SigThresholdEnum sigThreshold)

    • getSigThreshold

      @Nullable public UpdateProjectRequest.SigThresholdEnum getSigThreshold()
      Significance threshold (alpha) for experiment analysis.
      Returns:
      sigThreshold

    • setSigThreshold

      public void setSigThreshold(@Nullable UpdateProjectRequest.SigThresholdEnum sigThreshold)

    • autoRollback

      public UpdateProjectRequest autoRollback(@Nullable Boolean autoRollback)

    • getAutoRollback

      @Nullable public Boolean getAutoRollback()
      Whether a failing guardrail auto-rolls back the experiment.
      Returns:
      autoRollback

    • setAutoRollback

      public void setAutoRollback(@Nullable Boolean autoRollback)

    • minSampleDays

      public UpdateProjectRequest minSampleDays(@Nullable Integer minSampleDays)

    • getMinSampleDays

      @Nullable public Integer getMinSampleDays()
      Minimum number of days an experiment must run before it can be called. minimum: 1 maximum: 365
      Returns:
      minSampleDays

    • setMinSampleDays

      public void setMinSampleDays(@Nullable Integer minSampleDays)

    • moduleTranslations

      public UpdateProjectRequest moduleTranslations(@Nullable Boolean moduleTranslations)

    • getModuleTranslations

      @Nullable public Boolean getModuleTranslations()
      Enable/disable the i18n/translations module.
      Returns:
      moduleTranslations

    • setModuleTranslations

      public void setModuleTranslations(@Nullable Boolean moduleTranslations)

    • moduleConfigs

      public UpdateProjectRequest moduleConfigs(@Nullable Boolean moduleConfigs)

    • getModuleConfigs

      @Nullable public Boolean getModuleConfigs()
      Enable/disable the dynamic-configs module.
      Returns:
      moduleConfigs

    • setModuleConfigs

      public void setModuleConfigs(@Nullable Boolean moduleConfigs)

    • moduleGates

      public UpdateProjectRequest moduleGates(@Nullable Boolean moduleGates)

    • getModuleGates

      @Nullable public Boolean getModuleGates()
      Enable/disable the feature-gates module.
      Returns:
      moduleGates

    • setModuleGates

      public void setModuleGates(@Nullable Boolean moduleGates)

    • moduleExperiments

      public UpdateProjectRequest moduleExperiments(@Nullable Boolean moduleExperiments)

    • getModuleExperiments

      @Nullable public Boolean getModuleExperiments()
      Enable/disable the experiments module.
      Returns:
      moduleExperiments

    • setModuleExperiments

      public void setModuleExperiments(@Nullable Boolean moduleExperiments)

    • moduleFeedback

      public UpdateProjectRequest moduleFeedback(@Nullable Boolean moduleFeedback)

    • getModuleFeedback

      @Nullable public Boolean getModuleFeedback()
      Enable/disable the feedback/ops module.
      Returns:
      moduleFeedback

    • setModuleFeedback

      public void setModuleFeedback(@Nullable Boolean moduleFeedback)

    • moduleUser

      public UpdateProjectRequest moduleUser(@Nullable Boolean moduleUser)

    • getModuleUser

      @Nullable public Boolean getModuleUser()
      Enable/disable the user-management module.
      Returns:
      moduleUser

    • setModuleUser

      public void setModuleUser(@Nullable Boolean moduleUser)

    • moduleEvents

      public UpdateProjectRequest moduleEvents(@Nullable Boolean moduleEvents)

    • getModuleEvents

      @Nullable public Boolean getModuleEvents()
      Enable/disable the events module.
      Returns:
      moduleEvents

    • setModuleEvents

      public void setModuleEvents(@Nullable Boolean moduleEvents)

    • minSampleSize

      public UpdateProjectRequest minSampleSize(@Nullable Integer minSampleSize)

    • getMinSampleSize

      @Nullable public Integer getMinSampleSize()
      Verdict power guard — minimum users per arm before a ship/hold verdict. minimum: 2 maximum: 1000000
      Returns:
      minSampleSize

    • setMinSampleSize

      public void setMinSampleSize(@Nullable Integer minSampleSize)

    • minRuntimeDays

      public UpdateProjectRequest minRuntimeDays(@Nullable Integer minRuntimeDays)

    • getMinRuntimeDays

      @Nullable public Integer getMinRuntimeDays()
      Minimum days an experiment must run before a verdict (peeking guard). minimum: 0 maximum: 365
      Returns:
      minRuntimeDays

    • setMinRuntimeDays

      public void setMinRuntimeDays(@Nullable Integer minRuntimeDays)

    • defaultPower

      public UpdateProjectRequest defaultPower(@Nullable BigDecimal defaultPower)

    • getDefaultPower

      @Nullable public BigDecimal getDefaultPower()
      Target statistical power (1−β) feeding the realized-MDE calculation. minimum: 0.5 maximum: 0.99
      Returns:
      defaultPower

    • setDefaultPower

      public void setDefaultPower(@Nullable BigDecimal defaultPower)

    • ciConfidence

      public UpdateProjectRequest ciConfidence(@Nullable BigDecimal ciConfidence)

    • getCiConfidence

      @Nullable public BigDecimal getCiConfidence()
      Confidence level for the interval surfaced on results (any value in [0.5, 0.999], e.g. 0.90, 0.95, 0.975, 0.99). minimum: 0.5 maximum: 0.999
      Returns:
      ciConfidence

    • setCiConfidence

      public void setCiConfidence(@Nullable BigDecimal ciConfidence)

    • defaultAllocationPct

      public UpdateProjectRequest defaultAllocationPct(@Nullable Integer defaultAllocationPct)

    • getDefaultAllocationPct

      @Nullable public Integer getDefaultAllocationPct()
      Default traffic allocation (basis points, 1000 = 10%) new experiments start with; overridable per experiment. minimum: 1 maximum: 10000
      Returns:
      defaultAllocationPct

    • setDefaultAllocationPct

      public void setDefaultAllocationPct(@Nullable Integer defaultAllocationPct)

    • defaultWinsorizePct

      public UpdateProjectRequest defaultWinsorizePct(@Nullable Integer defaultWinsorizePct)

    • getDefaultWinsorizePct

      @Nullable public Integer getDefaultWinsorizePct()
      Default winsorization percentile new metrics start with; overridable per metric. minimum: 1 maximum: 99
      Returns:
      defaultWinsorizePct

    • setDefaultWinsorizePct

      public void setDefaultWinsorizePct(@Nullable Integer defaultWinsorizePct)

    • defaultMei

      public UpdateProjectRequest defaultMei(@Nullable BigDecimal defaultMei)

    • getDefaultMei

      @Nullable public BigDecimal getDefaultMei()
      Default minimum effect of interest (relative, 0–1) new metrics start with; overridable per metric and per experiment. Null clears it. minimum: 0 maximum: 1
      Returns:
      defaultMei

    • setDefaultMei

      public void setDefaultMei(@Nullable BigDecimal defaultMei)

    • cupedBaselineDays

      public UpdateProjectRequest cupedBaselineDays(@Nullable Integer cupedBaselineDays)

    • getCupedBaselineDays

      @Nullable public Integer getCupedBaselineDays()
      CUPED baseline window — days of pre-experiment history, frozen at start. minimum: 1 maximum: 365
      Returns:
      cupedBaselineDays

    • setCupedBaselineDays

      public void setCupedBaselineDays(@Nullable Integer cupedBaselineDays)

    • cupedMinOverlap

      public UpdateProjectRequest cupedMinOverlap(@Nullable BigDecimal cupedMinOverlap)

    • getCupedMinOverlap

      @Nullable public BigDecimal getCupedMinOverlap()
      CUPED selection-bias guard — min share of users with a baseline, else skip. minimum: 0.01 maximum: 0.99
      Returns:
      cupedMinOverlap

    • setCupedMinOverlap

      public void setCupedMinOverlap(@Nullable BigDecimal cupedMinOverlap)

    • cupedMinBaselineUsers

      public UpdateProjectRequest cupedMinBaselineUsers(@Nullable Integer cupedMinBaselineUsers)

    • getCupedMinBaselineUsers

      @Nullable public Integer getCupedMinBaselineUsers()
      CUPED — minimum users with a baseline before it runs at all. minimum: 10 maximum: 100000
      Returns:
      cupedMinBaselineUsers

    • setCupedMinBaselineUsers

      public void setCupedMinBaselineUsers(@Nullable Integer cupedMinBaselineUsers)

    • msprtTauMeiFactor

      public UpdateProjectRequest msprtTauMeiFactor(@Nullable BigDecimal msprtTauMeiFactor)

    • getMsprtTauMeiFactor

      @Nullable public BigDecimal getMsprtTauMeiFactor()
      mSPRT prior width — τ = minimum effect of interest × this factor. minimum: 0.1 maximum: 2
      Returns:
      msprtTauMeiFactor

    • setMsprtTauMeiFactor

      public void setMsprtTauMeiFactor(@Nullable BigDecimal msprtTauMeiFactor)

    • msprtTauSdFactor

      public UpdateProjectRequest msprtTauSdFactor(@Nullable BigDecimal msprtTauSdFactor)

    • getMsprtTauSdFactor

      @Nullable public BigDecimal getMsprtTauSdFactor()
      mSPRT fallback prior width — τ = this × control SD when no MEI is set. minimum: 0.05 maximum: 1
      Returns:
      msprtTauSdFactor

    • setMsprtTauSdFactor

      public void setMsprtTauSdFactor(@Nullable BigDecimal msprtTauSdFactor)

    • srmThreshold

      public UpdateProjectRequest srmThreshold(@Nullable BigDecimal srmThreshold)

    • getSrmThreshold

      @Nullable public BigDecimal getSrmThreshold()
      SRM chi-square p-value below which the run is called invalid. minimum: 0.00010 maximum: 0.05
      Returns:
      srmThreshold

    • setSrmThreshold

      public void setSrmThreshold(@Nullable BigDecimal srmThreshold)

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

    • fromJson

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

    • toJson

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