Package growthbook.sdk.java.model

Class FeatureRule.FeatureRuleBuilder<ValueType>

java.lang.Object

growthbook.sdk.java.model.FeatureRule.FeatureRuleBuilder<ValueType>

Enclosing class:

FeatureRule<ValueType>

public static class FeatureRule.FeatureRuleBuilder<ValueType>
extends Object

Method Summary

Modifier and Type	Method	Description
FeatureRule.FeatureRuleBuilder<ValueType>	bucketVersion(Integer bucketVersion)	A sticky bucket version number that can be used to force a re-bucketing of users (default to 0)
FeatureRule<ValueType>	build()
FeatureRule.FeatureRuleBuilder<ValueType>	condition(com.google.gson.JsonObject condition)	Optional targeting condition
FeatureRule.FeatureRuleBuilder<ValueType>	coverage(Float coverage)	What percent of users should be included in the experiment (between 0 and 1, inclusive)
FeatureRule.FeatureRuleBuilder<ValueType>	disableStickyBucketing(Boolean disableStickyBucketing)	If true, sticky bucketing will be disabled for this experiment.
FeatureRule.FeatureRuleBuilder<ValueType>	fallbackAttribute(String fallbackAttribute)	When using sticky bucketing, can be used as a fallback to assign variations
FeatureRule.FeatureRuleBuilder<ValueType>	filters(ArrayList<Filter> filters)	Array of filters to apply to the rule
FeatureRule.FeatureRuleBuilder<ValueType>	force(OptionalField<ValueType> force)	Immediately force a specific value (ignore every other option besides condition and coverage)
FeatureRule.FeatureRuleBuilder<ValueType>	hashAttribute(String hashAttribute)	What user attribute should be used to assign variations (defaults to id)
FeatureRule.FeatureRuleBuilder<ValueType>	hashVersion(Integer hashVersion)	The hash version to use (default to 1)
FeatureRule.FeatureRuleBuilder<ValueType>	id(String id)	Unique feature rule id
FeatureRule.FeatureRuleBuilder<ValueType>	key(String key)	The globally unique tracking key for the experiment (default to the feature key)
FeatureRule.FeatureRuleBuilder<ValueType>	meta(ArrayList<VariationMeta> meta)	Meta info about the experiment variations
FeatureRule.FeatureRuleBuilder<ValueType>	minBucketVersion(Integer minBucketVersion)	Any users with a sticky bucket version less than this will be excluded from the experiment
FeatureRule.FeatureRuleBuilder<ValueType>	name(String name)	Human-readable name for the experiment
FeatureRule.FeatureRuleBuilder<ValueType>	namespace(Namespace namespace)	Deprecated.
FeatureRule.FeatureRuleBuilder<ValueType>	parentConditions(ArrayList<ParentCondition> parentConditions)	Each item defines a prerequisite where a `condition` must evaluate against a parent feature's value (identified by `id`).
FeatureRule.FeatureRuleBuilder<ValueType>	phase(String phase)	The phase id of the experiment
FeatureRule.FeatureRuleBuilder<ValueType>	range(BucketRange range)	A more precise version of coverage
FeatureRule.FeatureRuleBuilder<ValueType>	ranges(ArrayList<BucketRange> ranges)	Ranges for experiment variations
FeatureRule.FeatureRuleBuilder<ValueType>	seed(String seed)	Seed to use for hashing
String	toString()
FeatureRule.FeatureRuleBuilder<ValueType>	tracks(ArrayList<TrackData<ValueType>> tracks)	Array of tracking calls to fire
FeatureRule.FeatureRuleBuilder<ValueType>	variations(ArrayList<ValueType> variations)	Run an experiment (A/B test) and randomly choose between these variations
FeatureRule.FeatureRuleBuilder<ValueType>	weights(ArrayList<Float> weights)	How to weight traffic between variations.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

id

public FeatureRule.FeatureRuleBuilder<ValueType> id(@Nullable
 String id)

Unique feature rule id

Returns:

this.

key

public FeatureRule.FeatureRuleBuilder<ValueType> key(@Nullable
 String key)

The globally unique tracking key for the experiment (default to the feature key)

Returns:

this.

coverage

public FeatureRule.FeatureRuleBuilder<ValueType> coverage(@Nullable
 Float coverage)

What percent of users should be included in the experiment (between 0 and 1, inclusive)

Returns:

this.

force

public FeatureRule.FeatureRuleBuilder<ValueType> force(@Nullable
 OptionalField<ValueType> force)

Immediately force a specific value (ignore every other option besides condition and coverage)

Returns:

this.

variations

public FeatureRule.FeatureRuleBuilder<ValueType> variations(@Nullable
 ArrayList<ValueType> variations)

Run an experiment (A/B test) and randomly choose between these variations

Returns:

this.

weights

public FeatureRule.FeatureRuleBuilder<ValueType> weights(@Nullable
 ArrayList<Float> weights)

How to weight traffic between variations. Must add to 1.

Returns:

this.

namespace

@Deprecated
public FeatureRule.FeatureRuleBuilder<ValueType> namespace(@Nullable
 Namespace namespace)

Deprecated.

A tuple that contains the namespace identifier, plus a range of coverage for the experiment.

Returns:

this.

hashAttribute

public FeatureRule.FeatureRuleBuilder<ValueType> hashAttribute(String hashAttribute)

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

Returns:

this.

condition

public FeatureRule.FeatureRuleBuilder<ValueType> condition(@Nullable
 com.google.gson.JsonObject condition)

Optional targeting condition

Returns:

this.

parentConditions

public FeatureRule.FeatureRuleBuilder<ValueType> parentConditions(@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.

Returns:

this.

hashVersion

public FeatureRule.FeatureRuleBuilder<ValueType> hashVersion(@Nullable
 Integer hashVersion)

The hash version to use (default to 1)

Returns:

this.

range

public FeatureRule.FeatureRuleBuilder<ValueType> range(@Nullable
 BucketRange range)

A more precise version of coverage

Returns:

this.

ranges

public FeatureRule.FeatureRuleBuilder<ValueType> ranges(@Nullable
 ArrayList<BucketRange> ranges)

Ranges for experiment variations

Returns:

this.

meta

public FeatureRule.FeatureRuleBuilder<ValueType> meta(@Nullable
 ArrayList<VariationMeta> meta)

Meta info about the experiment variations

Returns:

this.

filters

public FeatureRule.FeatureRuleBuilder<ValueType> filters(@Nullable
 ArrayList<Filter> filters)

Array of filters to apply to the rule

Returns:

this.

seed

public FeatureRule.FeatureRuleBuilder<ValueType> seed(@Nullable
 String seed)

Seed to use for hashing

Returns:

this.

name

public FeatureRule.FeatureRuleBuilder<ValueType> name(@Nullable
 String name)

Human-readable name for the experiment

Returns:

this.

phase

public FeatureRule.FeatureRuleBuilder<ValueType> phase(@Nullable
 String phase)

The phase id of the experiment

Returns:

this.

fallbackAttribute

public FeatureRule.FeatureRuleBuilder<ValueType> fallbackAttribute(@Nullable
 String fallbackAttribute)

When using sticky bucketing, can be used as a fallback to assign variations

Returns:

this.

disableStickyBucketing

public FeatureRule.FeatureRuleBuilder<ValueType> disableStickyBucketing(@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)

Returns:

this.

bucketVersion

public FeatureRule.FeatureRuleBuilder<ValueType> bucketVersion(@Nullable
 Integer bucketVersion)

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

Returns:

this.

minBucketVersion

public FeatureRule.FeatureRuleBuilder<ValueType> minBucketVersion(@Nullable
 Integer minBucketVersion)

Any users with a sticky bucket version less than this will be excluded from the experiment

Returns:

this.

tracks

public FeatureRule.FeatureRuleBuilder<ValueType> tracks(@Nullable
 ArrayList<TrackData<ValueType>> tracks)

Array of tracking calls to fire

Returns:

this.

build

public FeatureRule<ValueType> build()

toString

public String toString()

Overrides:

toString in class Object