org.graylog.events.processor.aggregation

Class AggregationEventProcessorConfig

java.lang.Object

org.graylog.events.processor.aggregation.AggregationEventProcessorConfig

All Implemented Interfaces:

EventProcessorConfig, ContentPackable<EventProcessorConfigEntity>

public abstract class AggregationEventProcessorConfig
extends Object
implements EventProcessorConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationEventProcessorConfig.Builder

Nested classes/interfaces inherited from interface org.graylog.events.processor.EventProcessorConfig

EventProcessorConfig.FallbackConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_NAME

Fields inherited from interface org.graylog.events.processor.EventProcessorConfig

TYPE_FIELD

Constructor Summary

Constructors

Constructor and Description
AggregationEventProcessorConfig()

Method Summary

Modifier and Type	Method and Description
static AggregationEventProcessorConfig.Builder	builder()
abstract Optional<AggregationConditions>	conditions()
abstract long	executeEveryMs()
abstract List<String>	groupBy()
abstract String	query()
abstract com.google.common.collect.ImmutableSet<Parameter>	queryParameters()
Set<String>	requiredPermissions() Returns the permissions that are required to create the event processor configuration.
void	resolveNativeEntity(EntityDescriptor entityDescriptor, com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)
abstract long	searchWithinMs()
abstract List<AggregationSeries>	series()
abstract com.google.common.collect.ImmutableSet<String>	streams()
abstract AggregationEventProcessorConfig.Builder	toBuilder()
EventProcessorConfigEntity	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
Optional<EventProcessorSchedulerConfig>	toJobSchedulerConfig(EventDefinition eventDefinition, JobSchedulerClock clock) Returns a JobDefinitionConfig for this event processor configuration.
ValidationResult	validate() Validates the event processor configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.graylog.events.processor.EventProcessorConfig

type

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage

Field Detail

TYPE_NAME

public static final String TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

AggregationEventProcessorConfig

public AggregationEventProcessorConfig()

Method Detail

query

public abstract String query()

queryParameters

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

streams

public abstract com.google.common.collect.ImmutableSet<String> streams()

groupBy

public abstract List<String> groupBy()

series

public abstract List<AggregationSeries> series()

conditions

public abstract Optional<AggregationConditions> conditions()

searchWithinMs

public abstract long searchWithinMs()

executeEveryMs

public abstract long executeEveryMs()

requiredPermissions

public Set<String> requiredPermissions()

Description copied from interface: EventProcessorConfig

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

Specified by:

requiredPermissions in interface EventProcessorConfig

Returns:

the required permissions

builder

public static AggregationEventProcessorConfig.Builder builder()

toBuilder

public abstract AggregationEventProcessorConfig.Builder toBuilder()

toJobSchedulerConfig

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

Description copied from interface: EventProcessorConfig

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

Specified by:

toJobSchedulerConfig in interface EventProcessorConfig

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

public ValidationResult validate()

Description copied from interface: EventProcessorConfig

Validates the event processor configuration.

Specified by:

validate in interface EventProcessorConfig

Returns:

the validation result

toContentPackEntity

public EventProcessorConfigEntity toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<EventProcessorConfigEntity>

resolveNativeEntity

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

Specified by:

resolveNativeEntity in interface ContentPackable<EventProcessorConfigEntity>