Skip to main content

Module contract

Module contract 

Source
Expand description

Stable contracts for durable workflow execution.

These types describe immutable definitions, accepted source facts and external effects. Products provide capabilities; the workflow kernel owns lifecycle, fencing and persistence semantics.

Structs§

ActionIntent
Durable intent to perform one external effect, created inside a fenced transition.
ActionObservation
Observed state of a dispatched action.
ActionReceipt
Provider’s answer to a dispatch.
CapabilityManifest
Immutable contract of a trigger, expression, guard, action or sink.
CapabilityPin
Exact capability identity: id, contract version and content digest.
ControlCommand
Operator command that bumps a control epoch.
ControlEpochs
Control epochs an intent was created under; any bump makes it stale.
DecisionArtifact
Persisted Agent decision reused after recovery instead of re-asking the model.
DecisionSnapshot
Everything a decision depended on, for replay and audit.
DiagnosticRecord
Operator-facing diagnostic attached to an instance.
ExecutionProfileRevision
Immutable execution profile: mode, durability grade and provider bindings an instance pins.
ExecutionProjection
Rebuildable read model of an instance; never authorizes or schedules work.
LifecyclePolicy
Start, completion, timeout and expiry rules evaluated on database time.
MissingRequirements
Parameters that block a live run.
ObservedValue
A value with provenance and freshness metadata.
ParameterSpec
Declared parameter and its live-mode requirements.
ParameterValue
A parameter with its provenance.
ResourceReservation
Mirror of a product-owned fenced reservation.
ResourceReservationRef
Reference to a product-owned fenced reservation.
RetryPolicy
Automatic retry policy of a capability.
RootOperationBudget
Budget reserved atomically before a root operation starts children.
SchedulePolicy
Cadence, timezone and catch-up behavior of a schedule.
SourceGap
A missing source-sequence range that blocks ordered delivery for an aggregate.
StepOutcome
Recorded outcome of one step.
TriggerBinding
Subscription of an instance to a source event type, with a JSON-containment predicate.
TriggerEnvelope
Immutable source event as delivered by a trigger adapter.
WorkflowDefinition
Named workflow whose revisions are immutable.
WorkflowEvent
Authoritative, append-only fact recorded by a committed transition.
WorkflowInstance
One durable instance pinned to a revision and execution profile for its lifetime.
WorkflowRevision
Immutable, digest-locked revision of a workflow spec with its pinned capabilities.

Enums§

ActionState
Lifecycle of an action intent; dispatch_committed is the point of no return.
CapabilityKind
Role a capability plays in a graph.
CapabilityLifecycle
Deployment state of a capability provider.
CatchUpPolicy
How missed schedule windows are handled.
CompletionPolicy
When an instance completes on its own.
ContractError
A contract value violates its invariants.
ControlMode
Operating mode set by a control command.
ControlScope
Scope of a control command.
DurabilityGrade
Durability the deployment must provide for an execution profile.
Effect
Side-effect class of a capability.
ExecutionMode
Where an execution profile is allowed to act.
ExpiryPolicy
What happens when a lifecycle deadline passes.
GuardKind
Role a guard plays on an action’s dominating path.
IdempotencyMode
Whether repeating a dispatch is safe.
OrderingPolicy
How a binding treats source sequence order.
ParameterProvenance
Who supplied a parameter value.
ReservationScope
Scope of a resource reservation.
ReservationState
Lifecycle of a reservation.
ScheduleCadence
How a schedule fires.
StepOutcomeKind
How a step ended.

Functions§

validate_parameters
Check supplied parameters against their specs for mode.