Package growthbook.sdk.java.model

Class FeatureRule<ValueType>

java.lang.Object
serializers.SuperTypeToken<ValueType>
growthbook.sdk.java.model.FeatureRule<ValueType>
Type Parameters:
ValueType - generic type for the value type for this experiment's variations.
All Implemented Interfaces:
com.google.gson.JsonDeserializer<FeatureRule<ValueType>>
public class FeatureRule<ValueType> extends SuperTypeToken<ValueType> implements com.google.gson.JsonDeserializer<FeatureRule<ValueType>>
Overrides the defaultValue of a Feature based on a set of requirements. Has a number of optional properties
  • condition (Condition) - Optional targeting condition
  • coverage (number) - What percent of users should be included in the experiment (between 0 and 1, inclusive)
  • force (any) - Immediately force a specific value (ignore every other option besides condition and coverage)
  • variations (any[]) - Run an experiment (A/B test) and randomly choose between these variations
  • key (string) - The globally unique tracking key for the experiment (default to the feature key)
  • weights (number[]) - How to weight traffic between variations. Must add to 1.
  • namespace (Namespace) - Adds the experiment to a namespace
  • hashAttribute (string) - What user attribute should be used to assign variations (defaults to id)

  • Constructor Details

  • Method Details

    • deserialize

      public FeatureRule<ValueType> deserialize(com.google.gson.JsonElement json, Type typeOfT, com.google.gson.JsonDeserializationContext context)
      Specified by:
      deserialize in interface com.google.gson.JsonDeserializer<ValueType>

    • builder

      public static <ValueType> FeatureRule.FeatureRuleBuilder<ValueType> builder()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      @Nullable public String getId()
      Unique feature rule id

    • getKey

      @Nullable public String getKey()
      The globally unique tracking key for the experiment (default to the feature key)

    • getCoverage

      @Nullable public Float getCoverage()
      What percent of users should be included in the experiment (between 0 and 1, inclusive)

    • getForce

      @Nullable public OptionalField<ValueType> getForce()
      Immediately force a specific value (ignore every other option besides condition and coverage)

    • getVariations

      @Nullable public ArrayList<ValueType> getVariations()
      Run an experiment (A/B test) and randomly choose between these variations

    • getWeights

      @Nullable public ArrayList<Float> getWeights()
      How to weight traffic between variations. Must add to 1.

    • getNamespace

      @Deprecated @Nullable public Namespace getNamespace()
      Deprecated.
      A tuple that contains the namespace identifier, plus a range of coverage for the experiment.

    • getHashAttribute

      public String getHashAttribute()
      What user attribute should be used to assign variations (defaults to id)

    • getCondition

      @Nullable public com.google.gson.JsonObject getCondition()
      Optional targeting condition

    • getParentConditions

      @Nullable public ArrayList<ParentCondition> getParentConditions()
      Each item defines a prerequisite where a `condition` must evaluate against a parent feature's value (identified by `id`). If `gate` is true, then this is a blocking feature-level prerequisite; otherwise it applies to the current rule only.

    • getHashVersion

      @Nullable public Integer getHashVersion()
      The hash version to use (default to 1)

    • getRange

      @Nullable public BucketRange getRange()
      A more precise version of coverage

    • getRanges

      @Nullable public ArrayList<BucketRange> getRanges()
      Ranges for experiment variations

    • getMeta

      @Nullable public ArrayList<VariationMeta> getMeta()
      Meta info about the experiment variations

    • getFilters

      @Nullable public ArrayList<Filter> getFilters()
      Array of filters to apply to the rule

    • getSeed

      @Nullable public String getSeed()
      Seed to use for hashing

    • getName

      @Nullable public String getName()
      Human-readable name for the experiment

    • getPhase

      @Nullable public String getPhase()
      The phase id of the experiment

    • getFallbackAttribute

      @Nullable public String getFallbackAttribute()
      When using sticky bucketing, can be used as a fallback to assign variations

    • getDisableStickyBucketing

      @Nullable public Boolean getDisableStickyBucketing()
      If true, sticky bucketing will be disabled for this experiment. (Note: sticky bucketing is only available if a StickyBucketingService is provided in the Context)

    • getBucketVersion

      @Nullable public Integer getBucketVersion()
      A sticky bucket version number that can be used to force a re-bucketing of users (default to 0)

    • getMinBucketVersion

      @Nullable public Integer getMinBucketVersion()
      Any users with a sticky bucket version less than this will be excluded from the experiment

    • getTracks

      @Nullable public ArrayList<TrackData<ValueType>> getTracks()
      Array of tracking calls to fire

    • setId

      public void setId(@Nullable String id)
      Unique feature rule id

    • setKey

      public void setKey(@Nullable String key)
      The globally unique tracking key for the experiment (default to the feature key)

    • setCoverage

      public void setCoverage(@Nullable Float coverage)
      What percent of users should be included in the experiment (between 0 and 1, inclusive)

    • setForce

      public void setForce(@Nullable OptionalField<ValueType> force)
      Immediately force a specific value (ignore every other option besides condition and coverage)

    • setVariations

      public void setVariations(@Nullable ArrayList<ValueType> variations)
      Run an experiment (A/B test) and randomly choose between these variations

    • setWeights

      public void setWeights(@Nullable ArrayList<Float> weights)
      How to weight traffic between variations. Must add to 1.

    • setNamespace

      @Deprecated public void setNamespace(@Nullable Namespace namespace)
      Deprecated.
      A tuple that contains the namespace identifier, plus a range of coverage for the experiment.

    • setHashAttribute

      public void setHashAttribute(String hashAttribute)
      What user attribute should be used to assign variations (defaults to id)

    • setCondition

      public void setCondition(@Nullable com.google.gson.JsonObject condition)
      Optional targeting condition

    • setParentConditions

      public void setParentConditions(@Nullable ArrayList<ParentCondition> parentConditions)
      Each item defines a prerequisite where a `condition` must evaluate against a parent feature's value (identified by `id`). If `gate` is true, then this is a blocking feature-level prerequisite; otherwise it applies to the current rule only.

    • setHashVersion

      public void setHashVersion(@Nullable Integer hashVersion)
      The hash version to use (default to 1)

    • setRange

      public void setRange(@Nullable BucketRange range)
      A more precise version of coverage

    • setRanges

      public void setRanges(@Nullable ArrayList<BucketRange> ranges)
      Ranges for experiment variations

    • setMeta

      public void setMeta(@Nullable ArrayList<VariationMeta> meta)
      Meta info about the experiment variations

    • setFilters

      public void setFilters(@Nullable ArrayList<Filter> filters)
      Array of filters to apply to the rule

    • setSeed

      public void setSeed(@Nullable String seed)
      Seed to use for hashing

    • setName

      public void setName(@Nullable String name)
      Human-readable name for the experiment

    • setPhase

      public void setPhase(@Nullable String phase)
      The phase id of the experiment

    • setFallbackAttribute

      public void setFallbackAttribute(@Nullable String fallbackAttribute)
      When using sticky bucketing, can be used as a fallback to assign variations

    • setDisableStickyBucketing

      public void setDisableStickyBucketing(@Nullable Boolean disableStickyBucketing)
      If true, sticky bucketing will be disabled for this experiment. (Note: sticky bucketing is only available if a StickyBucketingService is provided in the Context)

    • setBucketVersion

      public void setBucketVersion(@Nullable Integer bucketVersion)
      A sticky bucket version number that can be used to force a re-bucketing of users (default to 0)

    • setMinBucketVersion

      public void setMinBucketVersion(@Nullable Integer minBucketVersion)
      Any users with a sticky bucket version less than this will be excluded from the experiment

    • setTracks

      public void setTracks(@Nullable ArrayList<TrackData<ValueType>> tracks)
      Array of tracking calls to fire

    • toString

      public String toString()
      Overrides:
      toString in class Object