Module org.elasticsearch.server

Package org.elasticsearch.script

Record Class ScriptContextStats

java.lang.Object

java.lang.Record

org.elasticsearch.script.ScriptContextStats

Record Components:

context - Context name.

compilations - Total number of compilations.

compilationsHistory - Historical information of the compilations of scripts in timeseries format.

cacheEvictions - Total of evictions.

cacheEvictionsHistory - Historical information of the evictions of scripts in timeseries format.

compilationLimitTriggered - Total times that a limit of compilations that have reached the limit.

All Implemented Interfaces:

Comparable<ScriptContextStats>, Writeable, ToXContent, ToXContentFragment

public record ScriptContextStats(String context, long compilations, TimeSeries compilationsHistory, long cacheEvictions, TimeSeries cacheEvictionsHistory, long compilationLimitTriggered)
extends Record
implements Writeable, ToXContentFragment, Comparable<ScriptContextStats>

Record object that holds stats information for the different script contexts in a node.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptContextStats(String context, long compilations, TimeSeries compilationsHistory, long cacheEvictions, TimeSeries cacheEvictionsHistory, long compilationLimitTriggered)	Creates an instance of a ScriptContextStats record class.
ScriptContextStats(String context, long compilationLimitTriggered, TimeSeries compilationsHistory, TimeSeries cacheEvictionsHistory)

Method Summary

Modifier and Type	Method	Description
long	cacheEvictions()	Returns the value of the cacheEvictions record component.
TimeSeries	cacheEvictionsHistory()	Returns the value of the cacheEvictionsHistory record component.
int	compareTo(ScriptContextStats o)
long	compilationLimitTriggered()	Returns the value of the compilationLimitTriggered record component.
long	compilations()	Returns the value of the compilations record component.
TimeSeries	compilationsHistory()	Returns the value of the compilationsHistory record component.
String	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	getCacheEvictions()
TimeSeries	getCacheEvictionsHistory()
long	getCompilationLimitTriggered()
long	getCompilations()
TimeSeries	getCompilationsHistory()
String	getContext()
final int	hashCode()	Returns a hash code value for this object.
static ScriptContextStats	merge(ScriptContextStats first, ScriptContextStats second)
static ScriptContextStats	read(StreamInput in)
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

ScriptContextStats

public ScriptContextStats(String context,
 long compilationLimitTriggered,
 TimeSeries compilationsHistory,
 TimeSeries cacheEvictionsHistory)

ScriptContextStats

public ScriptContextStats(String context,
 long compilations,
 TimeSeries compilationsHistory,
 long cacheEvictions,
 TimeSeries cacheEvictionsHistory,
 long compilationLimitTriggered)

Creates an instance of a ScriptContextStats record class.

Parameters:

context - the value for the context record component

compilations - the value for the compilations record component

compilationsHistory - the value for the compilationsHistory record component

cacheEvictions - the value for the cacheEvictions record component

cacheEvictionsHistory - the value for the cacheEvictionsHistory record component

compilationLimitTriggered - the value for the compilationLimitTriggered record component

Method Details

read

public static ScriptContextStats read(StreamInput in)
                               throws IOException

Throws:

IOException

merge

public static ScriptContextStats merge(ScriptContextStats first,
 ScriptContextStats second)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getContext

public String getContext()

getCompilations

public long getCompilations()

getCompilationsHistory

public TimeSeries getCompilationsHistory()

getCacheEvictions

public long getCacheEvictions()

getCacheEvictionsHistory

public TimeSeries getCacheEvictionsHistory()

getCompilationLimitTriggered

public long getCompilationLimitTriggered()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

compareTo

public int compareTo(ScriptContextStats o)

Specified by:

compareTo in interface Comparable<ScriptContextStats>

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.

context

public String context()

Returns the value of the context record component.

Returns:

the value of the context record component

compilations

public long compilations()

Returns the value of the compilations record component.

Returns:

the value of the compilations record component

compilationsHistory

public TimeSeries compilationsHistory()

Returns the value of the compilationsHistory record component.

Returns:

the value of the compilationsHistory record component

cacheEvictions

public long cacheEvictions()

Returns the value of the cacheEvictions record component.

Returns:

the value of the cacheEvictions record component

cacheEvictionsHistory

public TimeSeries cacheEvictionsHistory()

Returns the value of the cacheEvictionsHistory record component.

Returns:

the value of the cacheEvictionsHistory record component

compilationLimitTriggered

public long compilationLimitTriggered()

Returns the value of the compilationLimitTriggered record component.

Returns:

the value of the compilationLimitTriggered record component