filterengine

Documentation

Index

• type DefaultFilterEngine
  • func New(log logrus.FieldLogger) *DefaultFilterEngine
  • func WithAllFilters(logger *logrus.Logger, dynamicCli dynamic.Interface, mapper meta.RESTMapper) *DefaultFilterEngine
  • func (f *DefaultFilterEngine) Register(filters ...Filter)
  • func (f DefaultFilterEngine) RegisteredFilters() []RegisteredFilter
  • func (f *DefaultFilterEngine) Run(ctx context.Context, event events.Event) events.Event
  • func (f *DefaultFilterEngine) SetFilter(name string, flag bool) error
• type Filter
• type FilterEngine
• type RegisteredFilter

Types

type DefaultFilterEngine

type DefaultFilterEngine struct {
	// contains filtered or unexported fields
}

DefaultFilterEngine is a default implementation of the Filter Engine

func New

func New(log logrus.FieldLogger) *DefaultFilterEngine

New creates new DefaultFilterEngine instance.

func WithAllFilters

func WithAllFilters(logger *logrus.Logger, dynamicCli dynamic.Interface, mapper meta.RESTMapper) *DefaultFilterEngine

WithAllFilters returns new DefaultFilterEngine instance with all filters registered.

func (*DefaultFilterEngine) Register

func (f *DefaultFilterEngine) Register(filters ...Filter)

Register filter(s) to engine

func (DefaultFilterEngine) RegisteredFilters

func (f DefaultFilterEngine) RegisteredFilters() []RegisteredFilter

RegisteredFilters returns sorted slice of registered filters

func (*DefaultFilterEngine) Run

func (f *DefaultFilterEngine) Run(ctx context.Context, event events.Event) events.Event

Run runs the registered filters always iterating over a slice of filters with sorted keys

func (*DefaultFilterEngine) SetFilter

func (f *DefaultFilterEngine) SetFilter(name string, flag bool) error

SetFilter sets filter value in FilterMap to enable or disable filter

type Filter

type Filter interface {
	Run(context.Context, *events.Event) error
	Name() string
	Describe() string
}

Filter has method to run filter

type FilterEngine

type FilterEngine interface {
	Run(context.Context, events.Event) events.Event
	Register(...Filter)
	RegisteredFilters() []RegisteredFilter
	SetFilter(string, bool) error
}

FilterEngine has methods to register and run filters

type RegisteredFilter

type RegisteredFilter struct {
	Enabled bool
	Filter
}

RegisteredFilter contains details about registered filter