com.google.api.control.model

Class Distributions

java.lang.Object

com.google.api.control.model.Distributions

public final class Distributions
extends java.lang.Object

Utility methods for working with Distribution instances.

Method Summary

Modifier and Type	Method and Description
static com.google.api.servicecontrol.v1.Distribution	addSample(double value, com.google.api.servicecontrol.v1.Distribution distribution) Updates as new distribution that contains value added to an existing one.
static com.google.api.servicecontrol.v1.Distribution	createExplicit(double[] bounds) Creates a Distribution with ExplicitBuckets.
static com.google.api.servicecontrol.v1.Distribution	createExponential(int numFiniteBuckets, double growthFactor, double scale) Creates an Distribution with ExponentialBuckets.
static com.google.api.servicecontrol.v1.Distribution	createLinear(int numFiniteBuckets, double width, double offset) Creates a Distribution with LinearBuckets.
static com.google.api.servicecontrol.v1.Distribution	merge(com.google.api.servicecontrol.v1.Distribution prior, com.google.api.servicecontrol.v1.Distribution latest) Merge prior with latest.

Methods inherited from class java.lang.Object

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

Method Detail

createExponential

public static com.google.api.servicecontrol.v1.Distribution createExponential(int numFiniteBuckets,
                                                                              double growthFactor,
                                                                              double scale)

Creates an Distribution with ExponentialBuckets.

Parameters:

numFiniteBuckets - initializes the number of finite buckets

growthFactor - initializes the growth factor

scale - initializes the scale

Returns:

a Distribution with ExponentialBuckets

Throws:

java.lang.IllegalArgumentException - if a bad input prevents creation.

createLinear

public static com.google.api.servicecontrol.v1.Distribution createLinear(int numFiniteBuckets,
                                                                         double width,
                                                                         double offset)

Creates a Distribution with LinearBuckets.

Parameters:

numFiniteBuckets - initializes the number of finite buckets

width - initializes the width of each bucket

offset - initializes the offset of the start bucket

Returns:

a Distribution with LinearBuckets

Throws:

java.lang.IllegalArgumentException - if a bad input prevents creation.

createExplicit

public static com.google.api.servicecontrol.v1.Distribution createExplicit(double[] bounds)

Creates a Distribution with ExplicitBuckets.

Parameters:

bounds - initializes the bounds used to define the explicit buckets

Returns:

a Distribution with ExplicitBuckets

Throws:

java.lang.IllegalArgumentException - if a bad input prevents creation.

addSample

public static com.google.api.servicecontrol.v1.Distribution addSample(double value,
                                                                      com.google.api.servicecontrol.v1.Distribution distribution)

Updates as new distribution that contains value added to an existing one.

Parameters:

value - the sample value

distribution - a Distribution

Returns:

the updated distribution

merge

public static com.google.api.servicecontrol.v1.Distribution merge(com.google.api.servicecontrol.v1.Distribution prior,
                                                                  com.google.api.servicecontrol.v1.Distribution latest)

Merge prior with latest.

Parameters:

prior - a Distribution instance

latest - a Distribution, expected to be a later version of prior

Returns:

a new Distribution that combines the statistics and buckets of the earlier two

Throws:

java.lang.IllegalArgumentException - if the bucket options of prior and latest don't match

java.lang.IllegalArgumentException - if the bucket counts of prior and latest dont' match