com.intuit.wasabi.repository

Interface ExperimentRepository

public interface ExperimentRepository

Mid-level interface for the experiments repository

See Also:

Experiment, NewExperiment, Application, Context, Assignment, Bucket, BucketList, Bucket.BucketAuditInfo, AssignmentCounts

Method Summary

Modifier and Type	Method and Description
void	createApplication(Application.Name applicationName) Create an application at top level
void	createBucket(Bucket newBucket) Create a new bucket for the specified experiment
Experiment.ID	createExperiment(NewExperiment newExperiment) Create the new experiment.
void	createIndicesForNewExperiment(NewExperiment newExperiment) This is an cassandra specific method, that has to be used to update the Indices for a new Experiment.
void	deleteBucket(Experiment.ID experimentID, Bucket.Label bucketLabel) Delete a bucket
void	deleteExperiment(NewExperiment newExperiment)
List<Application.Name>	getApplicationsList()
AssignmentCounts	getAssignmentCounts(Experiment.ID experimentID, Context context) Get the summary of assignments delivered for each experiment
Bucket	getBucket(Experiment.ID experimentID, Bucket.Label bucketLabel) Retrieve the specified bucket from the repository
Map<Experiment.ID,BucketList>	getBucketList(Collection<Experiment.ID> experimentIDCollection) Get a bucket list for a list of Experiments in a single cassandra call
BucketList	getBucketList(Experiment.ID experimentID) Get the list of buckets for an experiment
BucketList	getBuckets(Experiment.ID experimentID) Return a list of bucket IDs for the specified experiment
Experiment	getExperiment(Application.Name appName, Experiment.Label experimentLabel) Retrieve the specified experiment from the repository using its label
Experiment	getExperiment(Experiment.ID experimentID) Retrieve the specified experiment from the repository
com.google.common.collect.Table<Experiment.ID,Experiment.Label,Experiment>	getExperimentList(Application.Name appName) Get the experiments for an Application
com.netflix.astyanax.model.Rows<Experiment.ID,String>	getExperimentRows(Application.Name appName) Get experiment rows
List<Experiment.ID>	getExperiments() Get all non-deleted/archived experiment IDs
List<Experiment>	getExperiments(Application.Name appName) Retrieve the list of experiments that belong to application appName
ExperimentList	getExperiments(Collection<Experiment.ID> experimentIDs) Retrieve the experiments or the specified IDs
void	logBucketChanges(Experiment.ID experimentID, Bucket.Label bucketLabel, List<Bucket.BucketAuditInfo> changeList) Log changes made to the bucket metadata
void	logExperimentChanges(Experiment.ID experimentID, List<Experiment.ExperimentAuditInfo> changeList) Log changes made to the experiment metadata
Bucket	updateBucket(Bucket bucket) Update a bucket
Bucket	updateBucketAllocationPercentage(Bucket bucket, Double desiredAllocationPercentage) Update bucket allocation percentage
BucketList	updateBucketBatch(Experiment.ID experimentID, BucketList bucketList) Update bucket batch
Bucket	updateBucketState(Bucket bucket, Bucket.State desiredState) update bucket state
Experiment	updateExperiment(Experiment experiment) Update the experiment
Experiment	updateExperimentState(Experiment experiment, Experiment.State state) Update the experiment state
void	updateStateIndex(com.netflix.astyanax.MutationBatch batch, Experiment experiment) Update state index

Method Detail

getExperiment

Experiment getExperiment(Experiment.ID experimentID)

Retrieve the specified experiment from the repository

Parameters:

experimentID - ID of the experience

Returns:

experiment Object

getExperiment

Experiment getExperiment(Application.Name appName,
                         Experiment.Label experimentLabel)

Retrieve the specified experiment from the repository using its label

Parameters:

appName - name of the application

experimentLabel - lable of the experiment

Returns:

experiment Object

createExperiment

Experiment.ID createExperiment(NewExperiment newExperiment)

Create the new experiment. Please use @link{#createIndicesForNewExperiment} after creating the Experiment in Cassandra to assure that the indices are up to date for this experiment.

Parameters:

newExperiment - experiment to create

Returns:

ID of the created experiment

updateExperiment

Experiment updateExperiment(Experiment experiment)

Update the experiment

Parameters:

experiment - current experiment

Returns:

updated experiment

updateExperimentState

Experiment updateExperimentState(Experiment experiment,
                                 Experiment.State state)

Update the experiment state

Parameters:

experiment - current experiment

state - new state

Returns:

updated experiment with the state

getExperiments

List<Experiment.ID> getExperiments()

Get all non-deleted/archived experiment IDs

Returns:

list of experiment ids

getExperiments

ExperimentList getExperiments(Collection<Experiment.ID> experimentIDs)

Retrieve the experiments or the specified IDs

Parameters:

experimentIDs - list of experiment ids

Returns:

experimentlist object

getExperimentList

com.google.common.collect.Table<Experiment.ID,Experiment.Label,Experiment> getExperimentList(Application.Name appName)

Get the experiments for an Application

Parameters:

appName - application name

Returns:

a table contains experiment id, experiment label and the experiment objects

getApplicationsList

List<Application.Name> getApplicationsList()

getBucket

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

Retrieve the specified bucket from the repository

Parameters:

experimentID - The unique experiment ID

bucketLabel - The unique bucket label within the experiment

Returns:

The specified bucket instance, or null if not found

getBuckets

BucketList getBuckets(Experiment.ID experimentID)

Return a list of bucket IDs for the specified experiment

Parameters:

experimentID - id of the experiment

Returns:

a list of buckets of that experiment

createBucket

void createBucket(Bucket newBucket)

Create a new bucket for the specified experiment

Parameters:

newBucket - bucket to create

updateBucket

Bucket updateBucket(Bucket bucket)

Update a bucket

Parameters:

bucket - bucket to update

Returns:

updated bucket object

updateBucketAllocationPercentage

Bucket updateBucketAllocationPercentage(Bucket bucket,
                                        Double desiredAllocationPercentage)

Update bucket allocation percentage

Parameters:

bucket - bucket to update

desiredAllocationPercentage - allocation information

Returns:

bucket

updateBucketState

Bucket updateBucketState(Bucket bucket,
                         Bucket.State desiredState)

update bucket state

Parameters:

bucket - bucket to update

desiredState - new state

Returns:

bucket updated

updateBucketBatch

BucketList updateBucketBatch(Experiment.ID experimentID,
                             BucketList bucketList)

Update bucket batch

Parameters:

experimentID - experiment id

bucketList - list of buckets

Returns:

updated bucket list

deleteBucket

void deleteBucket(Experiment.ID experimentID,
                  Bucket.Label bucketLabel)

Delete a bucket

Parameters:

experimentID - experiment id

bucketLabel - label for bucket

logBucketChanges

void logBucketChanges(Experiment.ID experimentID,
                      Bucket.Label bucketLabel,
                      List<Bucket.BucketAuditInfo> changeList)

Log changes made to the bucket metadata

Parameters:

experimentID - experiment id

bucketLabel - label for bucket

changeList - list of bucket audit info

logExperimentChanges

void logExperimentChanges(Experiment.ID experimentID,
                          List<Experiment.ExperimentAuditInfo> changeList)

Log changes made to the experiment metadata

Parameters:

experimentID - experiment id

changeList - list of bucket audit info

getExperiments

List<Experiment> getExperiments(Application.Name appName)

Retrieve the list of experiments that belong to application appName

Parameters:

appName - application name

Returns:

list of experiments

deleteExperiment

void deleteExperiment(NewExperiment newExperiment)

createIndicesForNewExperiment

void createIndicesForNewExperiment(NewExperiment newExperiment)

This is an cassandra specific method, that has to be used to update the Indices for a new Experiment.

Parameters:

newExperiment - new experiment

getAssignmentCounts

AssignmentCounts getAssignmentCounts(Experiment.ID experimentID,
                                     Context context)

Get the summary of assignments delivered for each experiment

Parameters:

experimentID - experiment id

context - current context

Returns:

assignment counts

getBucketList

Map<Experiment.ID,BucketList> getBucketList(Collection<Experiment.ID> experimentIDCollection)

Get a bucket list for a list of Experiments in a single cassandra call

Parameters:

experimentIDCollection - collection of experiment ids

Returns:

map of Id to BucketList objects

getBucketList

BucketList getBucketList(Experiment.ID experimentID)

Get the list of buckets for an experiment

Parameters:

experimentID - experiment id

Returns:

List of buckets

updateStateIndex

void updateStateIndex(com.netflix.astyanax.MutationBatch batch,
                      Experiment experiment)
               throws com.netflix.astyanax.connectionpool.exceptions.ConnectionException

Update state index

Parameters:

batch - MutationBatch object

experiment - Experiment Object

Throws:

com.netflix.astyanax.connectionpool.exceptions.ConnectionException - exception

getExperimentRows

com.netflix.astyanax.model.Rows<Experiment.ID,String> getExperimentRows(Application.Name appName)

Get experiment rows

Parameters:

appName - Application name

Returns:

experiment rows

createApplication

void createApplication(Application.Name applicationName)

Create an application at top level

Parameters:

applicationName - Application name