core

Documentation

Index

• Constants
• func ValidQueue(q Queue) error
• type Queue
  • func (q *Queue) Scan(value interface{}) error
  • func (q Queue) Value() (string, error)
• type WorkflowInstance
  • func NewSubWorkflowInstance(instanceID, executionID string, parentInstance *WorkflowInstance, ...) *WorkflowInstance
  • func NewWorkflowInstance(instanceID, executionID string) *WorkflowInstance
  • func (wi *WorkflowInstance) SubWorkflow() bool
• type WorkflowInstanceState

Constants

const (
	QueueDefault = Queue("default")
	QueueSystem  = Queue("_system_")
)

Functions

func ValidQueue

func ValidQueue(q Queue) error

ValidQueue ensures that the queue name is valid.

Types

type Queue

type Queue string

func (*Queue) Scan

func (q *Queue) Scan(value interface{}) error

func (Queue) Value

func (q Queue) Value() (string, error)

type WorkflowInstance

type WorkflowInstance struct {
	// InstanceID is the ID of the workflow instance.
	InstanceID string `json:"instance_id,omitempty"`

	// ExecutionID is the ID of the current execution of the workflow instance.
	ExecutionID string `json:"execution_id,omitempty"`

	// Parent refers to the parent workflow instance if this instance is a sub-workflow.
	Parent *WorkflowInstance `json:"parent,omitempty"`

	// ParentEventID is the ID of the event in the parent workflow that started this sub-workflow.
	ParentEventID int64 `json:"parent_event_id,omitempty"`
}

func NewSubWorkflowInstance

func NewSubWorkflowInstance(instanceID, executionID string, parentInstance *WorkflowInstance, parentEventID int64) *WorkflowInstance

func NewWorkflowInstance

func NewWorkflowInstance(instanceID, executionID string) *WorkflowInstance

func (*WorkflowInstance) SubWorkflow

func (wi *WorkflowInstance) SubWorkflow() bool

type WorkflowInstanceState

type WorkflowInstanceState int

const (
	WorkflowInstanceStateActive WorkflowInstanceState = iota
	WorkflowInstanceStateContinuedAsNew
	WorkflowInstanceStateFinished
)