Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class GaugeSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricSnapshot

io.prometheus.metrics.model.snapshots.GaugeSnapshot

@StableApi
public final class GaugeSnapshot
extends MetricSnapshot

Immutable snapshot of a Gauge.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GaugeSnapshot.Builder
static final class	GaugeSnapshot.GaugeDataPointSnapshot

Field Summary

Fields inherited from class io.prometheus.metrics.model.snapshots.MetricSnapshot

dataPoints

Constructor Summary

Constructors

Constructor	Description
GaugeSnapshot(MetricMetadata metadata, Collection<GaugeSnapshot.GaugeDataPointSnapshot> data)	To create a new GaugeSnapshot, you can either call the constructor directly or use the builder with builder().

Method Summary

Modifier and Type	Method	Description
static GaugeSnapshot.Builder	builder()
List<GaugeSnapshot.GaugeDataPointSnapshot>	getDataPoints()

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

getMetadata

Methods inherited from class java.lang.Object

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

Constructor Details

GaugeSnapshot

public GaugeSnapshot(MetricMetadata metadata,
 Collection<GaugeSnapshot.GaugeDataPointSnapshot> data)

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

Parameters:

metadata - see MetricMetadata for naming conventions.

data - the constructor will create a sorted copy of the collection.

Method Details

getDataPoints

public List<GaugeSnapshot.GaugeDataPointSnapshot> getDataPoints()

Specified by:

getDataPoints in class MetricSnapshot

builder

public static GaugeSnapshot.Builder builder()