configuration

Documentation

Index

• Variables
• func ExpandedKoanfKeys() (keys []string)
• func InitAllOptions()
• func KoanfKeys() (keys []string)
• func OptionFromKoanfKey(koanfKey string) (opt options.Option, err error)
• func ValidateKoanfKey(koanfKey string) error
• func ValidateParentKoanfKey(koanfKey string) error

Variables

var (
	ErrInvalidConfigurationKey = errors.New("provided key is not recognized as a valid configuration key.\nuse 'pingcli config list-keys' to view all available keys")
	ErrNoOptionForKey          = errors.New("no option found for the provided configuration key")
	ErrEmptyKeyForOptionSearch = errors.New("empty key provided for option search, too many matches with options not configured with a koanf key")
)

Functions

func ExpandedKoanfKeys

func ExpandedKoanfKeys() (keys []string)

Return a list of all koanf keys from Options Including all substrings of parent keys. For example, the option key export.environmentID adds the keys 'export' and 'export.environmentID' to the list.

func InitAllOptions

func InitAllOptions()

func KoanfKeys

func KoanfKeys() (keys []string)

func OptionFromKoanfKey

func OptionFromKoanfKey(koanfKey string) (opt options.Option, err error)

func ValidateKoanfKey

func ValidateKoanfKey(koanfKey string) error

func ValidateParentKoanfKey

func ValidateParentKoanfKey(koanfKey string) error