Module org.elasticsearch.security

Package org.elasticsearch.xpack.security.metric

Record Class SecurityMetricType

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.security.metric.SecurityMetricType

public record SecurityMetricType(SecurityMetricGroup group, SecurityMetricInfo successMetricInfo, SecurityMetricInfo failuresMetricInfo, SecurityMetricInfo timeMetricInfo)
extends Record

Defines a security metric type that can be collected. Each metric type has a group, and metric info for tracking success, failure and total time.

Field Summary

Fields

Modifier and Type	Field	Description
static final SecurityMetricType	AUTHC_API_KEY
static final SecurityMetricType	AUTHC_OAUTH2_TOKEN
static final SecurityMetricType	AUTHC_REALMS
static final SecurityMetricType	AUTHC_SERVICE_ACCOUNT

Constructor Summary

Constructors

Constructor	Description
SecurityMetricType(SecurityMetricGroup group, SecurityMetricInfo successMetricInfo, SecurityMetricInfo failuresMetricInfo, SecurityMetricInfo timeMetricInfo)	Creates an instance of a SecurityMetricType record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
SecurityMetricInfo	failuresMetricInfo()	Returns the value of the failuresMetricInfo record component.
SecurityMetricGroup	group()	Returns the value of the group record component.
final int	hashCode()	Returns a hash code value for this object.
SecurityMetricInfo	successMetricInfo()	Returns the value of the successMetricInfo record component.
SecurityMetricInfo	timeMetricInfo()	Returns the value of the timeMetricInfo 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

Field Details

AUTHC_API_KEY

public static final SecurityMetricType AUTHC_API_KEY

AUTHC_SERVICE_ACCOUNT

public static final SecurityMetricType AUTHC_SERVICE_ACCOUNT

AUTHC_OAUTH2_TOKEN

public static final SecurityMetricType AUTHC_OAUTH2_TOKEN

AUTHC_REALMS

public static final SecurityMetricType AUTHC_REALMS

Constructor Details

SecurityMetricType

public SecurityMetricType(SecurityMetricGroup group,
 SecurityMetricInfo successMetricInfo,
 SecurityMetricInfo failuresMetricInfo,
 SecurityMetricInfo timeMetricInfo)

Creates an instance of a SecurityMetricType record class.

Parameters:

group - the value for the group record component

successMetricInfo - the value for the successMetricInfo record component

failuresMetricInfo - the value for the failuresMetricInfo record component

timeMetricInfo - the value for the timeMetricInfo record component

Method Details

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.

group

public SecurityMetricGroup group()

Returns the value of the group record component.

Returns:

the value of the group record component

successMetricInfo

public SecurityMetricInfo successMetricInfo()

Returns the value of the successMetricInfo record component.

Returns:

the value of the successMetricInfo record component

failuresMetricInfo

public SecurityMetricInfo failuresMetricInfo()

Returns the value of the failuresMetricInfo record component.

Returns:

the value of the failuresMetricInfo record component

timeMetricInfo

public SecurityMetricInfo timeMetricInfo()

Returns the value of the timeMetricInfo record component.

Returns:

the value of the timeMetricInfo record component