Package org.graylog.plugins.views.search.searchtypes

Class MessageList

java.lang.Object

org.graylog.plugins.views.search.searchtypes.MessageList

All Implemented Interfaces:

Exportable, SearchType, ContentPackable<SearchTypeEntity>

public abstract class MessageList
extends Object
implements SearchType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageList.Builder
static class	MessageList.Result

Nested classes/interfaces inherited from interface org.graylog.plugins.views.search.SearchType

SearchType.Fallback

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface org.graylog.plugins.views.search.SearchType

FIELD_SEARCH_FILTERS, TYPE_FIELD

Constructor Summary

Constructors

Constructor	Description
MessageList()

Method Summary

Modifier and Type	Method	Description
SearchType	applyExecutionContext(SearchTypeExecutionState executionState)
static MessageList.Builder	builder()
abstract List<Decorator>	decorators()
abstract List<String>	fields()
abstract Filter	filter()
abstract List<UsedSearchFilter>	filters()
abstract String	id()
boolean	isExportable()
abstract int	limit()
abstract Optional<String>	name()
abstract int	offset()
abstract List<Sort>	sort()
abstract MessageList.Builder	toBuilder()
SearchTypeEntity	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
abstract String	type()
SearchType	withFilter(Filter filter)
SearchType	withFilters(List<UsedSearchFilter> filters)
SearchType	withQuery(BackendQuery query)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage, resolveNativeEntity

Methods inherited from interface org.graylog.plugins.views.search.SearchType

effectiveStreams, mappedStreams, query, streams, timerange

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MessageList

public MessageList()

Method Details

type

public abstract String type()

Specified by:

type in interface SearchType

id

@Nullable
public abstract String id()

Specified by:

id in interface SearchType

name

public abstract Optional<String> name()

Specified by:

name in interface SearchType

filter

@Nullable
public abstract Filter filter()

Specified by:

filter in interface SearchType

filters

public abstract List<UsedSearchFilter> filters()

Specified by:

filters in interface SearchType

limit

public abstract int limit()

offset

public abstract int offset()

sort

@Nullable
public abstract List<Sort> sort()

fields

public abstract List<String> fields()

decorators

public abstract List<Decorator> decorators()

isExportable

public boolean isExportable()

Specified by:

isExportable in interface Exportable

builder

public static MessageList.Builder builder()

toBuilder

public abstract MessageList.Builder toBuilder()

applyExecutionContext

public SearchType applyExecutionContext(SearchTypeExecutionState executionState)

Specified by:

applyExecutionContext in interface SearchType

withQuery

public SearchType withQuery(BackendQuery query)

Specified by:

withQuery in interface SearchType

withFilter

public SearchType withFilter(Filter filter)

Specified by:

withFilter in interface SearchType

withFilters

public SearchType withFilters(List<UsedSearchFilter> filters)

Specified by:

withFilters in interface SearchType

toContentPackEntity

public SearchTypeEntity toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<SearchTypeEntity>