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

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final String[]	names
(package private) final boolean[]	values

Constructor Summary

Constructors

Modifier	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.
private	StateSetDataPointSnapshot(String[] names, boolean[] values, Labels labels, long scrapeTimestampMillis, boolean internal)

Method Summary

Modifier and Type	Method	Description
private List<StateSetSnapshot.State>	asList()
static StateSetSnapshot.StateSetDataPointSnapshot.Builder	builder()
(package private) DataPointSnapshot	escape(EscapingScheme escapingScheme)
String	getName(int i)
boolean	isTrue(int i)
Iterator<StateSetSnapshot.State>	iterator()
int	size()
private static void	sort(String[] names, boolean[] values)
Stream<StateSetSnapshot.State>	stream()
private static void	swap(int i, int j, String[] names, boolean[] values)
private void	validate()

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

Field Details

names

final String[] names

values

final boolean[] values

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.

StateSetDataPointSnapshot

private StateSetDataPointSnapshot(String[] names,
 boolean[] values,
 Labels labels,
 long scrapeTimestampMillis,
 boolean internal)

Method Details

size

public int size()

getName

public String getName(int i)

isTrue

public boolean isTrue(int i)

validate

private void validate()

escape

DataPointSnapshot escape(EscapingScheme escapingScheme)

Specified by:

escape in class DataPointSnapshot

asList

private List<StateSetSnapshot.State> asList()

iterator

public Iterator<StateSetSnapshot.State> iterator()

Specified by:

iterator in interface Iterable<StateSetSnapshot.State>

stream

public Stream<StateSetSnapshot.State> stream()

sort

private static void sort(String[] names,
 boolean[] values)

swap

private static void swap(int i,
 int j,
 String[] names,
 boolean[] values)

builder

public static StateSetSnapshot.StateSetDataPointSnapshot.Builder builder()