Package com.inductiveautomation.ignition.gateway.historian.metric

Record Class QueryMetrics

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.historian.metric.QueryMetrics

public record QueryMetrics(com.codahale.metrics.Timer operationTimer, ProjectedMeter projectedMeter, com.codahale.metrics.Meter queriedMeter)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUERY_THROUGHPUT_ACTUAL_METRIC
static final String	QUERY_THROUGHPUT_PROJECTED_METRIC

Constructor Summary

Constructors

Constructor	Description
QueryMetrics(com.codahale.metrics.Timer operationTimer, ProjectedMeter projectedMeter, com.codahale.metrics.Meter queriedMeter)	Creates an instance of a QueryMetrics record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
com.codahale.metrics.Timer	operationTimer()	Returns the value of the operationTimer record component.
ProjectedMeter	projectedMeter()	Returns the value of the projectedMeter record component.
com.codahale.metrics.Meter	queriedMeter()	Returns the value of the queriedMeter record component.
static QueryMetrics	register(GatewayContext gatewayContext, String historianName)
final String	toString()	Returns a string representation of this record class.
void	update(long count, long durationNanos)

Methods inherited from class java.lang.Object

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

Field Details

QUERY_THROUGHPUT_ACTUAL_METRIC

public static final String QUERY_THROUGHPUT_ACTUAL_METRIC

QUERY_THROUGHPUT_PROJECTED_METRIC

public static final String QUERY_THROUGHPUT_PROJECTED_METRIC

Constructor Details

QueryMetrics

public QueryMetrics(com.codahale.metrics.Timer operationTimer,
 ProjectedMeter projectedMeter,
 com.codahale.metrics.Meter queriedMeter)

Creates an instance of a QueryMetrics record class.

Parameters:

operationTimer - the value for the operationTimer record component

projectedMeter - the value for the projectedMeter record component

queriedMeter - the value for the queriedMeter record component

Method Details

register

public static QueryMetrics register(GatewayContext gatewayContext,
 String historianName)

update

public void update(long count,
 long durationNanos)

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.

operationTimer

public com.codahale.metrics.Timer operationTimer()

Returns the value of the operationTimer record component.

Returns:

the value of the operationTimer record component

projectedMeter

public ProjectedMeter projectedMeter()

Returns the value of the projectedMeter record component.

Returns:

the value of the projectedMeter record component

queriedMeter

public com.codahale.metrics.Meter queriedMeter()

Returns the value of the queriedMeter record component.

Returns:

the value of the queriedMeter record component