noop

Documentation

Overview

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

Index

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

Types

type Remediator

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

Remediator is the structure backing the noop remediator

func NewNoopRemediate

func NewNoopRemediate(actionType interfaces.ActionType) (*Remediator, error)

NewNoopRemediate creates a new noop remediation engine

func (*Remediator) Class

func (r *Remediator) Class() interfaces.ActionType

Class returns the action type of the noop engine

func (*Remediator) Do

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

Do perform the remediation

func (*Remediator) GetOnOffState

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

GetOnOffState returns the off state of the noop engine

func (*Remediator) Type

func (_ *Remediator) Type() string

Type returns the action subtype of the remediation engine