plugin

Documentation

Index

• Constants
• type AuthResult
• type Command
  • func NewCommand(service string) *Command
  • func (c *Command) IsHidden() *Command
  • func (c *Command) WithCategory(name string, description string) *Command
  • func (c *Command) WithOperation(name string, description string) *Command
  • func (c *Command) WithParameter(name string, type_ string, description string, required bool) *Command
• type CommandCategory
  • func NewCommandCategory(name string, description string) *CommandCategory
• type CommandParameter
  • func NewCommandParameter(name string, type_ string, description string, required bool) *CommandParameter
• type CommandPlugin
• type ExecutionContext
  • func NewExecutionContext(baseUri url.URL, auth AuthResult, input *FileParameter, ...) *ExecutionContext
• type ExecutionParameter
  • func NewExecutionParameter(name string, value interface{}) *ExecutionParameter
• type FileParameter
  • func NewFileParameter(path string, filename string, data []byte) *FileParameter
  • func (f FileParameter) Data() (io.ReadCloser, int64, error)
  • func (f FileParameter) Filename() string

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
	Category    *CommandCategory
}

func NewCommand

func NewCommand(service string) *Command

func (*Command) IsHidden

func (c *Command) IsHidden() *Command

func (*Command) WithCategory

func (c *Command) WithCategory(name string, description string) *Command

func (*Command) WithOperation

func (c *Command) WithOperation(name string, description string) *Command

func (*Command) WithParameter

func (c *Command) WithParameter(name string, type_ string, description string, required bool) *Command

type CommandCategory

type CommandCategory struct {
	Name        string
	Description string
}

func NewCommandCategory

func NewCommandCategory(name string, description string) *CommandCategory

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
	Input      *FileParameter
	Parameters []ExecutionParameter
	Insecure   bool
	Debug      bool
}

func NewExecutionContext

func NewExecutionContext(
	baseUri url.URL,
	auth AuthResult,
	input *FileParameter,
	parameters []ExecutionParameter,
	insecure bool,
	debug 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 {
	// contains filtered or unexported fields
}

func NewFileParameter

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

func (FileParameter) Data

func (f FileParameter) Data() (io.ReadCloser, int64, error)

func (FileParameter) Filename

func (f FileParameter) Filename() string