com.intuit.wasabi.experiment

Interface Buckets

All Known Implementing Classes:

BucketsImpl

public interface Buckets

Interface to perform CRUD operations for buckets of an experiment. It also provides validation methods to check the state of bucket.

Method Summary

Modifier and Type	Method and Description
BucketList	adjustAllocationPercentages(Experiment experiment, Bucket newBucket) Adjust allocation percentage for buckets within the specified experiment.
BucketList	combineOldAndNewBuckets(BucketList oldBuckets, BucketList newBuckets) Go through the list of old buckets and replace them with the new buckets.
Bucket	createBucket(Experiment.ID experimentId, Bucket newBucket, UserInfo user) Creates a new bucket for the specified experiment by adding the specified metadata to the database.
void	deleteBucket(Experiment.ID experimentId, Bucket.Label bucketLabel, UserInfo user) Deletes a bucket by removing its metadata from the database.
Bucket	getBucket(Experiment.ID experimentId, Bucket.Label bucketLabel) Queries the database and returns metadata for the specified bucket in the specified experiment.
Bucket.Builder	getBucketBuilder(Experiment.ID experimentID, Bucket.Label bucketLabel) Get bucket with the specified bucketLabel and experimentID from the database and return Bucket.Builder based on that.
List<Bucket.BucketAuditInfo>	getBucketChangeList(Bucket bucket, Bucket updates, Bucket.Builder builder) Build a bucket change list and return it as a list of Bucket.BucketAuditInfo.
BucketList	getBuckets(Experiment.ID experimentId) Queries the database and returns a list of buckets with metadata for the specified experiment.
Bucket	updateBucket(Experiment.ID experimentId, Bucket.Label bucketLabel, Bucket updates, UserInfo user) Updates a bucket by updating the specified metadata in the database.
BucketList	updateBucketAllocBatch(Experiment.ID experimentID, BucketList bucketList) Updates new allocation percentages for the list of buckets within the specified experiment
BucketList	updateBucketBatch(Experiment.ID experimentID, BucketList bucketList, UserInfo user) Updates list of buckets in batch with the specified metadata in the database.
Bucket	updateBucketState(Experiment.ID experimentID, Bucket.Label bucketLabel, Bucket.State desiredState, UserInfo user) Updates a bucket's state by updating the specified metadata in the database.
void	validateBucketChanges(Bucket bucket, Bucket updates) Validate bucket changes with the specified metadata

Method Detail

createBucket

Bucket createBucket(Experiment.ID experimentId,
                    Bucket newBucket,
                    UserInfo user)

Creates a new bucket for the specified experiment by adding the specified metadata to the database.

Parameters:

experimentId - the unique experiment id

newBucket - Bucket object containing bucket metadata

user - the UserInfo who created the bucket

Returns:

Bucket object containing bucket metadata

deleteBucket

void deleteBucket(Experiment.ID experimentId,
                  Bucket.Label bucketLabel,
                  UserInfo user)

Deletes a bucket by removing its metadata from the database.

Parameters:

experimentId - the unique experiment id

bucketLabel - the unique bucket id

user - the UserInfo who deleted the Bucket

getBucket

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

Queries the database and returns metadata for the specified bucket in the specified experiment.

Parameters:

experimentId - the unique experiment id

bucketLabel - the unique bucket id

Returns:

Bucket object containing bucket metadata

getBuckets

BucketList getBuckets(Experiment.ID experimentId)

Queries the database and returns a list of buckets with metadata for the specified experiment.

Parameters:

experimentId - the unique experiment id

Returns:

a list of Bucket objects containing bucket metadata

updateBucket

Bucket updateBucket(Experiment.ID experimentId,
                    Bucket.Label bucketLabel,
                    Bucket updates,
                    UserInfo user)

Updates a bucket by updating the specified metadata in the database.

Parameters:

experimentId - the unique experiment id

bucketLabel - the unique bucket id

updates - Bucket object containing bucket metadata to be updated

user - the UserInfo who triggered the change

Returns:

Bucket object containing updated bucket metadata

updateBucketAllocBatch

BucketList updateBucketAllocBatch(Experiment.ID experimentID,
                                  BucketList bucketList)

Updates new allocation percentages for the list of buckets within the specified experiment

Parameters:

experimentID - the unique experiment id

bucketList - List of Buckets

Returns:

the updated list of buckets

adjustAllocationPercentages

BucketList adjustAllocationPercentages(Experiment experiment,
                                       Bucket newBucket)

Adjust allocation percentage for buckets within the specified experiment.

Parameters:

experiment - Experiment

newBucket - The new Bucket containing the new allocation percentage

Returns:

The updated list of buckets with adjusted allocation percentages

updateBucketState

Bucket updateBucketState(Experiment.ID experimentID,
                         Bucket.Label bucketLabel,
                         Bucket.State desiredState,
                         UserInfo user)

Updates a bucket's state by updating the specified metadata in the database.

Parameters:

experimentID - the unique experiment id

bucketLabel - the unique bucket id

desiredState - the desired state

user - the UserInfo who updated the state

Returns:

Bucket object containing updated bucket metadata

updateBucketBatch

BucketList updateBucketBatch(Experiment.ID experimentID,
                             BucketList bucketList,
                             UserInfo user)

Updates list of buckets in batch with the specified metadata in the database.

Parameters:

experimentID - the unique experiment id

bucketList - List of Buckets

user - the UserInfo who updated the Buckets

Returns:

the updated list of buckets.

validateBucketChanges

void validateBucketChanges(Bucket bucket,
                           Bucket updates)

Validate bucket changes with the specified metadata

Parameters:

bucket - Current bucket

updates - Bucket with the new metadata

Throws:

IllegalArgumentException - if trying to update experimentID, bucket label or bucket state

getBucketChangeList

List<Bucket.BucketAuditInfo> getBucketChangeList(Bucket bucket,
                                                 Bucket updates,
                                                 Bucket.Builder builder)

Build a bucket change list and return it as a list of Bucket.BucketAuditInfo.

Parameters:

bucket - Current Bucket

updates - Bucket updates

builder - Bucket.Builder

Returns:

A list of changes as a list of Bucket.BucketAuditInfo.

getBucketBuilder

Bucket.Builder getBucketBuilder(Experiment.ID experimentID,
                                Bucket.Label bucketLabel)

Get bucket with the specified bucketLabel and experimentID from the database and return Bucket.Builder based on that.

Parameters:

experimentID - the unique experiment id

bucketLabel - Bucket label

Returns:

Bucket.Builder based on the specified bucketLabel and experimentID.

combineOldAndNewBuckets

BucketList combineOldAndNewBuckets(BucketList oldBuckets,
                                   BucketList newBuckets)

Go through the list of old buckets and replace them with the new buckets.

Parameters:

oldBuckets - Old bucket list

newBuckets - New bucket list

Returns:

BucketList with the new buckets in the new BucketList