manager

Documentation

Index

• type ForceStrategy
  • func (*ForceStrategy) Allowed() string
  • func (r *ForceStrategy) Has(s ForceStrategy) bool
  • func (r *ForceStrategy) Set(value string) error
  • func (r *ForceStrategy) String() string
  • func (*ForceStrategy) Type() string
• type Manager
  • func New(c *config.Data) *Manager
  • func (m *Manager) Apply() error
  • func (m *Manager) Enrich(ns notifications.Notifications) (notifications.Notifications, error)
  • func (m *Manager) Load() error
  • func (m *Manager) Refresh() error
  • func (m *Manager) Save() error
  • func (m *Manager) SetCaller(caller api.Requestor)
• type RefreshStrategy
  • func (*RefreshStrategy) Allowed() string
  • func (r *RefreshStrategy) Set(value string) error
  • func (r *RefreshStrategy) ShouldRefresh(expired bool) bool
  • func (r *RefreshStrategy) String() string
  • func (*RefreshStrategy) Type() string

Types

type ForceStrategy

type ForceStrategy int

ForceStrategy is an enum for the force strategy. It implements https://pkg.go.dev/github.com/spf13/pflag#Value.

const (
	// ForceApply forces the application of the ruleset on all notifications,
	// even the ones marked as Done.
	ForceApply ForceStrategy = 1 << iota

	// ForceNoop prevents any Action from being executed.
	ForceNoop

	// ForceApply forces the enrichment of all notifications, even the ones
	// marked as Done.
	ForceEnrich
)

func (*ForceStrategy) Allowed

func (*ForceStrategy) Allowed() string

func (*ForceStrategy) Has

func (r *ForceStrategy) Has(s ForceStrategy) bool

func (*ForceStrategy) Set

func (r *ForceStrategy) Set(value string) error

func (*ForceStrategy) String

func (r *ForceStrategy) String() string

func (*ForceStrategy) Type

func (*ForceStrategy) Type() string

type Manager

type Manager struct {
	Notifications notifications.Notifications
	Cache         cache.RefreshReadWriter

	Actions actions.Map

	RefreshStrategy RefreshStrategy
	ForceStrategy   ForceStrategy
	// contains filtered or unexported fields
}

func New

func New(c *config.Data) *Manager

func (*Manager) Apply

func (m *Manager) Apply() error

func (*Manager) Enrich

func (m *Manager) Enrich(ns notifications.Notifications) (notifications.Notifications, error)

func (*Manager) Load

func (m *Manager) Load() error

func (*Manager) Refresh

func (m *Manager) Refresh() error

func (*Manager) Save

func (m *Manager) Save() error

func (*Manager) SetCaller

func (m *Manager) SetCaller(caller api.Requestor)

type RefreshStrategy

type RefreshStrategy int

RefreshStrategy is an enum for the refresh strategy. It implements https://pkg.go.dev/github.com/spf13/pflag#Value.

const (
	// AutoRefresh refreshes the notifications if the cache is expired.
	AutoRefresh RefreshStrategy = iota

	// ForceRefresh always refreshes the notifications.
	ForceRefresh

	// PreventRefresh never refreshes the notifications.
	PreventRefresh
)

func (*RefreshStrategy) Allowed

func (*RefreshStrategy) Allowed() string

func (*RefreshStrategy) Set

func (r *RefreshStrategy) Set(value string) error

func (*RefreshStrategy) ShouldRefresh

func (r *RefreshStrategy) ShouldRefresh(expired bool) bool

func (*RefreshStrategy) String

func (r *RefreshStrategy) String() string

func (*RefreshStrategy) Type

func (*RefreshStrategy) Type() string