plugin

Documentation

Index

• func DefaultGRPCServer(opts []grpc.ServerOption) *grpc.Server
• func GetAttr(req *v1.Struct, key string, defaultValue interface{}) interface{}
• type Identifier
• type Method
• type Plugin
• type Priority

Functions

func DefaultGRPCServer

func DefaultGRPCServer(opts []grpc.ServerOption) *grpc.Server

DefaultGRPCServer returns a gRPC server with a 2GB max message size.

func GetAttr

func GetAttr(req *v1.Struct, key string, defaultValue interface{}) interface{}

Types

type Identifier

type Identifier struct {
	Name      string
	Version   string
	RemoteURL string
	Checksum  string
}

type Method

type Method func(
	context.Context, *v1.Struct, ...grpc.CallOption) (*v1.Struct, error)

type Plugin

type Plugin struct {
	goplugin.NetRPCUnsupportedPlugin
	pluginV1.GatewayDPluginServiceServer

	Client *goplugin.Client

	ID          Identifier
	Description string
	Authors     []string
	License     string
	ProjectURL  string
	LocalPath   string
	Args        []string
	Env         []string
	Enabled     bool
	// internal and external config options
	Config map[string]string
	// hooks it attaches to
	Hooks    []pluginV1.HookName
	Priority Priority
	// required plugins to be loaded before this one
	// Built-in plugins are always loaded first
	Requires   []Identifier
	Tags       []string
	Categories []string
}

type Priority

type Priority uint

Priority is the priority of a hook. Smaller values are executed first (higher priority).