Package io.airlift.openmetrics.types

Record Class Gauge

java.lang.Object

java.lang.Record

io.airlift.openmetrics.types.Gauge

All Implemented Interfaces:

Metric

public record Gauge(String metricName, double value, Map<String,String> labels, String help)
extends Record
implements Metric

Field Summary

Fields inherited from interface io.airlift.openmetrics.types.Metric

HELP_LINE_FORMAT, NAME_WITH_LABELS_LINE_FORMAT, TYPE_LINE_FORMAT, VALUE_LINE_FORMAT

Constructor Summary

Constructors

Constructor	Description
Gauge(String metricName, double value, Map<String,String> labels, String help)	Creates an instance of a Gauge record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static Gauge	from(String metricName, Number value, Map<String,String> labels, String help)
String	getMetricExposition()
final int	hashCode()	Returns a hash code value for this object.
String	help()	Returns the value of the help record component.
Map<String,String>	labels()	Returns the value of the labels record component.
String	metricName()	Returns the value of the metricName record component.
final String	toString()	Returns a string representation of this record class.
double	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Gauge

public Gauge(String metricName,
 double value,
 Map<String,String> labels,
 String help)

Creates an instance of a Gauge record class.

Parameters:

metricName - the value for the metricName record component

value - the value for the value record component

labels - the value for the labels record component

help - the value for the help record component

Method Details

from

public static Gauge from(String metricName,
 Number value,
 Map<String,String> labels,
 String help)

getMetricExposition

public String getMetricExposition()

Specified by:

getMetricExposition in interface Metric

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

metricName

public String metricName()

Returns the value of the metricName record component.

Specified by:

metricName in interface Metric

Returns:

the value of the metricName record component

value

public double value()

Returns the value of the value record component.

Returns:

the value of the value record component

labels

public Map<String,String> labels()

Returns the value of the labels record component.

Returns:

the value of the labels record component

help

public String help()

Returns the value of the help record component.

Returns:

the value of the help record component