types

Documentation

Index

• type Config
• type Help
• type PluginParserResult
• type TypeMapping

Types

type Config

type Config struct {
	Name    string
	Version string
	Prefix  string
	Help    Help
}

Config provides Kombustion with information about your plugin

type Help

type Help struct {
	// A short description of what the plugin does
	Description string

	// Examples/Snippets of how this plugin can be used
	Snippets []string
	Types    []TypeMapping
}

Help - a set of available documentation fields

type PluginParserResult

type PluginParserResult struct {
	Conditions kombustionTypes.TemplateObject
	Metadata   kombustionTypes.TemplateObject
	Mappings   kombustionTypes.TemplateObject
	Outputs    kombustionTypes.TemplateObject
	Parameters kombustionTypes.TemplateObject
	Resources  kombustionTypes.TemplateObject
	Transform  kombustionTypes.TemplateObject

	Errors []error
}

PluginParserResult result of a parserFunc

type TypeMapping

type TypeMapping struct {
	Name        string
	Description string
	Config      interface{}
}

TypeMapping - recursive list of types with its associated config object