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
Modifier and TypeFieldDescriptionstatic final int
static final int
static final String
static final SortSpec.Direction
Fields inherited from interface org.graylog.plugins.views.search.rest.scriptingapi.request.SearchRequestSpec
DEFAULT_QUERY_STRING, DEFAULT_TIMERANGE
-
Constructor Summary
ConstructorDescriptionMessagesRequestSpec
(String queryString, Set<String> streams, TimeRange timerange, String sort, SortSpec.Direction sortOrder, int from, int size, List<String> fields) Creates an instance of aMessagesRequestSpec
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.fields()
Returns the value of thefields
record component.int
from()
Returns the value of thefrom
record component.final int
hashCode()
Returns a hash code value for this object.Returns the value of thequeryString
record component.int
size()
Returns the value of thesize
record component.sort()
Returns the value of thesort
record component.Returns the value of thesortOrder
record component.streams()
Returns the value of thestreams
record component.Returns the value of thetimerange
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
DEFAULT_FIELDS
-
DEFAULT_SORT
- See Also:
-
DEFAULT_SORT_ORDER
-
DEFAULT_SIZE
public static final int DEFAULT_SIZE- See Also:
-
DEFAULT_FROM
public static final int DEFAULT_FROM- See Also:
-
-
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 aMessagesRequestSpec
record class.- Parameters:
queryString
- the value for thequeryString
record componentstreams
- the value for thestreams
record componenttimerange
- the value for thetimerange
record componentsort
- the value for thesort
record componentsortOrder
- the value for thesortOrder
record componentfrom
- the value for thefrom
record componentsize
- the value for thesize
record componentfields
- the value for thefields
record component
-
-
Method Details
-
getSchema
-
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. -
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. -
equals
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 withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
queryString
Returns the value of thequeryString
record component.- Specified by:
queryString
in interfaceSearchRequestSpec
- Returns:
- the value of the
queryString
record component
-
streams
Returns the value of thestreams
record component.- Specified by:
streams
in interfaceSearchRequestSpec
- Returns:
- the value of the
streams
record component
-
timerange
Returns the value of thetimerange
record component.- Specified by:
timerange
in interfaceSearchRequestSpec
- Returns:
- the value of the
timerange
record component
-
sort
Returns the value of thesort
record component.- Returns:
- the value of the
sort
record component
-
sortOrder
Returns the value of thesortOrder
record component.- Returns:
- the value of the
sortOrder
record component
-
from
public int from()Returns the value of thefrom
record component.- Returns:
- the value of the
from
record component
-
size
public int size()Returns the value of thesize
record component.- Returns:
- the value of the
size
record component
-
fields
Returns the value of thefields
record component.- Returns:
- the value of the
fields
record component
-