com.urbanairship.api.experiments.model

Class Experiment

java.lang.Object

com.urbanairship.api.common.model.APIModelObject

com.urbanairship.api.experiments.model.ExperimentModelObject

com.urbanairship.api.experiments.model.Experiment

public final class Experiment
extends ExperimentModelObject

Represents a set of varied pushes to send as part of an A/B experiment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Experiment.Builder Experiment Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Selector	getAudience() Get the audience for the experiment.
java.util.Optional<Campaigns>	getCampaigns() Get the campaigns object for the experiment.
java.util.Optional<java.math.BigDecimal>	getControl() Get the control group for the experiment.
java.util.Optional<java.lang.String>	getDescription() Get the description for the experiment.
DeviceTypeData	getDeviceTypes() Get the device types for the experiment.
java.util.Optional<MessageType>	getMessageType() Get the message type for the experiment.
java.util.Optional<java.lang.String>	getName() Get the name of the experiment.
java.util.Optional<Orchestration>	getOrchestration() Get the orchestration for the experiment.
java.util.List<Variant>	getVariants() Get the variants for the experiment.
int	hashCode()
boolean	isBroadcast() Boolean indicating whether audience is SelectorType.ALL
static Experiment.Builder	newBuilder() Experiment builder
java.lang.String	toString()

Methods inherited from class com.urbanairship.api.experiments.model.ExperimentModelObject

toJSON

Methods inherited from class com.urbanairship.api.common.model.APIModelObject

toJSON

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static Experiment.Builder newBuilder()

Experiment builder

Returns:

Builder

getName

public java.util.Optional<java.lang.String> getName()

Get the name of the experiment.

Returns:

an Optional String

getDescription

public java.util.Optional<java.lang.String> getDescription()

Get the description for the experiment.

Returns:

an Optional String

getControl

public java.util.Optional<java.math.BigDecimal> getControl()

Get 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.

Returns:

an Optional BigDecimal

getAudience

public Selector getAudience()

Get the audience for the experiment.

Returns:

an Audience object

isBroadcast

public boolean isBroadcast()

Boolean indicating whether audience is SelectorType.ALL

Returns:

Boolean

getDeviceTypes

public DeviceTypeData getDeviceTypes()

Get the device types for the experiment.

Returns:

a DeviceTypeData object

getVariants

public java.util.List<Variant> getVariants()

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

Returns:

variants List<Variant>

getOrchestration

public java.util.Optional<Orchestration> getOrchestration()

Get the orchestration for the experiment.

Returns:

an Orchestration object

getMessageType

public java.util.Optional<MessageType> getMessageType()

Get the message type for the experiment.

Returns:

an MessageType object

getCampaigns

public java.util.Optional<Campaigns> getCampaigns()

Get the campaigns object for the experiment.

Returns:

an Campaigns 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