org.graylog.events.processor

Interface EventProcessorConfig

All Superinterfaces:

ContentPackable<EventProcessorConfigEntity>

All Known Implementing Classes:

AggregationEventProcessorConfig, EventProcessorConfig.FallbackConfig

public interface EventProcessorConfig
extends ContentPackable<EventProcessorConfigEntity>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventProcessorConfig.Builder<SELF>
static class	EventProcessorConfig.FallbackConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_FIELD

Method Summary

Modifier and Type	Method and Description
default Set<String>	requiredPermissions() Returns the permissions that are required to create the event processor configuration.
default Optional<EventProcessorSchedulerConfig>	toJobSchedulerConfig(EventDefinition eventDefinition, JobSchedulerClock clock) Returns a JobDefinitionConfig for this event processor configuration.
String	type()
ValidationResult	validate() Validates the event processor configuration.

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage, resolveNativeEntity, toContentPackEntity

Field Detail

TYPE_FIELD

static final String TYPE_FIELD

See Also:

Constant Field Values

Method Detail

type

String type()

toJobSchedulerConfig

default Optional<EventProcessorSchedulerConfig> toJobSchedulerConfig(EventDefinition eventDefinition,
                                                                     JobSchedulerClock clock)

Returns a JobDefinitionConfig for this event processor configuration. If the event processor shouldn't be scheduled, this method returns an empty Optional.

Parameters:

eventDefinition - the event definition

clock - the clock that can be used to get the current time

Returns:

the job definition config or an empty optional if the processor shouldn't be scheduled

validate

ValidationResult validate()

Validates the event processor configuration.

Returns:

the validation result

requiredPermissions

default Set<String> requiredPermissions()

Returns the permissions that are required to create the event processor configuration. (e.g. stream permissions)

Returns:

the required permissions