Package org.graylog.plugins.views.search.rest.scriptingapi.request

Record Class MessagesRequestSpec

java.lang.Object

java.lang.Record

org.graylog.plugins.views.search.rest.scriptingapi.request.MessagesRequestSpec

All Implemented Interfaces:

SearchRequestSpec

public record MessagesRequestSpec(String queryString, Set<String> streams, TimeRange timerange, String sort, SortSpec.Direction sortOrder, int from, int size, List<String> fields)
extends Record
implements SearchRequestSpec

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	DEFAULT_FIELDS
static final int	DEFAULT_FROM
static final int	DEFAULT_SIZE
static final String	DEFAULT_SORT
static final SortSpec.Direction	DEFAULT_SORT_ORDER

Fields inherited from interface org.graylog.plugins.views.search.rest.scriptingapi.request.SearchRequestSpec

DEFAULT_QUERY_STRING, DEFAULT_TIMERANGE

Constructor Summary

Constructors

Constructor	Description
MessagesRequestSpec(String queryString, Set<String> streams, TimeRange timerange, String sort, SortSpec.Direction sortOrder, int from, int size, List<String> fields)	Creates an instance of a MessagesRequestSpec record class.

Method Summary

Modifier and Type	Method	Description
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.
int	from()	Returns the value of the from record component.
List<ResponseSchemaEntry>	getSchema(Map<String,String> fieldTypes)
final int	hashCode()	Returns a hash code value for this object.
String	queryString()	Returns the value of the queryString record component.
int	size()	Returns the value of the size record component.
String	sort()	Returns the value of the sort record component.
SortSpec.Direction	sortOrder()	Returns the value of the sortOrder record component.
Set<String>	streams()	Returns the value of the streams record component.
TimeRange	timerange()	Returns the value of the timerange 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

DEFAULT_FIELDS

public static final List<String> DEFAULT_FIELDS

DEFAULT_SORT

public static final String DEFAULT_SORT

See Also:

• Constant Field Values

DEFAULT_SORT_ORDER

public static final SortSpec.Direction DEFAULT_SORT_ORDER

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

• Constant Field Values

DEFAULT_FROM

public static final int DEFAULT_FROM

See Also:

• Constant Field Values

Constructor Details

MessagesRequestSpec

public MessagesRequestSpec(String queryString,
 Set<String> streams,
 TimeRange timerange,
 String sort,
 SortSpec.Direction sortOrder,
 int from,
 int size,
 List<String> fields)

Creates an instance of a MessagesRequestSpec record class.

Parameters:

queryString - the value for the queryString record component

streams - the value for the streams record component

timerange - the value for the timerange record component

sort - the value for the sort record component

sortOrder - the value for the sortOrder record component

from - the value for the from record component

size - the value for the size record component

fields - the value for the fields record component

Method Details

getSchema

public List<ResponseSchemaEntry> getSchema(Map<String,String> fieldTypes)

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.

queryString

public String queryString()

Returns the value of the queryString record component.

Specified by:

queryString in interface SearchRequestSpec

Returns:

the value of the queryString record component

streams

public Set<String> streams()

Returns the value of the streams record component.

Specified by:

streams in interface SearchRequestSpec

Returns:

the value of the streams record component

timerange

public TimeRange timerange()

Returns the value of the timerange record component.

Specified by:

timerange in interface SearchRequestSpec

Returns:

the value of the timerange record component

sort

public String sort()

Returns the value of the sort record component.

Returns:

the value of the sort record component

sortOrder

public SortSpec.Direction sortOrder()

Returns the value of the sortOrder record component.

Returns:

the value of the sortOrder record component

from

public int from()

Returns the value of the from record component.

Returns:

the value of the from record component

size

public int size()

Returns the value of the size record component.

Returns:

the value of the size record component

fields

public List<String> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component