com.urbanairship.api.experiments.model

Class Variant

java.lang.Object

com.urbanairship.api.experiments.model.Variant

public class Variant
extends java.lang.Object

Defines a push that will be sent to a subset of an experiment's audience.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Optional<java.lang.String>	getDescription() Get the description of the experiment.
java.util.Optional<java.lang.String>	getName() Get the name of the variant.
java.util.Optional<Schedule>	getSchedule() Get the scheduled delivery time for the variant push.
VariantPushPayload	getVariantPushPayload() Get the partial push notification associated with the variant.
java.util.Optional<java.lang.Integer>	getWeight() Get the weight of the variant.
int	hashCode()
static Variant.Builder	newBuilder() Experiment builder
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static Variant.Builder newBuilder()

Experiment builder

Returns:

Builder

getName

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

Get the name of the variant.

Returns:

an Optional String

getDescription

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

Get the description of the experiment.

Returns:

an Optional String

getSchedule

public java.util.Optional<Schedule> getSchedule()

Get the scheduled delivery time for the variant push.

Returns:

an Optional Schedule object

getVariantPushPayload

public VariantPushPayload getVariantPushPayload()

Get the partial push notification associated with the variant. A partial push notification object represents a Push payload, excepting the audience and device_types fields because they are defined in the experiment object. Message Center messages are also not included in the partial push payload object.

Returns:

VariantPushPayload object

getWeight

public java.util.Optional<java.lang.Integer> getWeight()

Get the weight of the variant. Defaults to 1. A whole number, representing the proportion of the audience that will receive the variant.

Returns:

an Optional Integer

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object