trigger

type ActionType struct {
	runtime.Schema

	// CreateFunc is called when a new instance of the trigger handler should be created.
	CreateFunc func(ctx context.Context, globalSchema *runtime.ConfigSchema, sec *conf.Section) (Handler, error) `json:"-"`
}

type Definition struct {
	ID      string
	Match   []conf.Option
	Actions []runtime.Section
}

type Handler interface {
	// HandleEvents is called for each set of events fired. There might
	// be multiple events if the users configures BufferUntil.
	HandleEvents(ctx context.Context, event ...*event.Event) error
}

type HandlerFunc func(ctx context.Context, event ...*event.Event) error

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

type InstanceConfig struct {
	// Name is the name of the instance as set by the user.
	Name string

	// EventFilters holds a topic subscription that's evaluated using
	// event.MatchSubscription. It's only used when calling Wants() on the
	// final instance returned by NewInstance. This field is not required
	// and only for convenience purpopses when manually triggering instances
	// using Handle().
	EventFilters []string
	// DebounceUntil can be set to different day-times (minute resolution)
	// until which the handling of events is debounced. A trigger instance
	// that is currently debouncing events and waiting for the next "until"
	// time returns true from Pending(). Trigger instances with DebounceUntil=
	// will never fire more than one event at the specified day times and never
	// fire in between.
	//
	// Note that DebounceUntil and BufferUntil are mutually exclusive.
	// Configuring both will cause NewInstance to return an error.
	DebounceUntil []daytime.DayTime
	// BufferUntil works similar to DebounceUntil but instead of dropping older
	// events and just keeping the latest one BufferUntil keeps track of all
	// events that occurred between the configured day times. Once a day time is
	// reached with minute resolution, the complete buffer of events is handed to
	// each handler of the instance.
	//
	// Note that DebounceUntil and BufferUntnil are mutually exclusive.
	// Configuring both will cause NewInstance to return an error.
	BufferUntil []daytime.DayTime
	// Location may defined the timezone the instance should operate in. The
	// timezone is mainly required if DebounceUntil or BufferUntil is configured.
	Location *time.Location
	// Description holds an optional, human-readable description
	Description string
	// Group is a list of group names the trigger instance belongs to.
	// Groups have no special meaning in this package but may be used
	// by package users for different purposes. I.e. in CIS the trigger
	// group is used to allow execution of multiple trigger instances via
	// the API.
	Groups []string
	// Condition holds a maja42/goval condtion that must evaluate to true for
	// the trigger to fire.
	Condition string
}

type MatchConfig struct {
	// Name is the name of the trigger instance as set by the user.
	Name string
	// EventFitler may hold multiple event topic subscriptions.
	// The trigger instance created from this MatchConfig handles
	// each event that matches one of the specified filters.
	EventFilter []string
	// BufferUntil configures the day-times until which events should
	// be buffered and emitted at once. Refer to the documentation of
	// InstanceConfig for more information on event buffering.
	//
	// Note that BufferUntil and DebounceUntil are mutally exclusive.
	BufferUntil []string
	// Debounce configures the day-times until which events should
	// be debounced and only the last one should be emitted.
	// Refer to the documentation of InstanceConfig for more information
	// on event debouncing.
	//
	// Note that BufferUntil and DebounceUntil are mutally exclusive.
	DebounceUntil []string
	// Description holds an optional, human-readable description
	Description string
	// Group is a list of group names the trigger instance belongs to
	Group []string
	// Condition is a maja42/goval condition that must evaluate to true.
	Condition string
}

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