loop

Documentation

Index

• Constants
• type DelaySpec
• type ExecutionMetadata
• type Loop
  • func (c *Loop) Cancel(ctx core.ExecutionContext) error
  • func (c *Loop) Cleanup(ctx core.SetupContext) error
  • func (c *Loop) Color() string
  • func (c *Loop) Configuration() []configuration.Field
  • func (c *Loop) Description() string
  • func (c *Loop) Documentation() string
  • func (c *Loop) ExampleOutput() map[string]any
  • func (c *Loop) Execute(ctx core.ExecutionContext) error
  • func (c *Loop) HandleHook(ctx core.ActionHookContext) error
  • func (c *Loop) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
  • func (c *Loop) Hooks() []core.Hook
  • func (c *Loop) Icon() string
  • func (c *Loop) Label() string
  • func (c *Loop) Name() string
  • func (c *Loop) OutputChannels(configuration any) []core.OutputChannel
  • func (c *Loop) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
  • func (c *Loop) Setup(ctx core.SetupContext) error
• type Spec

Constants

const (
	ChannelNameNext = "next"
	ChannelNameDone = "done"

	PayloadTypeNext = "loop.next"
	PayloadTypeDone = "loop.done"
)

const (
	DelayStrategyFixed       = "fixed"
	DelayStrategyExponential = "exponential"

	DelayMinIntervalSeconds = 1
	DelayMaxIntervalSeconds = 300
)

const (
	// DefaultTimeoutSeconds caps the total wall-clock time of a single loop run
	// when one is not configured. It exists so a loop can never get stuck
	// forever (e.g. downstream never reports back), which would also block every
	// subsequent run on the node since runs are serialized.
	DefaultTimeoutSeconds = 3600
	TimeoutMinSeconds     = 1
	TimeoutMaxSeconds     = 86400
)

const (
	StopReasonConditionMet  = "conditionTrue"
	StopReasonMaxIterations = "max_iterations"
)

const ComponentName = "loop"

const (
	MaxIterationsLimit = 100
)

Types

type DelaySpec

type DelaySpec struct {
	Enabled         bool   `json:"enabled" mapstructure:"enabled"`
	Strategy        string `json:"strategy" mapstructure:"strategy"`
	IntervalSeconds int    `json:"intervalSeconds" mapstructure:"intervalSeconds"`
}

type ExecutionMetadata

type ExecutionMetadata struct {
	Iteration                int       `json:"iteration"`
	MaxIterations            int       `json:"maxIterations"`
	Active                   bool      `json:"active"`
	StartedAt                time.Time `json:"startedAt"`
	WaitingBetweenIterations bool      `json:"waitingBetweenIterations,omitempty"`
}

type Loop

type Loop struct{}

func (*Loop) Cancel

func (c *Loop) Cancel(ctx core.ExecutionContext) error

func (*Loop) Cleanup

func (c *Loop) Cleanup(ctx core.SetupContext) error

func (*Loop) Color

func (c *Loop) Color() string

func (*Loop) Configuration

func (c *Loop) Configuration() []configuration.Field

func (*Loop) Description

func (c *Loop) Description() string

func (*Loop) Documentation

func (c *Loop) Documentation() string

func (*Loop) ExampleOutput

func (c *Loop) ExampleOutput() map[string]any

func (*Loop) Execute

func (c *Loop) Execute(ctx core.ExecutionContext) error

func (*Loop) HandleHook

func (c *Loop) HandleHook(ctx core.ActionHookContext) error

func (*Loop) HandleWebhook

func (c *Loop) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*Loop) Hooks

func (c *Loop) Hooks() []core.Hook

func (*Loop) Icon

func (c *Loop) Icon() string

func (*Loop) Label

func (c *Loop) Label() string

func (*Loop) Name

func (c *Loop) Name() string

func (*Loop) OutputChannels

func (c *Loop) OutputChannels(configuration any) []core.OutputChannel

func (*Loop) ProcessQueueItem

func (c *Loop) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*Loop) Setup

func (c *Loop) Setup(ctx core.SetupContext) error

type Spec

type Spec struct {
	UntilExpression        string     `json:"untilExpression"`
	MaxIterations          int        `json:"maxIterations"`
	TimeoutSeconds         int        `json:"timeoutSeconds" mapstructure:"timeoutSeconds"`
	DelayBetweenIterations *DelaySpec `json:"delayBetweenIterations,omitempty"`
}