org.apache.beam.sdk.util

Class BucketingFunction

java.lang.Object

org.apache.beam.sdk.util.BucketingFunction

public class BucketingFunction
extends java.lang.Object

Keep track of the minimum/maximum/sum of a set of timestamped long values. For efficiency, bucket values by their timestamp.

Constructor Summary

Constructors

Constructor and Description
BucketingFunction(long bucketWidthMs, int numSignificantBuckets, int numSignificantSamples, Combine.BinaryCombineLongFn function)

Method Summary

Modifier and Type	Method and Description
void	add(long timeMsSinceEpoch, long value) Add one sample of value (to bucket) at timeMsSinceEpoch.
long	get() Return the (bucketized) combined value of all samples.
boolean	isSignificant() Is the current result 'significant'? Ie is it drawn from enough buckets or from enough samples?
void	remove(long timeMsSinceEpoch) Remove one sample (from bucket) at timeMsSinceEpoch.

Methods inherited from class java.lang.Object

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

Constructor Detail

BucketingFunction

public BucketingFunction(long bucketWidthMs,
                         int numSignificantBuckets,
                         int numSignificantSamples,
                         Combine.BinaryCombineLongFn function)

Method Detail

add

public void add(long timeMsSinceEpoch,
                long value)

Add one sample of value (to bucket) at timeMsSinceEpoch.

remove

public void remove(long timeMsSinceEpoch)

Remove one sample (from bucket) at timeMsSinceEpoch.

get

public long get()

Return the (bucketized) combined value of all samples.

isSignificant

public boolean isSignificant()

Is the current result 'significant'? Ie is it drawn from enough buckets or from enough samples?