Package io.airlift.openmetrics.types

Record Class Summary

java.lang.Object

java.lang.Record

io.airlift.openmetrics.types.Summary

All Implemented Interfaces:

Metric

public record Summary(String metricName, Long count, Double sum, Double created, Map<Double,Double> quantiles, 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
Summary(String metricName, Long count, Double sum, Double created, Map<Double,Double> quantiles, Map<String,String> labels, String help)	Creates an instance of a Summary record class.

Method Summary

Modifier and Type	Method	Description
Long	count()	Returns the value of the count record component.
Double	created()	Returns the value of the created record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static Summary	from(String metricName, TimeDistribution timeDistribution, 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.
Map<Double,Double>	quantiles()	Returns the value of the quantiles record component.
Double	sum()	Returns the value of the sum record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Summary

public Summary(String metricName,
 Long count,
 Double sum,
 Double created,
 Map<Double,Double> quantiles,
 Map<String,String> labels,
 String help)

Creates an instance of a Summary record class.

Parameters:

metricName - the value for the metricName record component

count - the value for the count record component

sum - the value for the sum record component

created - the value for the created record component

quantiles - the value for the quantiles record component

labels - the value for the labels record component

help - the value for the help record component

Method Details

from

public static Summary from(String metricName,
 TimeDistribution timeDistribution,
 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. All components in this record class are compared with Objects::equals(Object,Object).

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

count

public Long count()

Returns the value of the count record component.

Returns:

the value of the count record component

sum

public Double sum()

Returns the value of the sum record component.

Returns:

the value of the sum record component

created

public Double created()

Returns the value of the created record component.

Returns:

the value of the created record component

quantiles

public Map<Double,Double> quantiles()

Returns the value of the quantiles record component.

Returns:

the value of the quantiles 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