Interface: CreateAnnotationInput
Defined in: packages/workflow-engine/src/persistence/interface.ts:482
Input for appending an annotation. attempt defaults to 0; callers from
job-execute.ts / stage-poll-suspended.ts are responsible for computing
the correct attempt value (incremented when a stage is rerun).
When idempotencyKey is set, the unique constraint on
(workflowRunId, key, idempotencyKey) ensures duplicates are skipped on
retry. When idempotencyKey is null, the constraint does not apply.
Properties
actor?
optionalactor?:AnnotationActor
Defined in: packages/workflow-engine/src/persistence/interface.ts:488
attempt?
optionalattempt?:number
Defined in: packages/workflow-engine/src/persistence/interface.ts:485
emitEvent?
optionalemitEvent?:boolean
Defined in: packages/workflow-engine/src/persistence/interface.ts:500
If true, the engine emits an annotation:created outbox event when
this row is persisted. Plumbed through the buffered-flush path so
the event lands in the same transaction as the annotation row.
Off by default — most provenance is read-only and doesn't need to
be a real-time event.
idempotencyKey?
optionalidempotencyKey?:string|null
Defined in: packages/workflow-engine/src/persistence/interface.ts:492
key
key:
string
Defined in: packages/workflow-engine/src/persistence/interface.ts:489
payload?
optionalpayload?:unknown
Defined in: packages/workflow-engine/src/persistence/interface.ts:491
scope
scope:
AnnotationScope
Defined in: packages/workflow-engine/src/persistence/interface.ts:486
scopeId?
optionalscopeId?:string|null
Defined in: packages/workflow-engine/src/persistence/interface.ts:487
value
value:
unknown
Defined in: packages/workflow-engine/src/persistence/interface.ts:490
workflowRunId
workflowRunId:
string
Defined in: packages/workflow-engine/src/persistence/interface.ts:483
workflowStageRecordId?
optionalworkflowStageRecordId?:string|null
Defined in: packages/workflow-engine/src/persistence/interface.ts:484