Package ai.shipeasy.admin.model

Class GetExperimentResponse

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

  • Field Details

  • Constructor Details

    • GetExperimentResponse

      public GetExperimentResponse()

  • Method Details

    • id

      public GetExperimentResponse id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Stable opaque experiment id (`exp_…`).
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • name

      public GetExperimentResponse name(@Nonnull String name)

    • getName

      @Nonnull 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(@Nonnull String name)

    • description

      public GetExperimentResponse description(@Nullable String description)

    • getDescription

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

    • setDescription

      public void setDescription(@Nullable String description)

    • hypothesis

      public GetExperimentResponse hypothesis(@Nullable String hypothesis)

    • getHypothesis

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

    • setHypothesis

      public void setHypothesis(@Nullable String hypothesis)

    • tag

      public GetExperimentResponse tag(@Nullable String tag)

    • getTag

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

    • setTag

      public void setTag(@Nullable String tag)

    • ownerEmail

      public GetExperimentResponse ownerEmail(@Nullable String ownerEmail)

    • getOwnerEmail

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

    • setOwnerEmail

      public void setOwnerEmail(@Nullable String ownerEmail)

    • audience

      public GetExperimentResponse audience(@Nullable String audience)

    • getAudience

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

    • setAudience

      public void setAudience(@Nullable String audience)

    • bucketBy

      public GetExperimentResponse 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 GetExperimentResponse folder(@Nullable String folder)

    • getFolder

      @Nullable public String getFolder()
      Get folder
      Returns:
      folder

    • setFolder

      public void setFolder(@Nullable String folder)

    • status

      public GetExperimentResponse status(@Nonnull GetExperimentResponse.StatusEnum status)

    • getStatus

      @Nonnull public GetExperimentResponse.StatusEnum getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull GetExperimentResponse.StatusEnum status)

    • universe

      public GetExperimentResponse universe(@Nonnull String universe)

    • getUniverse

      @Nonnull public String getUniverse()
      Universe name this experiment draws from.
      Returns:
      universe

    • setUniverse

      public void setUniverse(@Nonnull String universe)

    • targetingGate

      public GetExperimentResponse targetingGate(@Nullable String targetingGate)

    • getTargetingGate

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

    • setTargetingGate

      public void setTargetingGate(@Nullable String targetingGate)

    • allocationPct

      public GetExperimentResponse allocationPct(@Nonnull Integer allocationPct)

    • getAllocationPct

      @Nonnull public Integer getAllocationPct()
      Allocation in basis points (0–10000). minimum: -9007199254740991 maximum: 9007199254740991
      Returns:
      allocationPct

    • setAllocationPct

      public void setAllocationPct(@Nonnull Integer allocationPct)

    • salt

      public GetExperimentResponse salt(@Nonnull String salt)

    • getSalt

      @Nonnull public String getSalt()
      Get salt
      Returns:
      salt

    • setSalt

      public void setSalt(@Nonnull String salt)

    • params

      public GetExperimentResponse params(@Nonnull Map<String,GetExperimentResponse.InnerEnum> params)

    • putParamsItem

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

    • getParams

      @Nonnull public Map<String,GetExperimentResponse.InnerEnum> getParams()
      Get params
      Returns:
      params

    • setParams

      public void setParams(@Nonnull Map<String,GetExperimentResponse.InnerEnum> params)

    • groups

      public GetExperimentResponse groups(@Nonnull List<ListExperimentsResponseDataInnerGroupsInner> groups)

    • addGroupsItem

      public GetExperimentResponse addGroupsItem(ListExperimentsResponseDataInnerGroupsInner groupsItem)

    • getGroups

      @Nonnull public List<ListExperimentsResponseDataInnerGroupsInner> getGroups()
      Get groups
      Returns:
      groups

    • setGroups

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

    • significanceThreshold

      public GetExperimentResponse significanceThreshold(@Nonnull BigDecimal significanceThreshold)

    • getSignificanceThreshold

      @Nonnull public BigDecimal getSignificanceThreshold()
      Get significanceThreshold
      Returns:
      significanceThreshold

    • setSignificanceThreshold

      public void setSignificanceThreshold(@Nonnull BigDecimal significanceThreshold)

    • minRuntimeDays

      public GetExperimentResponse minRuntimeDays(@Nonnull Integer minRuntimeDays)

    • getMinRuntimeDays

      @Nonnull public Integer getMinRuntimeDays()
      Get minRuntimeDays minimum: -9007199254740991 maximum: 9007199254740991
      Returns:
      minRuntimeDays

    • setMinRuntimeDays

      public void setMinRuntimeDays(@Nonnull Integer minRuntimeDays)

    • minSampleSize

      public GetExperimentResponse minSampleSize(@Nonnull Integer minSampleSize)

    • getMinSampleSize

      @Nonnull public Integer getMinSampleSize()
      Get minSampleSize minimum: -9007199254740991 maximum: 9007199254740991
      Returns:
      minSampleSize

    • setMinSampleSize

      public void setMinSampleSize(@Nonnull Integer minSampleSize)

    • sequentialTesting

      public GetExperimentResponse sequentialTesting(@Nonnull Boolean sequentialTesting)

    • getSequentialTesting

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

    • setSequentialTesting

      public void setSequentialTesting(@Nonnull Boolean sequentialTesting)

    • startedAt

      public GetExperimentResponse startedAt(@Nullable String startedAt)

    • getStartedAt

      @Nullable public String getStartedAt()
      ISO-8601 timestamp the experiment last transitioned to `running`, or `null`.
      Returns:
      startedAt

    • setStartedAt

      public void setStartedAt(@Nullable String startedAt)

    • stoppedAt

      public GetExperimentResponse stoppedAt(@Nullable String stoppedAt)

    • getStoppedAt

      @Nullable public String getStoppedAt()
      Get stoppedAt
      Returns:
      stoppedAt

    • setStoppedAt

      public void setStoppedAt(@Nullable String stoppedAt)

    • updatedAt

      public GetExperimentResponse updatedAt(@Nonnull String updatedAt)

    • getUpdatedAt

      @Nonnull public String getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull String updatedAt)

    • putAdditionalProperty

      public GetExperimentResponse 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 GetExperimentResponse 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 GetExperimentResponse

    • fromJson

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

    • toJson

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