pipeline

Documentation

Overview

Package pipeline is intended to be used by plugin developers to create new pipeline plugins

Index

• type Action
• type ActionInput
• type ActionMetadata
• type ConfigurableAction
• type Metadata
• type Plugin

Types

type Action

type Action interface {
	Metadata() *ActionMetadata
	ExecuteFunc() interface{}
}

Action represents an action that the pipeline plugin supports

type ActionInput

type ActionInput interface {
	IsActionInput()
}

ActionInput is an argument type that is used by plugins as a vehicle for accepting action input data. A struct implementing this interface indicates to the plugin system that the struct should not be included in a grpc advertised dynamic function spec, because it will be injected on the plugin side, not supplied from core over GRPC.

type ActionMetadata

type ActionMetadata struct {
	Name        string
	Description string
	Group       string
}

ActionMetadata includes the action name and description which is used for documentation

type ConfigurableAction

type ConfigurableAction interface {
	Configure(data interface{}, logger hclog.Logger) error
}

ConfigurableAction is an action that can accept pipeline data

type Metadata

type Metadata struct {
	Name        string
	Description string
}

Metadata includes the pipeline name and description which is used for documentation

type Plugin

type Plugin interface {
	Config() (any, error)
	ValidateConfig(config any) error
	PluginData(logger hclog.Logger) (any, error)
	GetActions() []func() Action
}

Plugin is a type of plugin which provides actions and data sources