Class IterationRep


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2026-03-05T10:45:26.516033Z[Etc/UTC]",
               comments="Generator version: 7.18.0")
    public class IterationRep
    extends java.lang.Object
    IterationRep
    • Field Detail

      • SERIALIZED_NAME_ID

        public static final java.lang.String SERIALIZED_NAME_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_HYPOTHESIS

        public static final java.lang.String SERIALIZED_NAME_HYPOTHESIS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_STATUS

        public static final java.lang.String SERIALIZED_NAME_STATUS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CREATED_AT

        public static final java.lang.String SERIALIZED_NAME_CREATED_AT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_STARTED_AT

        public static final java.lang.String SERIALIZED_NAME_STARTED_AT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ENDED_AT

        public static final java.lang.String SERIALIZED_NAME_ENDED_AT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_WINNING_TREATMENT_ID

        public static final java.lang.String SERIALIZED_NAME_WINNING_TREATMENT_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_WINNING_REASON

        public static final java.lang.String SERIALIZED_NAME_WINNING_REASON
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CAN_RESHUFFLE_TRAFFIC

        public static final java.lang.String SERIALIZED_NAME_CAN_RESHUFFLE_TRAFFIC
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_FLAGS

        public static final java.lang.String SERIALIZED_NAME_FLAGS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_REALLOCATION_FREQUENCY_MILLIS

        public static final java.lang.String SERIALIZED_NAME_REALLOCATION_FREQUENCY_MILLIS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VERSION

        public static final java.lang.String SERIALIZED_NAME_VERSION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PRIMARY_METRIC

        public static final java.lang.String SERIALIZED_NAME_PRIMARY_METRIC
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PRIMARY_SINGLE_METRIC

        public static final java.lang.String SERIALIZED_NAME_PRIMARY_SINGLE_METRIC
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PRIMARY_FUNNEL

        public static final java.lang.String SERIALIZED_NAME_PRIMARY_FUNNEL
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_RANDOMIZATION_UNIT

        public static final java.lang.String SERIALIZED_NAME_RANDOMIZATION_UNIT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ATTRIBUTES

        public static final java.lang.String SERIALIZED_NAME_ATTRIBUTES
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TREATMENTS

        public static final java.lang.String SERIALIZED_NAME_TREATMENTS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_SECONDARY_METRICS

        public static final java.lang.String SERIALIZED_NAME_SECONDARY_METRICS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_METRICS

        public static final java.lang.String SERIALIZED_NAME_METRICS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_LAYER_SNAPSHOT

        public static final java.lang.String SERIALIZED_NAME_LAYER_SNAPSHOT
        See Also:
        Constant Field Values
      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields
      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields
    • Constructor Detail

      • IterationRep

        public IterationRep()
    • Method Detail

      • id

        public IterationRep id​(@Nullable
                               java.lang.String id)
      • getId

        @Nullable
        public java.lang.String getId()
        The iteration ID
        Returns:
        id
      • setId

        public void setId​(@Nullable
                          java.lang.String id)
      • hypothesis

        public IterationRep hypothesis​(@Nonnull
                                       java.lang.String hypothesis)
      • getHypothesis

        @Nonnull
        public java.lang.String getHypothesis()
        The expected outcome of this experiment
        Returns:
        hypothesis
      • setHypothesis

        public void setHypothesis​(@Nonnull
                                  java.lang.String hypothesis)
      • getStatus

        @Nonnull
        public IterationRep.StatusEnum getStatus()
        The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
        Returns:
        status
      • createdAt

        public IterationRep createdAt​(@Nonnull
                                      java.lang.Long createdAt)
      • getCreatedAt

        @Nonnull
        public java.lang.Long getCreatedAt()
        Get createdAt
        Returns:
        createdAt
      • setCreatedAt

        public void setCreatedAt​(@Nonnull
                                 java.lang.Long createdAt)
      • startedAt

        public IterationRep startedAt​(@Nullable
                                      java.lang.Long startedAt)
      • getStartedAt

        @Nullable
        public java.lang.Long getStartedAt()
        Get startedAt
        Returns:
        startedAt
      • setStartedAt

        public void setStartedAt​(@Nullable
                                 java.lang.Long startedAt)
      • endedAt

        public IterationRep endedAt​(@Nullable
                                    java.lang.Long endedAt)
      • getEndedAt

        @Nullable
        public java.lang.Long getEndedAt()
        Get endedAt
        Returns:
        endedAt
      • setEndedAt

        public void setEndedAt​(@Nullable
                               java.lang.Long endedAt)
      • winningTreatmentId

        public IterationRep winningTreatmentId​(@Nullable
                                               java.lang.String winningTreatmentId)
      • getWinningTreatmentId

        @Nullable
        public java.lang.String getWinningTreatmentId()
        The ID of the treatment chosen when the experiment stopped
        Returns:
        winningTreatmentId
      • setWinningTreatmentId

        public void setWinningTreatmentId​(@Nullable
                                          java.lang.String winningTreatmentId)
      • winningReason

        public IterationRep winningReason​(@Nullable
                                          java.lang.String winningReason)
      • getWinningReason

        @Nullable
        public java.lang.String getWinningReason()
        The reason you stopped the experiment
        Returns:
        winningReason
      • setWinningReason

        public void setWinningReason​(@Nullable
                                     java.lang.String winningReason)
      • canReshuffleTraffic

        public IterationRep canReshuffleTraffic​(@Nullable
                                                java.lang.Boolean canReshuffleTraffic)
      • getCanReshuffleTraffic

        @Nullable
        public java.lang.Boolean getCanReshuffleTraffic()
        Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false).
        Returns:
        canReshuffleTraffic
      • setCanReshuffleTraffic

        public void setCanReshuffleTraffic​(@Nullable
                                           java.lang.Boolean canReshuffleTraffic)
      • flags

        public IterationRep flags​(@Nullable
                                  java.util.Map<java.lang.String,​FlagRep> flags)
      • putFlagsItem

        public IterationRep putFlagsItem​(java.lang.String key,
                                         FlagRep flagsItem)
      • getFlags

        @Nullable
        public java.util.Map<java.lang.String,​FlagRep> getFlags()
        Details on the flag used in this experiment
        Returns:
        flags
      • setFlags

        public void setFlags​(@Nullable
                             java.util.Map<java.lang.String,​FlagRep> flags)
      • reallocationFrequencyMillis

        public IterationRep reallocationFrequencyMillis​(@Nullable
                                                        java.lang.Integer reallocationFrequencyMillis)
      • getReallocationFrequencyMillis

        @Nullable
        public java.lang.Integer getReallocationFrequencyMillis()
        The cadence (in milliseconds) to update the allocation. Only present for multi-armed bandits.
        Returns:
        reallocationFrequencyMillis
      • setReallocationFrequencyMillis

        public void setReallocationFrequencyMillis​(@Nullable
                                                   java.lang.Integer reallocationFrequencyMillis)
      • version

        public IterationRep version​(@Nullable
                                    java.lang.Integer version)
      • getVersion

        @Nullable
        public java.lang.Integer getVersion()
        The current version that the iteration is on
        Returns:
        version
      • setVersion

        public void setVersion​(@Nullable
                               java.lang.Integer version)
      • getPrimarySingleMetric

        @Nullable
        public MetricV2Rep getPrimarySingleMetric()
        Get primarySingleMetric
        Returns:
        primarySingleMetric
      • setPrimarySingleMetric

        public void setPrimarySingleMetric​(@Nullable
                                           MetricV2Rep primarySingleMetric)
      • randomizationUnit

        public IterationRep randomizationUnit​(@Nullable
                                              java.lang.String randomizationUnit)
      • getRandomizationUnit

        @Nullable
        public java.lang.String getRandomizationUnit()
        The unit of randomization for this iteration
        Returns:
        randomizationUnit
      • setRandomizationUnit

        public void setRandomizationUnit​(@Nullable
                                         java.lang.String randomizationUnit)
      • attributes

        public IterationRep attributes​(@Nullable
                                       java.util.List<java.lang.String> attributes)
      • addAttributesItem

        public IterationRep addAttributesItem​(java.lang.String attributesItem)
      • getAttributes

        @Nullable
        public java.util.List<java.lang.String> getAttributes()
        The available attribute filters for this iteration
        Returns:
        attributes
      • setAttributes

        public void setAttributes​(@Nullable
                                  java.util.List<java.lang.String> attributes)
      • getTreatments

        @Nullable
        public java.util.List<TreatmentRep> getTreatments()
        Details on the variations you are testing in the experiment
        Returns:
        treatments
      • setTreatments

        public void setTreatments​(@Nullable
                                  java.util.List<TreatmentRep> treatments)
      • secondaryMetrics

        @Deprecated
        public IterationRep secondaryMetrics​(@Nullable
                                             java.util.List<MetricV2Rep> secondaryMetrics)
        Deprecated.
      • getSecondaryMetrics

        @Deprecated
        @Nullable
        public java.util.List<MetricV2Rep> getSecondaryMetrics()
        Deprecated.
        Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment.
        Returns:
        secondaryMetrics
      • setSecondaryMetrics

        @Deprecated
        public void setSecondaryMetrics​(@Nullable
                                        java.util.List<MetricV2Rep> secondaryMetrics)
        Deprecated.
      • getLayerSnapshot

        @Nullable
        public LayerSnapshotRep getLayerSnapshot()
        Get layerSnapshot
        Returns:
        layerSnapshot
      • setLayerSnapshot

        public void setLayerSnapshot​(@Nullable
                                     LayerSnapshotRep layerSnapshot)
      • putAdditionalProperty

        public IterationRep putAdditionalProperty​(java.lang.String key,
                                                  java.lang.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 IterationRep instance itself
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

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

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws java.io.IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        java.io.IOException - if the JSON Element is invalid with respect to IterationRep
      • fromJson

        public static IterationRep fromJson​(java.lang.String jsonString)
                                     throws java.io.IOException
        Create an instance of IterationRep given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of IterationRep
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to IterationRep
      • toJson

        public java.lang.String toJson()
        Convert an instance of IterationRep to an JSON string
        Returns:
        JSON string