Package org.graylog2.indexer.results

Record Class ResultChunk

java.lang.Object

java.lang.Record

org.graylog2.indexer.results.ResultChunk

public record ResultChunk(List<String> fields, int chunkNumber, List<ResultMessage> messages)
extends Record

A part/chunk of search results for messages. Retrieval method of the chunk (scrolling, search_after pagination...) should not affect this interface implementations.

Constructor Summary

Constructors

Constructor	Description
ResultChunk(List<String> fields, int chunkNumber, List<ResultMessage> messages)	Creates an instance of a ResultChunk record class.

Method Summary

Modifier and Type	Method	Description
int	chunkNumber()	Returns the value of the chunkNumber record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isFirstChunk()
List<ResultMessage>	messages()	Returns the value of the messages 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

Constructor Details

ResultChunk

public ResultChunk(List<String> fields,
 int chunkNumber,
 List<ResultMessage> messages)

Creates an instance of a ResultChunk record class.

Parameters:

fields - the value for the fields record component

chunkNumber - the value for the chunkNumber record component

messages - the value for the messages record component

Method Details

isFirstChunk

public boolean isFirstChunk()

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.

fields

public List<String> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

chunkNumber

public int chunkNumber()

Returns the value of the chunkNumber record component.

Returns:

the value of the chunkNumber record component

messages

public List<ResultMessage> messages()

Returns the value of the messages record component.

Returns:

the value of the messages record component