opconfig

Documentation

Index

• type GetOperatorConfigParams
  • func (p *GetOperatorConfigParams) OperatorNameSuggestions(oc *OpConfig) map[string]string
• type OpConfig
  • func (oc *OpConfig) GetOperatorConfig(ctx *base.Context, mainInput *base.OperatorIO, args GetOperatorConfigParams) *base.OperatorIO
  • func (oc *OpConfig) GetSection(ctx *base.Context, mainInput *base.OperatorIO, args SectionParams) *base.OperatorIO
  • func (oc *OpConfig) RemoveSection(ctx *base.Context, mainInput *base.OperatorIO, args SectionParams) *base.OperatorIO
  • func (oc *OpConfig) WriteSection(ctx *base.Context, mainInput *base.OperatorIO) *base.OperatorIO
• type SectionParams
  • func (p *SectionParams) SectionNameSuggestions(oc *OpConfig) map[string]string

Types

type GetOperatorConfigParams

type GetOperatorConfigParams struct {
	OperatorName string
}

GetOperatorConfigParams contains the parameters for the GetSection function

func (*GetOperatorConfigParams) OperatorNameSuggestions

func (p *GetOperatorConfigParams) OperatorNameSuggestions(oc *OpConfig) map[string]string

OperatorNameSuggestions returns a map of possible arguments for the given function and argument name

type OpConfig

type OpConfig struct {
	CR *utils.ConfigReader
	GE *freepsgraph.GraphEngine
}

OpConfig is a FreepsOperator that can be used to retrieve and modify the config

func (*OpConfig) GetOperatorConfig

func (oc *OpConfig) GetOperatorConfig(ctx *base.Context, mainInput *base.OperatorIO, args GetOperatorConfigParams) *base.OperatorIO

GetOperatorConfig returns the default config for a given section

func (*OpConfig) GetSection

func (oc *OpConfig) GetSection(ctx *base.Context, mainInput *base.OperatorIO, args SectionParams) *base.OperatorIO

GetSection returns the section with the given name

func (*OpConfig) RemoveSection

func (oc *OpConfig) RemoveSection(ctx *base.Context, mainInput *base.OperatorIO, args SectionParams) *base.OperatorIO

RemoveSection removes the given section from the config file

func (*OpConfig) WriteSection

func (oc *OpConfig) WriteSection(ctx *base.Context, mainInput *base.OperatorIO) *base.OperatorIO

WriteSection writes the given section to the config file

type SectionParams

type SectionParams struct {
	SectionName string
}

SectionParams contains the parameters for the GetSection function

func (*SectionParams) SectionNameSuggestions

func (p *SectionParams) SectionNameSuggestions(oc *OpConfig) map[string]string

SectionNameSuggestions returns a map of possible arguments for the given function and argument name