Package growthbook.sdk.java

Class Experiment.ExperimentBuilder<ValueType>

java.lang.Object

growthbook.sdk.java.Experiment.ExperimentBuilder<ValueType>

Enclosing class:

Experiment<ValueType>

public static class Experiment.ExperimentBuilder<ValueType>
extends Object

Method Summary

Modifier and Type	Method	Description
Experiment.ExperimentBuilder<ValueType>	bucketVersion(Integer bucketVersion)	The sticky bucket version number that can be used to force a re-bucketing of users (default to 0)
Experiment<ValueType>	build()
Experiment.ExperimentBuilder<ValueType>	conditionJson(com.google.gson.JsonObject conditionJson)	Optional targeting condition
Experiment.ExperimentBuilder<ValueType>	coverage(Float coverage)	What percent of users should be included in the experiment (between 0 and 1, inclusive)
Experiment.ExperimentBuilder<ValueType>	disableStickyBucketing(Boolean disableStickyBucketing)	If true, sticky bucketing will be disabled for this experiment.
Experiment.ExperimentBuilder<ValueType>	fallbackAttribute(String fallbackAttribute)	When using sticky bucketing, can be used as a fallback to assign variations
Experiment.ExperimentBuilder<ValueType>	filters(ArrayList<Filter> filters)	Array of filters to apply
Experiment.ExperimentBuilder<ValueType>	force(Integer force)	All users included in the experiment will be forced into the specific variation index
Experiment.ExperimentBuilder<ValueType>	hashAttribute(String hashAttribute)	What user attribute should be used to assign variations (defaults to `id`) All users included in the experiment will be forced into the specific variation index
Experiment.ExperimentBuilder<ValueType>	hashVersion(Integer hashVersion)	The hash version to use (default to 1)
Experiment.ExperimentBuilder<ValueType>	isActive(Boolean isActive)	If set to false, always return the control (first variation)
Experiment.ExperimentBuilder<ValueType>	key(String key)	The globally unique identifier for the experiment
Experiment.ExperimentBuilder<ValueType>	meta(ArrayList<VariationMeta> meta)	Meta info about the variations
Experiment.ExperimentBuilder<ValueType>	minBucketVersion(Integer minBucketVersion)	Any users with a sticky bucket version less than this will be excluded from the experiment
Experiment.ExperimentBuilder<ValueType>	name(String name)	Human-readable name for the experiment
Experiment.ExperimentBuilder<ValueType>	namespace(Namespace namespace)	Deprecated.
Experiment.ExperimentBuilder<ValueType>	parentConditions(ArrayList<ParentCondition> parentConditions)	Each item defines a prerequisite where a `condition` must evaluate against a parent feature's value (identified by `id`).
Experiment.ExperimentBuilder<ValueType>	phase(String phase)	Identifier of the current experiment phase
Experiment.ExperimentBuilder<ValueType>	ranges(ArrayList<BucketRange> ranges)	Array of ranges, one per variation
Experiment.ExperimentBuilder<ValueType>	seed(String seed)	The hash seed to use
String	toString()
Experiment.ExperimentBuilder<ValueType>	variations(ArrayList<ValueType> variations)	The different variations to choose between
Experiment.ExperimentBuilder<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

key

public Experiment.ExperimentBuilder<ValueType> key(String key)

The globally unique identifier for the experiment

Returns:

this.

variations

public Experiment.ExperimentBuilder<ValueType> variations(ArrayList<ValueType> variations)

The different variations to choose between

Returns:

this.

weights

public Experiment.ExperimentBuilder<ValueType> weights(@Nullable
 ArrayList<Float> weights)

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

Returns:

this.

isActive

public Experiment.ExperimentBuilder<ValueType> isActive(@Nullable
 Boolean isActive)

If set to false, always return the control (first variation)

Returns:

this.

coverage

public Experiment.ExperimentBuilder<ValueType> coverage(Float coverage)

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

Returns:

this.

conditionJson

public Experiment.ExperimentBuilder<ValueType> conditionJson(com.google.gson.JsonObject conditionJson)

Optional targeting condition

Returns:

this.

parentConditions

public Experiment.ExperimentBuilder<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.

namespace

@Deprecated
public Experiment.ExperimentBuilder<ValueType> namespace(@Nullable
 Namespace namespace)

Deprecated.

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

Returns:

this.

force

public Experiment.ExperimentBuilder<ValueType> force(Integer force)

All users included in the experiment will be forced into the specific variation index

Returns:

this.

hashAttribute

public Experiment.ExperimentBuilder<ValueType> hashAttribute(String hashAttribute)

What user attribute should be used to assign variations (defaults to `id`) All users included in the experiment will be forced into the specific variation index

Returns:

this.

hashVersion

public Experiment.ExperimentBuilder<ValueType> hashVersion(@Nullable
 Integer hashVersion)

The hash version to use (default to 1)

Returns:

this.

ranges

public Experiment.ExperimentBuilder<ValueType> ranges(@Nullable
 ArrayList<BucketRange> ranges)

Array of ranges, one per variation

Returns:

this.

meta

public Experiment.ExperimentBuilder<ValueType> meta(@Nullable
 ArrayList<VariationMeta> meta)

Meta info about the variations

Returns:

this.

filters

public Experiment.ExperimentBuilder<ValueType> filters(@Nullable
 ArrayList<Filter> filters)

Array of filters to apply

Returns:

this.

seed

public Experiment.ExperimentBuilder<ValueType> seed(@Nullable
 String seed)

The hash seed to use

Returns:

this.

name

public Experiment.ExperimentBuilder<ValueType> name(@Nullable
 String name)

Human-readable name for the experiment

Returns:

this.

phase

public Experiment.ExperimentBuilder<ValueType> phase(@Nullable
 String phase)

Identifier of the current experiment phase

Returns:

this.

fallbackAttribute

public Experiment.ExperimentBuilder<ValueType> fallbackAttribute(@Nullable
 String fallbackAttribute)

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

Returns:

this.

disableStickyBucketing

public Experiment.ExperimentBuilder<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 Experiment.ExperimentBuilder<ValueType> bucketVersion(@Nullable
 Integer bucketVersion)

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

Returns:

this.

minBucketVersion

public Experiment.ExperimentBuilder<ValueType> minBucketVersion(@Nullable
 Integer minBucketVersion)

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

Returns:

this.

build

public Experiment<ValueType> build()

toString

public String toString()

Overrides:

toString in class Object