com.google.instrumentation.stats

Class DistributionAggregationDescriptor

java.lang.Object

com.google.instrumentation.stats.DistributionAggregationDescriptor

public final class DistributionAggregationDescriptor
extends Object

Describes data aggregations based on distributions.

A distribution aggregation may optionally contain a histogram of the values in the population. The bucket boundaries for that histogram are described by BucketBoundaries, which defines BucketBoundaries.getBoundaries.size() + 1 (= N) buckets. The boundaries for bucket index i are:

• [-infinity, bounds[i]) for i == 0
• [bounds[i-1], bounds[i]) for 0 < i < N-1
• [bounds[i-1], +infinity) for i == N-1

i.e. an underflow bucket (number 0), zero or more finite buckets (1 through N - 2, and an overflow bucket (N - 1), with inclusive lower bounds and exclusive upper bounds.

Note: If N = 1, there are no finite buckets and the single bucket is both the overflow and underflow bucket.

Method Summary

Modifier and Type	Method and Description
static DistributionAggregationDescriptor	create() Constructs a new DistributionAggregationDescriptor without the optional histogram bucket boundaries.
static DistributionAggregationDescriptor	create(List<Double> bucketBoundaries) Constructs a new DistributionAggregationDescriptor with the optional histogram bucket boundaries.
List<Double>	getBucketBoundaries() The optional histogram bucket boundaries for a distribution.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DistributionAggregationDescriptor create(List<Double> bucketBoundaries)

Constructs a new DistributionAggregationDescriptor with the optional histogram bucket boundaries.

create

public static DistributionAggregationDescriptor create()

Constructs a new DistributionAggregationDescriptor without the optional histogram bucket boundaries.

getBucketBoundaries

@Nullable
public List<Double> getBucketBoundaries()

The optional histogram bucket boundaries for a distribution.

Note: The returned list is unmodifiable, attempts to update it will throw an UnsupportedOperationException.