execution

Documentation

Index

• type Execution
  • func New(service *service.Service, eventID string, taskKey string, ...) (*Execution, error)
  • func (execution *Execution) Complete(outputKey string, outputData map[string]interface{}) error
  • func (execution *Execution) Execute() error
• type Status
• type StatusError
  • func (e StatusError) Error() string

Types

type Execution

type Execution struct {
	ID                string                 `hash:"-"`
	EventID           string                 `hash:"eventID"`
	Status            Status                 `hash:"-"`
	Service           *service.Service       `hash:"service"`
	TaskKey           string                 `hash:"taskKey"`
	Tags              []string               `hash:"tags"`
	Inputs            map[string]interface{} `hash:"inputs"`
	OutputKey         string                 `hash:"-"`
	OutputData        map[string]interface{} `hash:"-"`
	CreatedAt         time.Time              `hash:"-"`
	ExecutedAt        time.Time              `hash:"-"`
	ExecutionDuration time.Duration          `hash:"-"`
}

Execution stores all informations about executions.

func New

func New(service *service.Service, eventID string, taskKey string, inputs map[string]interface{}, tags []string) (*Execution, error)

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

func (*Execution) Complete

func (execution *Execution) Complete(outputKey string, outputData 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.

type Status

type Status int

Status stores the state of an execution

const (
	Created Status = iota
	InProgress
	Completed
)

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

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.