Package org.graylog.plugins.views.search

Class Search

java.lang.Object

org.graylog.plugins.views.search.Search

All Implemented Interfaces:

ParameterProvider, ContentPackable<SearchEntity>, MongoEntity

public abstract class Search
extends Object
implements ContentPackable<SearchEntity>, ParameterProvider, MongoEntity

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Search.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_CREATED_AT
static final String	FIELD_OWNER
static final String	FIELD_REQUIRES

Constructor Summary

Constructors

Constructor	Description
Search()

Method Summary

Modifier and Type	Method	Description
Search	addStreamsToQueriesWithCategories(Function<Collection<String>,Stream<String>> categoryMappingFunction, StreamPermissions streamPermissions)
Search	addStreamsToQueriesWithoutStreams(Supplier<Set<String>> defaultStreamsSupplier)
Search	addStreamsToSearchTypesWithCategories(Function<Collection<String>,Stream<String>> categoryMappingFunction, StreamPermissions streamPermissions)
Search	applyExecutionState(ExecutionState executionState)
static Search.Builder	builder()
abstract org.joda.time.DateTime	createdAt()
Optional<Parameter>	getParameter(String parameterName)
abstract String	id()	ID of the entity.
abstract Optional<String>	owner()
abstract com.google.common.collect.ImmutableSet<Parameter>	parameters()
abstract com.google.common.collect.ImmutableSet<Query>	queries()
Query	queryForSearchType(String searchTypeId)
abstract Map<String,PluginMetadataSummary>	requires()
void	resolveNativeEntity(EntityDescriptor entityDescriptor, com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)
Set<String>	streamIdsForPermissionsCheck()
abstract Search.Builder	toBuilder()
SearchEntity	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
Set<String>	usedStreamIds()
Search	withOwner(String owner)
Search	withReferenceDate(org.joda.time.DateTime now)

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

Field Details

FIELD_REQUIRES

public static final String FIELD_REQUIRES

See Also:

• Constant Field Values

FIELD_CREATED_AT

public static final String FIELD_CREATED_AT

See Also:

• Constant Field Values

FIELD_OWNER

public static final String FIELD_OWNER

See Also:

• Constant Field Values

Constructor Details

Search

public Search()

Method Details

id

@Nullable
public abstract String id()

Description copied from interface: MongoEntity

ID of the entity. Will be stored as field "_id" with type ObjectId in MongoDB.

Specified by:

id in interface MongoEntity

Returns:

Hex string representation of the entity's ID

queries

public abstract com.google.common.collect.ImmutableSet<Query> queries()

parameters

public abstract com.google.common.collect.ImmutableSet<Parameter> parameters()

requires

public abstract Map<String,PluginMetadataSummary> requires()

owner

public abstract Optional<String> owner()

withOwner

public Search withOwner(@Nonnull
 String owner)

createdAt

public abstract org.joda.time.DateTime createdAt()

getParameter

public Optional<Parameter> getParameter(String parameterName)

Specified by:

getParameter in interface ParameterProvider

applyExecutionState

public Search applyExecutionState(ExecutionState executionState)

addStreamsToQueriesWithoutStreams

public Search addStreamsToQueriesWithoutStreams(Supplier<Set<String>> defaultStreamsSupplier)

addStreamsToQueriesWithCategories

public Search addStreamsToQueriesWithCategories(Function<Collection<String>,Stream<String>> categoryMappingFunction,
 StreamPermissions streamPermissions)

addStreamsToSearchTypesWithCategories

public Search addStreamsToSearchTypesWithCategories(Function<Collection<String>,Stream<String>> categoryMappingFunction,
 StreamPermissions streamPermissions)

toBuilder

public abstract Search.Builder toBuilder()

builder

public static Search.Builder builder()

usedStreamIds

public Set<String> usedStreamIds()

streamIdsForPermissionsCheck

public Set<String> streamIdsForPermissionsCheck()

queryForSearchType

public Query queryForSearchType(String searchTypeId)

withReferenceDate

public Search withReferenceDate(org.joda.time.DateTime now)

toContentPackEntity

public SearchEntity toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<SearchEntity>

resolveNativeEntity

public void resolveNativeEntity(EntityDescriptor entityDescriptor,
 com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)

Specified by:

resolveNativeEntity in interface ContentPackable<SearchEntity>