client

Documentation

Index

• func DownloadPlugin(url string, name string, version string) (string, error)
• type CustomCommandExecutor
• type Factory
  • func NewFactory() Factory
• type PluginInstance
• type Provider

Functions

func DownloadPlugin

func DownloadPlugin(url string, name string, version string) (string, error)

Types

type CustomCommandExecutor

type CustomCommandExecutor interface {
	ExecuteCustomCommand(cmdName string, ctx context.Context, args []string) error
}

CustomCommandExecutor requires the Plugin implementations to provide the ExecuteCustomCommand method so that the Core can ask over gRPC for a specific command to be executed. `cmdName` is the name of the custom command the plugin created.

type Factory

type Factory interface {
	New(config types.PluginConfig, streams ioutils.Streams) (*PluginInstance, error)
}

A Factory class for constructing plugin instances.

func NewFactory

func NewFactory() Factory

type PluginInstance

type PluginInstance struct {
	plugin.Plugin
	Provider
	CustomCommandExecutor
}

A PluginInstance consists of the underling Plugin as well as any associated objects or metadata.

type Provider

type Provider interface {
	Client() (goplugin.ClientProtocol, error)
	Kill()
}

Provider is an interface for goplugin.Client returned by goplugin.NewClient.