com.cloudera.gertrude.space

Class ExperimentInfo

java.lang.Object

com.cloudera.gertrude.space.ExperimentInfo

All Implemented Interfaces:

Segment

public final class ExperimentInfo
extends Object
implements Segment

Information about a particular experiment.

Constructor Summary

Constructors

Constructor and Description
ExperimentInfo(SegmentInfo info, Map<String,FlagValueCalculatorImpl<Object>> baseOverrides, Map<Integer,Map<String,FlagValueCalculatorImpl<Object>>> launchOverrides)

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Turn off this segment, preventing it from diverting requests.
SortedSet<Integer>	getBuckets() The set of buckets claimed by this Segment within its assigned Layer and DiversionCriterion.
long	getEndTimeMsec() Returns the time in milliseconds UTC that this segment stops diverting requests.
int	getId() The unique id of this Segment instance in the current ExperimentSpace.
int	getLayerId() The unique id of the Layer that owns this Segment.
long	getStartTimeMsec() Returns the time in milliseconds UTC that this segment starts diverting requests.
void	handle(ExperimentState state, List<DiversionCriterion> diversionCriteria, Map<String,FlagValueCalculator<Object>> overrides, Set<Integer> newExperimentIds) Modify the given overrides and update newExperimentIds with the ids of any experiments that this request was diverted into.
boolean	isEnabled(long requestTimeMsec) Returns true if this instance is enabled and capable of diverting requests at the given time.
boolean	isValidFor(ExperimentState state) Returns true if the given ExperimentState satisfies the Condition instances associated with this Segment.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimentInfo

public ExperimentInfo(SegmentInfo info,
              Map<String,FlagValueCalculatorImpl<Object>> baseOverrides,
              Map<Integer,Map<String,FlagValueCalculatorImpl<Object>>> launchOverrides)

Method Detail

getId

public int getId()

Description copied from interface: Segment

The unique id of this Segment instance in the current ExperimentSpace.

Specified by:

getId in interface Segment

Returns:

the unique id of this Segment

getLayerId

public int getLayerId()

Description copied from interface: Segment

The unique id of the Layer that owns this Segment.

Specified by:

getLayerId in interface Segment

Returns:

the layer id

getBuckets

public SortedSet<Integer> getBuckets()

Description copied from interface: Segment

The set of buckets claimed by this Segment within its assigned Layer and DiversionCriterion.

Specified by:

getBuckets in interface Segment

getStartTimeMsec

public long getStartTimeMsec()

Description copied from interface: Segment

Returns the time in milliseconds UTC that this segment starts diverting requests.

Specified by:

getStartTimeMsec in interface Segment

Returns:

the time in milliseconds UTC when request diversion begins

getEndTimeMsec

public long getEndTimeMsec()

Description copied from interface: Segment

Returns the time in milliseconds UTC that this segment stops diverting requests.

Specified by:

getEndTimeMsec in interface Segment

Returns:

the time in milliseconds UTC when request diversion ends

isEnabled

public boolean isEnabled(long requestTimeMsec)

Description copied from interface: Segment

Returns true if this instance is enabled and capable of diverting requests at the given time.

Specified by:

isEnabled in interface Segment

Parameters:

requestTimeMsec - the time of this request in milliseconds

Returns:

whether or not this segment is enabled for diversion

disable

public void disable()

Description copied from interface: Segment

Turn off this segment, preventing it from diverting requests.

Specified by:

disable in interface Segment

isValidFor

public boolean isValidFor(ExperimentState state)

Description copied from interface: Segment

Returns true if the given ExperimentState satisfies the Condition instances associated with this Segment.

Specified by:

isValidFor in interface Segment

Parameters:

state - the current ExperimentState

Returns:

true if the conditions evaluate to true, false otherwise

handle

public void handle(ExperimentState state,
          List<DiversionCriterion> diversionCriteria,
          Map<String,FlagValueCalculator<Object>> overrides,
          Set<Integer> newExperimentIds)

Description copied from interface: Segment

Modify the given overrides and update newExperimentIds with the ids of any experiments that this request was diverted into.

Specified by:

handle in interface Segment

Parameters:

state - the current ExperimentState

diversionCriteria - the active diversion criteria

overrides - the current overrides to flag value calculations

newExperimentIds - the experiment ids that have been added on this diversion request