org.graylog.plugins.views.search

Interface SearchType

All Superinterfaces:

ContentPackable<SearchTypeEntity>, Exportable

All Known Implementing Classes:

EventList, MessageList, Pivot, SearchType.Fallback

public interface SearchType
extends ContentPackable<SearchTypeEntity>, Exportable

A search type represents parts of a query that generates a result.

Plain queries only select a set of data but by themselves do not return any specific parts from it. Typical search types are aggregations across fields, a list of messages and other metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SearchType.Fallback
static interface	SearchType.Result Each search type should declare an implementation of its result conforming to this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_FIELD

Method Summary

Modifier and Type	Method and Description
SearchType	applyExecutionContext(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.databind.JsonNode state)
default Set<String>	effectiveStreams()
Filter	filter()
String	id()
default Set<String>	mappedStreams(EntityDescriptorIds entityDescriptorIds)
Optional<String>	name()
Optional<BackendQuery>	query()
Set<String>	streams()
Optional<DerivedTimeRange>	timerange()
String	type()

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage, resolveNativeEntity, toContentPackEntity

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

isExportable

Field Detail

TYPE_FIELD

static final String TYPE_FIELD

See Also:

Constant Field Values

Method Detail

type

String type()

id

String id()

name

Optional<String> name()

filter

@Nullable
Filter filter()

timerange

Optional<DerivedTimeRange> timerange()

query

Optional<BackendQuery> query()

streams

Set<String> streams()

applyExecutionContext

SearchType applyExecutionContext(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                 com.fasterxml.jackson.databind.JsonNode state)

effectiveStreams

default Set<String> effectiveStreams()

mappedStreams

default Set<String> mappedStreams(EntityDescriptorIds entityDescriptorIds)