Package org.graylog.plugins.views.search

Class Search

java.lang.Object

org.graylog.plugins.views.search.Search

All Implemented Interfaces:

ParameterProvider, ContentPackable<SearchEntity>

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

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_OWNER
static final String	FIELD_REQUIRES

Constructor Summary

Constructors

Constructor	Description
Search()

Method Summary

Modifier and Type	Method	Description
Search	addStreamsToQueriesWithoutStreams(Supplier<Set<String>> defaultStreamsSupplier)
Search	applyExecutionState(ExecutionState executionState)
static Search.Builder	builder()
abstract org.joda.time.DateTime	createdAt()
Optional<Parameter>	getParameter(String parameterName)
abstract String	id()
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()
Set<String>	streamIdsForPermissionsCheck()
abstract Search.Builder	toBuilder()
SearchEntity	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
Set<String>	usedStreamIds()
Search	withOwner(String owner)

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

Field Details

FIELD_REQUIRES

public static final String FIELD_REQUIRES

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()

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)

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)

toContentPackEntity

public SearchEntity toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<SearchEntity>