Module org.elasticsearch.security
Record Class SecurityMetricInfo
java.lang.Object
java.lang.Record
org.elasticsearch.xpack.security.metric.SecurityMetricInfo
- Record Components:
name- The unique metric name.description- The brief metric description.unit- The metric unit (e.g. count).
Holds all metric information needed to register a metric in
MeterRegistry.-
Constructor Summary
ConstructorsConstructorDescriptionSecurityMetricInfo(String name, String description, String unit) Creates an instance of aSecurityMetricInforecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.name()Returns the value of thenamerecord component.registerAsLongCounter(MeterRegistry meterRegistry) registerAsLongHistogram(MeterRegistry meterRegistry) final StringtoString()Returns a string representation of this record class.unit()Returns the value of theunitrecord component.
-
Constructor Details
-
SecurityMetricInfo
Creates an instance of aSecurityMetricInforecord class.- Parameters:
name- the value for thenamerecord componentdescription- the value for thedescriptionrecord componentunit- the value for theunitrecord component
-
-
Method Details
-
registerAsLongCounter
-
registerAsLongHistogram
-
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. -
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. -
equals
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 withObjects::equals(Object,Object). -
name
Returns the value of thenamerecord component.- Returns:
- the value of the
namerecord component
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
unit
Returns the value of theunitrecord component.- Returns:
- the value of the
unitrecord component
-