Package io.opencensus.metrics.data
Class Exemplar
- java.lang.Object
-
- io.opencensus.metrics.data.Exemplar
-
- Direct Known Subclasses:
AutoValue_Exemplar
@Immutable public abstract class Exemplar extends java.lang.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
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static Exemplar
create(double value, Timestamp timestamp, java.util.Map<java.lang.String,AttachmentValue> attachments)
Creates anExemplar
.abstract java.util.Map<java.lang.String,AttachmentValue>
getAttachments()
Returns the contextual information about the example value.abstract Timestamp
getTimestamp()
Returns the time that thisExemplar
's value was recorded.abstract double
getValue()
Returns value of theExemplar
point.
-
-
-
Method Detail
-
getValue
public abstract double getValue()
Returns value of theExemplar
point.- Returns:
- value of the
Exemplar
point. - Since:
- 0.20
-
getTimestamp
public abstract Timestamp getTimestamp()
Returns the time that thisExemplar
's value was recorded.- Returns:
- the time that this
Exemplar
's value was recorded. - Since:
- 0.20
-
getAttachments
public abstract java.util.Map<java.lang.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, java.util.Map<java.lang.String,AttachmentValue> attachments)
Creates anExemplar
.- Parameters:
value
- value of theExemplar
point.timestamp
- the time that thisExemplar
's value was recorded.attachments
- the contextual information about the example value.- Returns:
- an
Exemplar
. - Since:
- 0.20
-
-