plugin

Documentation

Index

• Constants
• type AuthResult
• type Command
  • func NewCommand(service string, name string, description string, parameters []CommandParameter, ...) *Command
• type CommandParameter
  • func NewCommandParameter(name string, type_ string, description string, required bool) *CommandParameter
• type CommandPlugin
• type ExecutionContext
  • func NewExecutionContext(baseUri url.URL, auth AuthResult, parameters []ExecutionParameter, ...) *ExecutionContext
• type ExecutionParameter
  • func NewExecutionParameter(name string, value interface{}) *ExecutionParameter
• type FileParameter
  • func NewFileParameter(filename string, data []byte) *FileParameter

Constants

const (
	ParameterTypeString       = "string"
	ParameterTypeBinary       = "binary"
	ParameterTypeInteger      = "integer"
	ParameterTypeNumber       = "number"
	ParameterTypeBoolean      = "boolean"
	ParameterTypeObject       = "object"
	ParameterTypeStringArray  = "stringArray"
	ParameterTypeIntegerArray = "integerArray"
	ParameterTypeNumberArray  = "numberArray"
	ParameterTypeBooleanArray = "booleanArray"
	ParameterTypeObjectArray  = "objectArray"
)

Types

type AuthResult

type AuthResult struct {
	Header map[string]string
}

type Command

type Command struct {
	Service     string
	Name        string
	Description string
	Parameters  []CommandParameter
	Hidden      bool
}

func NewCommand

func NewCommand(service string, name string, description string, parameters []CommandParameter, hidden bool) *Command

type CommandParameter

type CommandParameter struct {
	Name        string
	Type        string
	Description string
	Required    bool
}

func NewCommandParameter

func NewCommandParameter(name string, type_ string, description string, required bool) *CommandParameter

type CommandPlugin

type CommandPlugin interface {
	Command() Command
	Execute(context ExecutionContext, writer output.OutputWriter, logger log.Logger) error
}

type ExecutionContext

type ExecutionContext struct {
	BaseUri    url.URL
	Auth       AuthResult
	Parameters []ExecutionParameter
	Insecure   bool
}

func NewExecutionContext

func NewExecutionContext(
	baseUri url.URL,
	auth AuthResult,
	parameters []ExecutionParameter,
	insecure bool) *ExecutionContext

type ExecutionParameter

type ExecutionParameter struct {
	Name  string
	Value interface{}
}

func NewExecutionParameter

func NewExecutionParameter(name string, value interface{}) *ExecutionParameter

type FileParameter

type FileParameter struct {
	Filename string
	Data     []byte
}

func NewFileParameter

func NewFileParameter(filename string, data []byte) *FileParameter