commandpredicate

README

command

The command predicate runs an external command.

Options

Option	Required	Description
cmd	yes	Name of the command to run
chdir		Change into this directory before running the command
Args		List of command line args
Stdin		String to pass to command stdin
Backgound		If true, don't wait for the command return

Results

Field	Type	Description
result	boolean	false if command return code is not 0. Use result option to override
rc	int	Return code of the command
stdout	string	standard output
stderr	string	error output

Example:

command:
  cmd: tr
  args:
    - A-Z
    - a-z
  stdin: "Hello World!"
register: lower
log:
  msg: R.lower.stdout

Documentation

Index

• Variables
• func New() genapid.Predicate
• type Predicate
  • func (predicate *Predicate) Call(log zerolog.Logger, c *ctx.Ctx) bool
  • func (predicate *Predicate) Name() string
  • func (predicate *Predicate) Params() interface{}
  • func (predicate *Predicate) Result() ctx.Result

Variables

var Name = "command"

Name of the predicate

Functions

func New

func New() genapid.Predicate

New returns a new Predicate

Types

type Predicate

type Predicate struct {
	// contains filtered or unexported fields
}

Predicate is a genapid.Predicate interface that describes the predicate

func (*Predicate) Call

func (predicate *Predicate) Call(log zerolog.Logger, c *ctx.Ctx) bool

Call evaluates the predicate

func (*Predicate) Name

func (predicate *Predicate) Name() string

Name returns the name of the predicate

func (*Predicate) Params

func (predicate *Predicate) Params() interface{}

Params returns a reference to a struct params accepted by the predicate

func (*Predicate) Result

func (predicate *Predicate) Result() ctx.Result

Result returns data set by the predicate