iface

Documentation

Index

• Constants
• Variables
• func GetSelectorsShortDescription(selectors []*policylangv1.Selector) string
• type Policy
• type PolicyBase
• type PolicyMessage
  • func (m *PolicyMessage) MarshalJSON() ([]byte, error)
  • func (m *PolicyMessage) UnmarshalJSON(b []byte) error

Constants

const (
	// PoliciesRoot - path in config and status registry for policies results.
	PoliciesRoot = "policies"
)

Variables

var FxOptionsFuncTag = config.GroupTag("policy-fx-funcs")

FxOptionsFuncTag allows sub-modules to provide their options to per policy apps independently.

Functions

func GetSelectorsShortDescription

func GetSelectorsShortDescription(selectors []*policylangv1.Selector) string

GetSelectorsShortDescription returns a short description of the selectors.

Types

type Policy

type Policy interface {
	PolicyBase
	GetEvaluationInterval() time.Duration
	GetStatusRegistry() status.Registry
	TicksInDurationPb(*durationpb.Duration) int
	TicksInDuration(time.Duration) int
}

Policy is for read only access to full policy state.

type PolicyBase

type PolicyBase interface {
	GetPolicyName() string
	GetPolicyHash() string
}

PolicyBase is for read only access to base policy info.

type PolicyMessage

type PolicyMessage struct {
	*policylangv1.Policy
}

PolicyMessage is used for passing policies to be wrapped.

func (*PolicyMessage) MarshalJSON

func (m *PolicyMessage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*PolicyMessage) UnmarshalJSON

func (m *PolicyMessage) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.