Package com.launchdarkly.api.model

Class IterationInput

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

    • Field Detail

      • SERIALIZED_NAME_HYPOTHESIS

        public static final java.lang.String SERIALIZED_NAME_HYPOTHESIS
        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_METRICS

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

      • SERIALIZED_NAME_PRIMARY_SINGLE_METRIC_KEY

        public static final java.lang.String SERIALIZED_NAME_PRIMARY_SINGLE_METRIC_KEY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_PRIMARY_FUNNEL_KEY

        public static final java.lang.String SERIALIZED_NAME_PRIMARY_FUNNEL_KEY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_TREATMENTS

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

      • SERIALIZED_NAME_FLAGS

        public static final java.lang.String SERIALIZED_NAME_FLAGS
        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

      • openapiFields

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

      • openapiRequiredFields

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

    • Constructor Detail

      • IterationInput

        public IterationInput()

    • Method Detail

      • hypothesis

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

      • canReshuffleTraffic

        public IterationInput canReshuffleTraffic​(@Nullable
                                          java.lang.Boolean canReshuffleTraffic)

      • getCanReshuffleTraffic

        @Nullable
public java.lang.Boolean getCanReshuffleTraffic()
        Whether to allow the experiment to reassign traffic to different variations when you increase or decrease the traffic in your experiment audience (true) or keep all traffic assigned to its initial variation (false). Defaults to true.
        Returns:
        canReshuffleTraffic

      • setCanReshuffleTraffic

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

      • getMetrics

        @Nonnull
public java.util.List<MetricInput> getMetrics()
        Get metrics
        Returns:
        metrics

      • setMetrics

        public void setMetrics​(@Nonnull
                       java.util.List<MetricInput> metrics)

      • primarySingleMetricKey

        public IterationInput primarySingleMetricKey​(@Nullable
                                             java.lang.String primarySingleMetricKey)

      • getPrimarySingleMetricKey

        @Nullable
public java.lang.String getPrimarySingleMetricKey()
        The key of the primary metric for this experiment. Either <code>primarySingleMetricKey</code> or <code>primaryFunnelKey</code> must be present.
        Returns:
        primarySingleMetricKey

      • setPrimarySingleMetricKey

        public void setPrimarySingleMetricKey​(@Nullable
                                      java.lang.String primarySingleMetricKey)

      • primaryFunnelKey

        public IterationInput primaryFunnelKey​(@Nullable
                                       java.lang.String primaryFunnelKey)

      • getPrimaryFunnelKey

        @Nullable
public java.lang.String getPrimaryFunnelKey()
        The key of the primary funnel group for this experiment. Either <code>primarySingleMetricKey</code> or <code>primaryFunnelKey</code> must be present.
        Returns:
        primaryFunnelKey

      • setPrimaryFunnelKey

        public void setPrimaryFunnelKey​(@Nullable
                                java.lang.String primaryFunnelKey)

      • getTreatments

        @Nonnull
public java.util.List<TreatmentInput> getTreatments()
        Get treatments
        Returns:
        treatments

      • setTreatments

        public void setTreatments​(@Nonnull
                          java.util.List<TreatmentInput> treatments)

      • getFlags

        @Nonnull
public java.util.Map<java.lang.String,​FlagInput> getFlags()
        Get flags
        Returns:
        flags

      • setFlags

        public void setFlags​(@Nonnull
                     java.util.Map<java.lang.String,​FlagInput> flags)

      • randomizationUnit

        public IterationInput randomizationUnit​(@Nullable
                                        java.lang.String randomizationUnit)

      • getRandomizationUnit

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

      • setRandomizationUnit

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

      • attributes

        public IterationInput attributes​(@Nullable
                                 java.util.List<java.lang.String> attributes)

      • addAttributesItem

        public IterationInput addAttributesItem​(java.lang.String attributesItem)

      • getAttributes

        @Nullable
public java.util.List<java.lang.String> getAttributes()
        The attributes that this iteration's results can be sliced by
        Returns:
        attributes

      • setAttributes

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

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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