Class Exemplar

java.lang.Object

io.opencensus.metrics.data.Exemplar

Direct Known Subclasses:

AutoValue_Exemplar

@Immutable
public abstract class Exemplar
extends Object

An example point that may be used to annotate aggregated distribution values, associated with a histogram bucket.

Since:

0.20

Constructor Summary

Constructors

Constructor	Description
Exemplar()

Method Summary

Modifier and Type	Method	Description
static Exemplar	create(double value, Timestamp timestamp, Map<String, AttachmentValue> attachments)	Creates an Exemplar.
abstract Map<String, AttachmentValue>	getAttachments()	Returns the contextual information about the example value.
abstract Timestamp	getTimestamp()	Returns the time that this Exemplar's value was recorded.
abstract double	getValue()	Returns value of the Exemplar point.

Methods inherited from class Object

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

Constructor Details

Exemplar

Exemplar()

Method Details

getValue

public abstract double getValue()

Returns value of the Exemplar point.

Returns:

value of the Exemplar point.

Since:

0.20

getTimestamp

public abstract Timestamp getTimestamp()

Returns the time that this Exemplar's value was recorded.

Returns:

the time that this Exemplar's value was recorded.

Since:

0.20

getAttachments

public abstract Map<String, AttachmentValue> getAttachments()

Returns the contextual information about the example value.

Returns:

the contextual information about the example value.

Since:

0.20

create

public static Exemplar create(double value,
 Timestamp timestamp,
 Map<String, AttachmentValue> attachments)

Creates an Exemplar.

Parameters:

value - value of the Exemplar point.

timestamp - the time that this Exemplar's value was recorded.

attachments - the contextual information about the example value.

Returns:

an Exemplar.

Since:

0.20