Package org.graylog.events.processor
Interface EventProcessorConfig
- All Superinterfaces:
ContentPackable<EventProcessorConfigEntity>
- All Known Implementing Classes:
AggregationEventProcessorConfig
,EventProcessorConfig.FallbackConfig
,SystemNotificationEventProcessorConfig
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
static class
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiondefault boolean
Returns whether this config type is allowed to be exported in a Content Pack.default boolean
Returns whether this config type should be presented to users, as opposed to being used for background functionality.Returns the permissions that are required to create the event processor configuration.default Optional<EventProcessorSchedulerConfig>
toJobSchedulerConfig
(EventDefinition eventDefinition, JobSchedulerClock clock) Returns aJobDefinitionConfig
for this event processor configuration.type()
validate()
Validates the event processor configuration.Methods inherited from interface org.graylog2.contentpacks.ContentPackable
getContentPackPluginPackage, resolveNativeEntity, toContentPackEntity
-
Field Details
-
TYPE_FIELD
- See Also:
-
-
Method Details
-
type
String type() -
toJobSchedulerConfig
default Optional<EventProcessorSchedulerConfig> toJobSchedulerConfig(EventDefinition eventDefinition, JobSchedulerClock clock) Returns aJobDefinitionConfig
for this event processor configuration. If the event processor shouldn't be scheduled, this method returns an emptyOptional
.- Parameters:
eventDefinition
- the event definitionclock
- 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
Returns the permissions that are required to create the event processor configuration. (e.g. stream permissions)- Returns:
- the required permissions
-
isContentPackExportable
default boolean isContentPackExportable()Returns whether this config type is allowed to be exported in a Content Pack.- Returns:
- whether the config type can be exported in a Content Pack
-
isUserPresentable
default boolean isUserPresentable()Returns whether this config type should be presented to users, as opposed to being used for background functionality. i.e. Should this be able to be presented and modified on the Event Definitions Page.- Returns:
- whether the config type should be presented to users
-