operation

README

Operation.

This library contains the interfaces to help develop Operations for CML.

Documentation

Index

• func GetLogger(ref string) log.Logger
• func GetRef(operation Operation) string
• func Register(operation Operation, f ...Factory) error
• type Config
• type Factory
  • func GetFactory(ref string) Factory
• type InitContext
• type Operation
  • func Get(ref string) Operation

Functions

func GetLogger

func GetLogger(ref string) log.Logger

GetLogger gets activity logger by ref

func GetRef

func GetRef(operation Operation) string

func Register

func Register(operation Operation, f ...Factory) error

Register function registers Operation and it's Factory function.

Types

type Config

type Config struct {
	Operation string                 `json:"operation"`
	Params    map[string]interface{} `json:"params,omitempty"`
	Input     map[string]interface{} `json:"input,omitempty"`
	Output    string                 `json:"output,required"`
}

The struct config of operation.

type Factory

type Factory func(ctx InitContext) (Operation, error)

func GetFactory

func GetFactory(ref string) Factory

GetFactory gets activity factory by ref

type InitContext

type InitContext interface {

	// Params
	Params() map[string]interface{}

	// MapperFactory gets the mapper factory associated with the operation host
	MapperFactory() mapper.Factory

	// Logger logger to using during initialization, operation implementations should not
	// keep a reference to this
	Logger() log.Logger
}

type Operation

type Operation interface {
	Eval(inputs map[string]interface{}) (interface{}, error)
}

Activity is an interface for defining a custom Activity Execution

func Get

func Get(ref string) Operation

Get gets specified activity by ref