com.urbanairship.api.experiments.model

Class Experiment.Builder

java.lang.Object

com.urbanairship.api.experiments.model.Experiment.Builder

Enclosing class:

Experiment

public static class Experiment.Builder
extends java.lang.Object

Experiment Builder

Method Summary

Modifier and Type	Method and Description
Experiment.Builder	addAllVariants(java.util.List<Variant> variants)
Experiment.Builder	addVariant(Variant variant) Add a variant to the experiment.
Experiment	build() Build an Experiment object.
Experiment.Builder	setAudience(Selector audience) Set the audience for the experiment.
Experiment.Builder	setCampaigns(Campaigns campaigns) Set the campaigns for the experiment.
Experiment.Builder	setControl(java.math.BigDecimal control) Set the control group for the experiment.
Experiment.Builder	setDescription(java.lang.String description) Set the experiment description.
Experiment.Builder	setDeviceTypes(DeviceTypeData deviceTypes) Set the device types for the experiment.
Experiment.Builder	setMessageType(MessageType messageType) Set the message type for the experiment.
Experiment.Builder	setName(java.lang.String name) Set the experiment name.
Experiment.Builder	setOrchestration(Orchestration orchestration) Set the Orchestration for the experiment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setName

public Experiment.Builder setName(java.lang.String name)

Set the experiment name.

Parameters:

name - String

Returns:

Builder

setDescription

public Experiment.Builder setDescription(java.lang.String description)

Set the experiment description.

Parameters:

description - String

Returns:

Builder

setControl

public Experiment.Builder setControl(java.math.BigDecimal control)

Set the control group for the experiment. A control is a float between 0 and 1, e.g., 0.4, representing the proportion of the audience that will not receive a push. The remaining audience is split between the variants.

Parameters:

control - BigDecimal

Returns:

Builder

setAudience

public Experiment.Builder setAudience(Selector audience)

Set the audience for the experiment.

Parameters:

audience - Selector

Returns:

Builder

setDeviceTypes

public Experiment.Builder setDeviceTypes(DeviceTypeData deviceTypes)

Set the device types for the experiment.

Parameters:

deviceTypes - DeviceTypeData

Returns:

Builder

addVariant

public Experiment.Builder addVariant(Variant variant)

Add a variant to the experiment. A variant defines a push that will be sent to a subset of the experiment's audience.

Parameters:

variant - List<Variant>

Returns:

Builder

addAllVariants

public Experiment.Builder addAllVariants(java.util.List<Variant> variants)

setOrchestration

public Experiment.Builder setOrchestration(Orchestration orchestration)

Set the Orchestration for the experiment.

Parameters:

orchestration - Orchestration

Returns:

Builder

setMessageType

public Experiment.Builder setMessageType(MessageType messageType)

Set the message type for the experiment.

Parameters:

messageType - MessageType

Returns:

Builder

setCampaigns

public Experiment.Builder setCampaigns(Campaigns campaigns)

Set the campaigns for the experiment.

Parameters:

campaigns - Campaigns

Returns:

Builder

build

public Experiment build()

Build an Experiment object. Will fail if any of the following preconditions are not met.

 1. Audience must be set.
 2. DeviceTypes (device types) must be set.
 3. At least one variant must be present.
 

Returns:

Experiment

Throws:

java.lang.IllegalArgumentException - if illegal arguments are used

java.lang.NullPointerException - if audience, deviceTypes, or variants is not set