Module org.elasticsearch.server

Package org.elasticsearch.monitor.jvm

Record Class HotThreads.RequestOptions

java.lang.Object

java.lang.Record

org.elasticsearch.monitor.jvm.HotThreads.RequestOptions

All Implemented Interfaces:

Writeable

Enclosing class:

HotThreads

public static record HotThreads.RequestOptions(int threads, HotThreads.ReportType reportType, HotThreads.SortOrder sortOrder, TimeValue interval, int snapshots, boolean ignoreIdleThreads)
extends Record
implements Writeable

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final HotThreads.RequestOptions	DEFAULT

Constructor Summary

Constructors

Constructor	Description
RequestOptions(int threads, HotThreads.ReportType reportType, HotThreads.SortOrder sortOrder, TimeValue interval, int snapshots, boolean ignoreIdleThreads)	Creates an instance of a RequestOptions 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.
boolean	ignoreIdleThreads()	Returns the value of the ignoreIdleThreads record component.
TimeValue	interval()	Returns the value of the interval record component.
static HotThreads.RequestOptions	readFrom(StreamInput in)
HotThreads.ReportType	reportType()	Returns the value of the reportType record component.
int	snapshots()	Returns the value of the snapshots record component.
HotThreads.SortOrder	sortOrder()	Returns the value of the sortOrder record component.
int	threads()	Returns the value of the threads record component.
final String	toString()	Returns a string representation of this record class.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final HotThreads.RequestOptions DEFAULT

Constructor Details

RequestOptions

public RequestOptions(int threads,
 HotThreads.ReportType reportType,
 HotThreads.SortOrder sortOrder,
 TimeValue interval,
 int snapshots,
 boolean ignoreIdleThreads)

Creates an instance of a RequestOptions record class.

Parameters:

threads - the value for the threads record component

reportType - the value for the reportType record component

sortOrder - the value for the sortOrder record component

interval - the value for the interval record component

snapshots - the value for the snapshots record component

ignoreIdleThreads - the value for the ignoreIdleThreads record component

Method Details

readFrom

public static HotThreads.RequestOptions readFrom(StreamInput in)
                                          throws IOException

Throws:

IOException

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

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.

threads

public int threads()

Returns the value of the threads record component.

Returns:

the value of the threads record component

reportType

public HotThreads.ReportType reportType()

Returns the value of the reportType record component.

Returns:

the value of the reportType record component

sortOrder

public HotThreads.SortOrder sortOrder()

Returns the value of the sortOrder record component.

Returns:

the value of the sortOrder record component

interval

public TimeValue interval()

Returns the value of the interval record component.

Returns:

the value of the interval record component

snapshots

public int snapshots()

Returns the value of the snapshots record component.

Returns:

the value of the snapshots record component

ignoreIdleThreads

public boolean ignoreIdleThreads()

Returns the value of the ignoreIdleThreads record component.

Returns:

the value of the ignoreIdleThreads record component