notifications

Documentation

Index

• Variables
• func IsNotifierSupported(notifierType string) bool
• func RegisterNotifier(notifierType supportedNotifierType, notifierProvider reflect.Type)
• type Notifier
  • func NewNotifier(notifierType string) (notifier Notifier, err error)
  • func NewNotifiers() ([]Notifier, error)

Variables

var (

	// ErrNotificationNotPresent error is caused when there isn't any notification present in the config
	ErrNotificationNotPresent = fmt.Errorf("no notification specified in the config")
)

Functions

func IsNotifierSupported

func IsNotifierSupported(notifierType string) bool

IsNotifierSupported returns true/false depending on whether the notifier is supported in terrascan or not

func RegisterNotifier

func RegisterNotifier(notifierType supportedNotifierType, notifierProvider reflect.Type)

RegisterNotifier registers an notifier provider for terrascan

Types

type Notifier

type Notifier interface {
	Init(interface{}) error
	SendNotification(interface{}) error
}

Notifier defines the interface which every type of notification provider needs to implement to claim support in terrascan

func NewNotifier

func NewNotifier(notifierType string) (notifier Notifier, err error)

NewNotifier returns a new notifier

func NewNotifiers

func NewNotifiers() ([]Notifier, error)

NewNotifiers returns a list of notifiers configured in the config file