Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class StateSetSnapshot.StateSetDataPointSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.DataPointSnapshot

io.prometheus.metrics.model.snapshots.StateSetSnapshot.StateSetDataPointSnapshot

All Implemented Interfaces:

Iterable<StateSetSnapshot.State>

Enclosing class:

StateSetSnapshot

public static class StateSetSnapshot.StateSetDataPointSnapshot
extends DataPointSnapshot
implements Iterable<StateSetSnapshot.State>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StateSetSnapshot.StateSetDataPointSnapshot.Builder

Constructor Summary

Constructors

Constructor	Description
StateSetDataPointSnapshot(String[] names, boolean[] values, Labels labels)	To create a new StateSetSnapshot.StateSetDataPointSnapshot, you can either call the constructor directly or use the Builder with builder().
StateSetDataPointSnapshot(String[] names, boolean[] values, Labels labels, long scrapeTimestampMillis)	Constructor with an additional scrape timestamp.

Method Summary

Modifier and Type	Method	Description
static StateSetSnapshot.StateSetDataPointSnapshot.Builder	builder()
String	getName(int i)
boolean	isTrue(int i)
Iterator<StateSetSnapshot.State>	iterator()
int	size()
Stream<StateSetSnapshot.State>	stream()

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

StateSetDataPointSnapshot

public StateSetDataPointSnapshot(String[] names,
 boolean[] values,
 Labels labels)

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

Parameters:

names - state names. Must have at least 1 entry. The constructor will create a copy of the array.

values - state values. Must have the same length as names. The constructor will create a copy of the array.

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

StateSetDataPointSnapshot

public StateSetDataPointSnapshot(String[] names,
 boolean[] values,
 Labels labels,
 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.

Method Details

size

public int size()

getName

public String getName(int i)

isTrue

public boolean isTrue(int i)

iterator

public Iterator<StateSetSnapshot.State> iterator()

Specified by:

iterator in interface Iterable<StateSetSnapshot.State>

stream

public Stream<StateSetSnapshot.State> stream()

builder

public static StateSetSnapshot.StateSetDataPointSnapshot.Builder builder()