com.urbanairship.api.experiments.model

Class Variant.Builder

java.lang.Object

com.urbanairship.api.experiments.model.Variant.Builder

Enclosing class:

Variant

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

Variant Builder

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Variant	build() Build a Variant object.
Variant.Builder	setDescription(java.lang.String description) Set the variant description.
Variant.Builder	setName(java.lang.String name) Set the variant name.
Variant.Builder	setPushPayload(VariantPushPayload variantPushPayload) Set the partial push notification associated with the variant.
Variant.Builder	setSchedule(Schedule schedule) Set the time at which the variant push should be sent.
Variant.Builder	setWeight(java.lang.Integer weight) Set the weight of the variant.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setName

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

Set the variant name.

Parameters:

name - String

Returns:

Builder

setDescription

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

Set the variant description.

Parameters:

description - String

Returns:

Builder

setSchedule

public Variant.Builder setSchedule(Schedule schedule)

Set the time at which the variant push should be sent.

Parameters:

schedule - Schedule

Returns:

Builder

setPushPayload

public Variant.Builder setPushPayload(VariantPushPayload variantPushPayload)

Set 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 not supported by the Experiments API so they are also not included in the partial push payload object.

Parameters:

variantPushPayload - VariantPushPayload

Returns:

Builder

setWeight

public Variant.Builder setWeight(java.lang.Integer weight)

Set the weight of the variant. Defaults to 1. A whole number, which we use to compute the proportion of the audience that will receive this variant.

Parameters:

weight - Integer

Returns:

Builder

build

public Variant build()

Build a Variant object. Will fail if the following precondition is not met.

 1. Partial push notification object must be specified.
 

Returns:

Variant

Throws:

java.lang.NullPointerException - if variantPushPayload is not set