Package io.opencensus.metrics.export

Class Summary.Snapshot

java.lang.Object

io.opencensus.metrics.export.Summary.Snapshot

Direct Known Subclasses:

AutoValue_Summary_Snapshot

Enclosing class:

Summary

@Immutable
public abstract static class Summary.Snapshot
extends java.lang.Object

Represents the summary observation of the recorded events over a sliding time window.

Since:

0.17

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Summary.Snapshot.ValueAtPercentile	Represents the value at a given percentile of a distribution.

Constructor Summary

Constructors

Constructor	Description
Snapshot()

Method Summary

Modifier and Type	Method	Description
static Summary.Snapshot	create(java.lang.Long count, java.lang.Double sum, java.util.List<Summary.Snapshot.ValueAtPercentile> valueAtPercentiles)	Creates a Summary.Snapshot.
abstract java.lang.Long	getCount()	Returns the number of values in this Snapshot.
abstract java.lang.Double	getSum()	Returns the sum of values in this Snapshot.
abstract java.util.List<Summary.Snapshot.ValueAtPercentile>	getValueAtPercentiles()	Returns the list of ValueAtPercentiles in this Snapshot.

Methods inherited from class java.lang.Object

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

Constructor Detail

Snapshot

public Snapshot()

Method Detail

getCount

@Nullable
public abstract java.lang.Long getCount()

Returns the number of values in this Snapshot. If not available returns null.

Returns:

the number of values in this Snapshot.

Since:

0.17

getSum

@Nullable
public abstract java.lang.Double getSum()

Returns the sum of values in this Snapshot. If not available returns null.

Returns:

the sum of values in this Snapshot.

Since:

0.17

getValueAtPercentiles

public abstract java.util.List<Summary.Snapshot.ValueAtPercentile> getValueAtPercentiles()

Returns the list of ValueAtPercentiles in this Snapshot.

Returns:

the list of ValueAtPercentiles in this Snapshot.

Since:

0.17

create

public static Summary.Snapshot create(@Nullable
                                      java.lang.Long count,
                                      @Nullable
                                      java.lang.Double sum,
                                      java.util.List<Summary.Snapshot.ValueAtPercentile> valueAtPercentiles)

Creates a Summary.Snapshot.

Parameters:

count - the number of values in this Snapshot.

sum - the number of values in this Snapshot.

valueAtPercentiles - the list of ValueAtPercentile.

Returns:

a Snapshot with the given values.

Since:

0.17