com.intuit.wasabi.assignment

Interface Assignments

All Known Implementing Classes:

AssignmentsImpl

public interface Assignments

The common interface for the Assignment Objects that measure the interaction of Users with the Experiment.

Method Summary

Modifier and Type	Method and Description
Boolean	checkMutex(Experiment experiment, User.ID userID, Context context) Check if a user is in an experiment which is mutually exclusive with the given experiment
List<Map>	doBatchAssignments(User.ID userID, Application.Name applicationName, Context context, boolean createAssignment, boolean overwrite, javax.ws.rs.core.HttpHeaders headers, ExperimentBatch experimentBatch, Page.Name pageName, Map<Experiment.ID,Boolean> allowAssignments) Insert/update a user assignment for this experiment.
List<Map>	doPageAssignments(Application.Name applicationName, Page.Name pageName, User.ID userID, Context context, boolean createAssignment, boolean ignoreSamplingPercent, javax.ws.rs.core.HttpHeaders headers, SegmentationProfile segmentationProfile) Gets assignments for a User based on the application name and the page.
boolean	doSegmentTest(Application.Name applicationName, Experiment.Label experimentLabel, Context context, SegmentationProfile segmentationProfile, javax.ws.rs.core.HttpHeaders headers) This method returns true if the input segmentation profile matches the rule in the experiment.
Assignment	getAssignment(User.ID userID, Application.Name appLabel, Experiment.Label experimentLabel, Context context, boolean createAssignment, boolean ignoreSamplingPercent, SegmentationProfile segmentationProfile, javax.ws.rs.core.HttpHeaders headers) Return an existing assignment for a user, or potentially create a new assignment if the user is assignable to this experiment
Assignment	getAssignment(User.ID userID, Application.Name applicationName, Experiment.Label label, Context context, boolean createAssignment, boolean ignoreSamplingPercent, SegmentationProfile segmentationProfile, javax.ws.rs.core.HttpHeaders headers, Page.Name pageName, Experiment experiment, BucketList bucketList, com.google.common.collect.Table<Experiment.ID,Experiment.Label,String> userAssignments, Map<Experiment.ID,List<Experiment.ID>> exclusives) Return an existing assignment for a user, or potentially create a new assignment if the user is assignable to this experiment.
javax.ws.rs.core.StreamingOutput	getAssignmentStream(Experiment.ID experimentID, Context context, Parameters parameters, Boolean ignoreNullBucket) Export assignments data for a given experiment ID.
Bucket	getBucket(Experiment.ID experimentID, Bucket.Label bucketLabel) This method returns the Bucket for a given experiment ID and bucketLabel.
Assignment	getSingleAssignment(User.ID userID, Application.Name appLabel, Experiment.Label experimentLabel, Context context, boolean createAssignment, boolean ignoreSamplingPercent, SegmentationProfile segmentationProfile, javax.ws.rs.core.HttpHeaders headers, Page.Name pageName) Gets the Assignment for one user for an specific experiment.
Assignment	putAssignment(User.ID userID, Application.Name applicationName, Experiment.Label experimentLabel, Context context, Bucket.Label desiredBucketLabel, boolean overwrite) Insert/update a user assignment for this experiment.
Map<String,Integer>	queuesLength() Holds the length of queues stored in rule cache and ingestion executors.

Method Detail

queuesLength

Map<String,Integer> queuesLength()

Holds the length of queues stored in rule cache and ingestion executors.

Returns:

Map of number of elements each queue

getSingleAssignment

Assignment getSingleAssignment(User.ID userID,
                               Application.Name appLabel,
                               Experiment.Label experimentLabel,
                               Context context,
                               boolean createAssignment,
                               boolean ignoreSamplingPercent,
                               SegmentationProfile segmentationProfile,
                               javax.ws.rs.core.HttpHeaders headers,
                               Page.Name pageName)

Gets the Assignment for one user for an specific experiment.

Parameters:

userID - the User.ID of the person we want the assignment for

appLabel - the Application.Name the app we want the assignment for

experimentLabel - the Experiment.Label the experiment

context - the Context of the assignment call

createAssignment - true when a new Assignment should be created

ignoreSamplingPercent - true if we want to have an assignment independent of the sampling rate

segmentationProfile - the SegmentationProfile to be used for the assignment

headers - the HttpHeaders that can be used by the segmentation

pageName - the Page.Name the page name for the assignment

Returns:

a brand new or old Assignment

getAssignment

Assignment getAssignment(User.ID userID,
                         Application.Name appLabel,
                         Experiment.Label experimentLabel,
                         Context context,
                         boolean createAssignment,
                         boolean ignoreSamplingPercent,
                         SegmentationProfile segmentationProfile,
                         javax.ws.rs.core.HttpHeaders headers)

Return an existing assignment for a user, or potentially create a new assignment if the user is assignable to this experiment

Parameters:

userID - the User.ID of the person we want the assignment for

appLabel - the Application.Name the app we want the assignment for

experimentLabel - the Experiment.Label the experiment

context - the Context of the assignment call

createAssignment - true when a new Assignment should be created

ignoreSamplingPercent - true if we want to have an assignment independent of the sampling rate

segmentationProfile - the SegmentationProfile to be used for the assignment

headers - the HttpHeaders that can be used by the segmentation

Returns:

a brand new or old Assignment

getAssignment

Assignment getAssignment(User.ID userID,
                         Application.Name applicationName,
                         Experiment.Label label,
                         Context context,
                         boolean createAssignment,
                         boolean ignoreSamplingPercent,
                         SegmentationProfile segmentationProfile,
                         javax.ws.rs.core.HttpHeaders headers,
                         Page.Name pageName,
                         Experiment experiment,
                         BucketList bucketList,
                         com.google.common.collect.Table<Experiment.ID,Experiment.Label,String> userAssignments,
                         Map<Experiment.ID,List<Experiment.ID>> exclusives)

Return an existing assignment for a user, or potentially create a new assignment if the user is assignable to this experiment. Includes a Page.Name to identify the page through which the assignment was delivered.

Parameters:

userID - the User.ID of the person we want the assignment for

applicationName - the Application.Name the app we want the assignment for

label - the Experiment.Label the experiment

context - the Context of the assignment call

createAssignment - true when a new Assignment should be created

ignoreSamplingPercent - true if we want to have an assignment independent of the sampling rate

segmentationProfile - the SegmentationProfile to be used for the assignment

headers - the HttpHeaders that can be used by the segmentation

pageName - the Page.Name the page name for the assignment

experiment - the Experiment we want the assignment for

bucketList - list of Buckets of this Experiment

userAssignments - the already existing assignments

exclusives - the experiments that are excluded from the assignment

Returns:

a brand new or old Assignment

putAssignment

Assignment putAssignment(User.ID userID,
                         Application.Name applicationName,
                         Experiment.Label experimentLabel,
                         Context context,
                         Bucket.Label desiredBucketLabel,
                         boolean overwrite)

Insert/update a user assignment for this experiment.

Parameters:

userID - the User.ID of the person we want the assignment for

applicationName - the Application.Name the app we want the assignment for

experimentLabel - the Experiment.Label the experiment

context - the Context of the assignment call

desiredBucketLabel - the Bucket.Label the assignment should go to

overwrite - true if the assignment should be forced for existing assignments

Returns:

a brand new or old Assignment

doBatchAssignments

List<Map> doBatchAssignments(User.ID userID,
                             Application.Name applicationName,
                             Context context,
                             boolean createAssignment,
                             boolean overwrite,
                             javax.ws.rs.core.HttpHeaders headers,
                             ExperimentBatch experimentBatch,
                             Page.Name pageName,
                             Map<Experiment.ID,Boolean> allowAssignments)

Insert/update a user assignment for this experiment.

Parameters:

userID - the User.ID of the person we want the assignment for

applicationName - the Application.Name the app we want the assignment for

context - the Context of the assignment call

createAssignment - true when a new Assignment should be created

overwrite - true if the assignment should be forced for existing assignments

headers - the HttpHeaders that can be used by the segmentation

experimentBatch - the ExperimentBatch experiment batch for batch assignments

pageName - the Page.Name the page name for the assignment

allowAssignments - HashMap for each experiment whether the assignment is allowed

Returns:

a brand new or old Assignment

checkMutex

Boolean checkMutex(Experiment experiment,
                   User.ID userID,
                   Context context)

Check if a user is in an experiment which is mutually exclusive with the given experiment

Parameters:

experiment - the Experiment the mutual exclusion should be checked for

userID - the User.ID for the mutual exclusion check

context - the Context in which we want to check the mutual exclusion

Returns:

true if this user is assigned to a mutual exclusive experiment

getAssignmentStream

javax.ws.rs.core.StreamingOutput getAssignmentStream(Experiment.ID experimentID,
                                                     Context context,
                                                     Parameters parameters,
                                                     Boolean ignoreNullBucket)

Export assignments data for a given experiment ID.

Parameters:

experimentID - the Experiment.ID

context - the Context

parameters - the parameters Parameters

ignoreNullBucket - the boolean flag of whether to ignroe null bucket

Returns:

a StreamingOutput for the Assignment Data

doPageAssignments

List<Map> doPageAssignments(Application.Name applicationName,
                            Page.Name pageName,
                            User.ID userID,
                            Context context,
                            boolean createAssignment,
                            boolean ignoreSamplingPercent,
                            javax.ws.rs.core.HttpHeaders headers,
                            SegmentationProfile segmentationProfile)

Gets assignments for a User based on the application name and the page.

Parameters:

applicationName - the Application.Name the app we want the assignment for

pageName - the Page.Name the page name for the assignment

userID - the User.ID of the person we want the assignment for

context - the Context of the assignment call

createAssignment - true when a new Assignment should be created

ignoreSamplingPercent - true if the assignment should be forced

headers - the HttpHeaders that can be used by the segmentation

segmentationProfile - SegmentationProfile for the Assignment resolution

Returns:

a List of HashMaps for the generated assignments

getBucket

Bucket getBucket(Experiment.ID experimentID,
                 Bucket.Label bucketLabel)

This method returns the Bucket for a given experiment ID and bucketLabel.

Parameters:

experimentID - the Experiment.ID

bucketLabel - the Bucket.Label

Returns:

Bucket

doSegmentTest

boolean doSegmentTest(Application.Name applicationName,
                      Experiment.Label experimentLabel,
                      Context context,
                      SegmentationProfile segmentationProfile,
                      javax.ws.rs.core.HttpHeaders headers)

This method returns true if the input segmentation profile matches the rule in the experiment.

Parameters:

applicationName - the Application.Name the app we want the assignment for

experimentLabel - the Experiment.Label the experiment

context - the Context of the assignment call

segmentationProfile - the SegmentationProfile to be used for the assignment

headers - the HttpHeaders that can be used by the segmentation

Returns:

true if either the experiment doesn't have a segmentation rule or if the rule evaluates to true given the profile input, false otherwise (there is a rule and it evaluates to false).