eventkeys

package

v0.105.20-alpha.0 Latest Latest Go to latest Published: Sep 1, 2026 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hatchet-dev/hatchet

Links

Documentation ¶

Index ¶

Constants
Variables
func IsKnown(key EventKey) bool
func Names(keys []EventKey) []string
func WorkflowStandardName(i int) string
type EventKey
- func ByName(name string) (EventKey, bool)
- func (k EventKey) Name() string
- func (k EventKey) String() string

Constants ¶

View Source

const (
	WorkerName = workflowNamePrefix + "worker"

	WorkflowBatchName        = workflowNamePrefix + "batch"
	WorkflowDurableName      = workflowNamePrefix + "durable"
	WorkflowDurableChildName = workflowNamePrefix + "durable-child"
	WorkflowDagName          = workflowNamePrefix + "dag"

	// The EventKeyDagShapes workflows. Each is a standalone DAG with a distinct
	// topology; all four are triggered by a single EventKeyDagShapes event.
	WorkflowDagShapeDenseFaninName  = workflowNamePrefix + "dag-shape-dense-fanin"
	WorkflowDagShapeConditionalName = workflowNamePrefix + "dag-shape-conditional"
	WorkflowDagShapeOnFailureName   = workflowNamePrefix + "dag-shape-onfailure"
	WorkflowDagShapeDeepRetryName   = workflowNamePrefix + "dag-shape-deep-retry"

	// The EventKeyDagNested workflows. The parent is event-triggered; its
	// fan-out task spawns runs of the child, which is not event-triggered.
	WorkflowDagShapeNestedParentName = workflowNamePrefix + "dag-shape-nested-parent"
	WorkflowDagShapeNestedChildName  = workflowNamePrefix + "dag-shape-nested-child"
)

Variables ¶

View Source

var All = []EventKey{EventKeyDefault, EventKeyBatch, EventKeyDurable, EventKeyDag, EventKeyDagShapes, EventKeyDagNested}

View Source

var DagNestedWorkflowNames = []string{
	WorkflowDagShapeNestedParentName,
	WorkflowDagShapeNestedChildName,
}

DagNestedWorkflowNames is the parent + child pair for the nested-DAG scenario.

View Source

var DagShapeWorkflowNames = []string{
	WorkflowDagShapeDenseFaninName,
	WorkflowDagShapeConditionalName,
	WorkflowDagShapeOnFailureName,
	WorkflowDagShapeDeepRetryName,
}

DagShapeWorkflowNames is the ordered set of workflows triggered by EventKeyDagShapes.

Functions ¶

func IsKnown ¶

func IsKnown(key EventKey) bool

func Names ¶

func Names(keys []EventKey) []string

func WorkflowStandardName ¶

func WorkflowStandardName(i int) string

Types ¶

type EventKey ¶

type EventKey string

const (
	EventKeyDefault EventKey = "load-test:event"
	EventKeyBatch   EventKey = "load-test:batch-event"
	EventKeyDurable EventKey = "load-test:durable-event"
	EventKeyDag     EventKey = "load-test:dag-event"
	// EventKeyDagShapes triggers the DagShapeWorkflowNames set - a handful of
	// multi-step DAGs whose topologies (dense fan-in, conditional skip fan-out,
	// on-failure handler, deep retry chain) are modelled on real production
	// workloads, for exercising the DAG operator.
	EventKeyDagShapes EventKey = "load-test:dag-shapes-event"
	// EventKeyDagNested triggers the nested-DAG scenario: a parent DAG whose
	// fan-out task spawns N child DAG runs and waits for them (see
	// DagNestedWorkflowNames).
	EventKeyDagNested EventKey = "load-test:dag-nested-event"
)

func ByName ¶

func ByName(name string) (EventKey, bool)

func (EventKey) Name ¶

func (k EventKey) Name() string

func (EventKey) String ¶

func (k EventKey) String() string

Source Files ¶

View all Source files

eventkeys.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL