types

Documentation

Index

• type Action
  • func ParseActionID(actionID string) (Action, error)
  • func (o Action) IntegrationVerbString() string
  • func (o Action) String() string
• type RandomScheduleOpt
• type WorkflowEvent
• type WorkflowFile
  • func ParseYAML(ctx context.Context, yamlBytes []byte) (WorkflowFile, error)
  • func (w *WorkflowFile) GetJobByName(name string) *WorkflowJob
  • func (w *WorkflowFile) ListJobNames() []string
• type WorkflowJob
• type WorkflowNode
  • func (t *WorkflowNode) AddNode(name string) error
• type WorkflowOn
• type WorkflowOnCron
• type WorkflowStep
• type WorkflowTree
  • func NewWorkflowTree() *WorkflowTree
  • func ParseWorkflowTreeFromFile(file WorkflowFile) (*WorkflowTree, error)
  • func (t *WorkflowTree) AddRootNode(name string)

Types

type Action

type Action struct {
	// Required. The integration that this uses.
	IntegrationID string

	// Required. The verb to perform.
	Verb string

	// Optional. A way to unique identify the step.
	Subresource string
}

func ParseActionID

func ParseActionID(actionID string) (Action, error)

ParseActionID parses an action ID into its constituent parts.

func (Action) IntegrationVerbString

func (o Action) IntegrationVerbString() string

func (Action) String

func (o Action) String() string

type RandomScheduleOpt

type RandomScheduleOpt string

const (
	Random15Min  RandomScheduleOpt = "random_15_min"
	RandomHourly RandomScheduleOpt = "random_hourly"
	RandomDaily  RandomScheduleOpt = "random_daily"
)

type WorkflowEvent

type WorkflowEvent struct {
	Name string `yaml:"name"`
}

type WorkflowFile

type WorkflowFile struct {
	Name string `yaml:"name"`

	On WorkflowOn `yaml:"on"`

	Jobs map[string]WorkflowJob `yaml:"jobs"`
}

func ParseYAML

func ParseYAML(ctx context.Context, yamlBytes []byte) (WorkflowFile, error)

func (*WorkflowFile) GetJobByName

func (w *WorkflowFile) GetJobByName(name string) *WorkflowJob

func (*WorkflowFile) ListJobNames

func (w *WorkflowFile) ListJobNames() []string

type WorkflowJob

type WorkflowJob struct {
	Queue string `yaml:"queue"`

	Timeout string `yaml:"timeout"`

	Steps []WorkflowStep `yaml:"steps"`
}

type WorkflowNode

type WorkflowNode struct {
	Name     string
	Children []*WorkflowNode
}

func (*WorkflowNode) AddNode

func (t *WorkflowNode) AddNode(name string) error

type WorkflowOn

type WorkflowOn struct {
	Events []string       `yaml:"events"`
	Cron   WorkflowOnCron `yaml:"cron"`
}

type WorkflowOnCron

type WorkflowOnCron struct {
	Schedule string `yaml:"schedule"`
}

type WorkflowStep

type WorkflowStep struct {
	Name     string                 `yaml:"name"`
	ID       string                 `yaml:"id"`
	ActionID string                 `yaml:"actionId"`
	Timeout  string                 `yaml:"timeout"`
	With     map[string]interface{} `yaml:"with,omitempty"`
}

type WorkflowTree

type WorkflowTree struct {
	RootWorkflows []*WorkflowNode
}

func NewWorkflowTree

func NewWorkflowTree() *WorkflowTree

func ParseWorkflowTreeFromFile

func ParseWorkflowTreeFromFile(file WorkflowFile) (*WorkflowTree, error)

func (*WorkflowTree) AddRootNode

func (t *WorkflowTree) AddRootNode(name string)