io.opencensus.metrics.export

Class Summary

java.lang.Object

io.opencensus.metrics.export.Summary

@ExperimentalApi
 @Immutable
public abstract class Summary
extends Object

Implementation of the Distribution as a summary of observations.

This is not recommended, since it cannot be aggregated.

Since:

0.17

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Summary.Snapshot Represents the summary observation of the recorded events over a sliding time window.

Method Summary

Modifier and Type	Method and Description
static Summary	create(Long count, Double sum, Summary.Snapshot snapshot) Creates a Summary.
abstract Long	getCount() Returns the aggregated count.
abstract Summary.Snapshot	getSnapshot() Returns the Summary.Snapshot.
abstract Double	getSum() Returns the aggregated sum.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Summary create(@Nullable
                             Long count,
                             @Nullable
                             Double sum,
                             Summary.Snapshot snapshot)

Creates a Summary.

Parameters:

count - the count of the population values.

sum - the sum of the population values.

snapshot - bucket boundaries of a histogram.

Returns:

a Summary with the given values.

Since:

0.17

getCount

@Nullable
public abstract Long getCount()

Returns the aggregated count. If not available returns null.

Returns:

the aggregated count.

Since:

0.17

getSum

@Nullable
public abstract Double getSum()

Returns the aggregated sum. If not available returns null.

Returns:

the aggregated sum.

Since:

0.17

getSnapshot

public abstract Summary.Snapshot getSnapshot()

Returns the Summary.Snapshot.

Returns:

the Snapshot.

Since:

0.17