Package io.prometheus.metrics.model.snapshots

Class UnknownSnapshot.UnknownDataPointSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.DataPointSnapshot

io.prometheus.metrics.model.snapshots.UnknownSnapshot.UnknownDataPointSnapshot

Enclosing class:

UnknownSnapshot

public static final class UnknownSnapshot.UnknownDataPointSnapshot
extends DataPointSnapshot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnknownSnapshot.UnknownDataPointSnapshot.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final Exemplar	exemplar
private final double	value

Constructor Summary

Constructors

Modifier	Constructor	Description
	UnknownDataPointSnapshot(double value, Labels labels, Exemplar exemplar)	To create a new UnknownSnapshot.UnknownDataPointSnapshot, you can either call the constructor directly or use the Builder with builder().
	UnknownDataPointSnapshot(double value, Labels labels, Exemplar exemplar, long scrapeTimestampMillis)	Constructor with an additional scrape timestamp.
private	UnknownDataPointSnapshot(double value, Labels labels, Exemplar exemplar, long scrapeTimestampMillis, boolean internal)

Method Summary

Modifier and Type	Method	Description
static UnknownSnapshot.UnknownDataPointSnapshot.Builder	builder()
(package private) DataPointSnapshot	escape(EscapingScheme escapingScheme)
Exemplar	getExemplar()
double	getValue()

Methods inherited from class io.prometheus.metrics.model.snapshots.DataPointSnapshot

getCreatedTimestampMillis, getLabels, getScrapeTimestampMillis, hasCreatedTimestamp, hasScrapeTimestamp

Methods inherited from class java.lang.Object

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

Field Details

value

private final double value

exemplar

private final Exemplar exemplar

Constructor Details

UnknownDataPointSnapshot

public UnknownDataPointSnapshot(double value,
 Labels labels,
 Exemplar exemplar)

To create a new UnknownSnapshot.UnknownDataPointSnapshot, you can either call the constructor directly or use the Builder with builder().

Parameters:

value - the value.

labels - must not be null. Use Labels.EMPTY if there are no labels.

exemplar - may be null.

UnknownDataPointSnapshot

public UnknownDataPointSnapshot(double value,
 Labels labels,
 Exemplar exemplar,
 long scrapeTimestampMillis)

Constructor with an additional scrape timestamp. This is only useful in rare cases as the scrape timestamp is usually set by the Prometheus server during scraping. Exceptions include mirroring metrics with given timestamps from other metric sources.

UnknownDataPointSnapshot

private UnknownDataPointSnapshot(double value,
 Labels labels,
 Exemplar exemplar,
 long scrapeTimestampMillis,
 boolean internal)

Method Details

getValue

public double getValue()

getExemplar

public Exemplar getExemplar()

builder

public static UnknownSnapshot.UnknownDataPointSnapshot.Builder builder()

escape

DataPointSnapshot escape(EscapingScheme escapingScheme)

Specified by:

escape in class DataPointSnapshot