Package org.graylog.events.processor

Interface EventProcessorConfig

All Superinterfaces:
ContentPackable<EventProcessorConfigEntity>
All Known Implementing Classes:
AggregationEventProcessorConfig, EventProcessorConfig.FallbackConfig, SystemNotificationEventProcessorConfig
public interface EventProcessorConfig extends ContentPackable<EventProcessorConfigEntity>

  • Field Details

  • Method Details

    • 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

    • 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