noop

Documentation

Overview

Package noop provides a fallback alert engine for cases where no alert is set.

Index

• type Alert
  • func NewNoopAlert(actionType interfaces.ActionType) (*Alert, error)
  • func (a *Alert) Class() interfaces.ActionType
  • func (a *Alert) Do(_ context.Context, _ interfaces.ActionCmd, _ models.ActionOpt, ...) (json.RawMessage, error)
  • func (_ *Alert) GetOnOffState(_ models.ActionOpt) models.ActionOpt
  • func (_ *Alert) Type() string

Types

type Alert

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

Alert is the structure backing the noop alert

func NewNoopAlert

func NewNoopAlert(actionType interfaces.ActionType) (*Alert, error)

NewNoopAlert creates a new noop alert engine

func (*Alert) Class

func (a *Alert) Class() interfaces.ActionType

Class returns the action type of the noop engine

func (*Alert) Do

func (a *Alert) Do(
	_ context.Context,
	_ interfaces.ActionCmd,
	_ models.ActionOpt,
	_ protoreflect.ProtoMessage,
	_ interfaces.ActionsParams,
	_ *json.RawMessage,
) (json.RawMessage, error)

Do perform the noop alert

func (*Alert) GetOnOffState

func (_ *Alert) GetOnOffState(_ models.ActionOpt) models.ActionOpt

GetOnOffState returns the off state of the noop engine

func (*Alert) Type

func (_ *Alert) Type() string

Type returns the action subtype of the remediation engine