execution

Documentation

Index

• type Execution
  • func New(workflowHash, instanceHash, parentHash, eventHash hash.Hash, stepID string, ...) *Execution
  • func (execution *Execution) Complete(outputs map[string]interface{}) error
  • func (execution *Execution) Execute() error
  • func (execution *Execution) Failed(err error) error
• type Status
  • func (s Status) String() (r string)
• type StatusError
  • func (e StatusError) Error() string

Types

type Execution

type Execution struct {
	Hash         hash.Hash              `hash:"-"`
	WorkflowHash hash.Hash              `hash:"name:workflowHash"`
	ParentHash   hash.Hash              `hash:"name:parentHash"`
	EventHash    hash.Hash              `hash:"name:eventHash"`
	Status       Status                 `hash:"-"`
	InstanceHash hash.Hash              `hash:"name:instanceHash"`
	TaskKey      string                 `hash:"name:taskKey"`
	StepID       string                 `hash:"name:stepID"`
	Tags         []string               `hash:"name:tags"`
	Inputs       map[string]interface{} `hash:"name:inputs"`
	Outputs      map[string]interface{} `hash:"-"`
	Error        string                 `hash:"-"`
}

Execution stores all information about executions.

func New

func New(workflowHash, instanceHash, parentHash, eventHash hash.Hash, stepID string, taskKey string, inputs map[string]interface{}, tags []string) *Execution

New returns a new execution. It returns an error if inputs are invalid.

func (*Execution) Complete

func (execution *Execution) Complete(outputs map[string]interface{}) error

Complete changes execution status to completed. It verifies the output. It returns an error if the status is different then InProgress or verification fails.

func (*Execution) Execute

func (execution *Execution) Execute() error

Execute changes executions status to in progres and update its execute time. It returns an error if the status is different then Created.

func (*Execution) Failed

func (execution *Execution) Failed(err error) error

Failed changes execution status to failed and puts error information to execution. It returns an error if the status is different then InProgress.

type Status

type Status int

Status stores the state of an execution

const (
	Created Status = iota + 1
	InProgress
	Completed
	Failed
)

Status for an execution Created => The execution is created but not yet processed InProgress => The execution is being processed Completed => The execution is completed

func (Status) String

func (s Status) String() (r string)

type StatusError

type StatusError struct {
	ExpectedStatus Status
	ActualStatus   Status
}

StatusError is an error when the processing is done on en execution with the wrong status

func (StatusError) Error

func (e StatusError) Error() string

Error returns the string representation of error.