lrpminvoker

Documentation

Overview

Package lrpminvoker contains implementation of lrpm-invoker plugin. (lrpm - long running plugin manager) lrpminvoker is an ondemand worker plugin - which can be called by SSM config or SSM Command.

Index

• func Name() string
• type InvokerInput
• type LongRunningPluginSettings
• type Plugin
  • func NewPlugin(pluginConfig pluginutil.PluginConfig) (*Plugin, error)
  • func (p *Plugin) CreateResult(msg string, status contracts.ResultStatus) (res contracts.PluginResult)
  • func (p *Plugin) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag, ...) (res contracts.PluginResult)
  • func (p *Plugin) GetPluginIdFromContext(context context.T) (string, error)

Functions

func Name

func Name() string

Name returns the plugin name

Types

type InvokerInput

type InvokerInput struct {
	ID         string      `json:"id"`
	Properties interface{} `json:"properties"`
}

InvokerInput represents input to lrpm invoker

type LongRunningPluginSettings

type LongRunningPluginSettings struct {
	StartType string
}

LongRunningPluginSettings represents startType configuration of long running plugin

type Plugin

type Plugin struct {
	pluginutil.DefaultPlugin
	// contains filtered or unexported fields
}

Plugin is the type for the lrpm invoker plugin.

func NewPlugin

func NewPlugin(pluginConfig pluginutil.PluginConfig) (*Plugin, error)

NewPlugin returns lrpminvoker

func (*Plugin) CreateResult

func (p *Plugin) CreateResult(msg string, status contracts.ResultStatus) (res contracts.PluginResult)

CreateResult returns a PluginResult for given message and status

func (*Plugin) Execute

func (p *Plugin) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag, subDocumentRunner runpluginutil.PluginRunner) (res contracts.PluginResult)

Execute sends commands specific to long running plugins to long running plugin manager and accordingly sends reply back

func (*Plugin) GetPluginIdFromContext

func (p *Plugin) GetPluginIdFromContext(context context.T) (string, error)

GetPluginIdFromContext gets pluginId from context