v1

Documentation

Index

• type Engine
  • func NewEngine() *Engine
  • func (e *Engine) NewDataSourcePlugin(ctx context.Context, config PluginConfig) (apiv1.DataSourcePlugin, error)
  • func (e *Engine) NewResourcePlugin(ctx context.Context, config PluginConfig) (apiv1.ResourcePlugin, error)
• type PluginConfig

Types

type Engine

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

Engine is the plugin engine that knows how to load, prepare and return new plugins.

func NewEngine

func NewEngine() *Engine

NewEngine returns a new plugin V1 engine.

func (*Engine) NewDataSourcePlugin

func (e *Engine) NewDataSourcePlugin(ctx context.Context, config PluginConfig) (apiv1.DataSourcePlugin, error)

func (*Engine) NewResourcePlugin

func (e *Engine) NewResourcePlugin(ctx context.Context, config PluginConfig) (apiv1.ResourcePlugin, error)

NewResourcePlugin returns a new plugin based on the plugin source code and the plugin options that will be passed on plugin creation. the resulting plugin will be able to be used.

type PluginConfig

type PluginConfig struct {
	// SourceCodeRepository is the repository where the plugin engine will get the source code for the plugin.
	SourceCodeRepository storage.SourceCodeRepository
	// PluginOptions are the options that will be passed to the plugin factory to create a new plugin.
	PluginOptions string
	// PluginFactoryName is the name that the plugin  engine will search for in the plugin factory inside
	// the plugin source code. It must meet the plugin factory signature.
	// E.g: NewResourcePlugin, NewDataSourcePlugin...
	PluginFactoryName string
}

PluginConfig is the configuration that the engine needs to instantiate a new plugin.