DeadLetterRecord
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:28
A single dead-letter record for a pipeline request that failed (after any retries) and was forwarded to a DeadLetterTransport for inspection / replay.
The shape is transport-neutral, but payload and metadata are supplied by
the application and must satisfy the configured transport’s serialization
requirements.
Properties
Section titled “Properties”attempts
Section titled “attempts”attempts:
number
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:53
Redrive attempts made so far; 0 when captured.
correlationId
Section titled “correlationId”correlationId:
string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:35
Correlation ID of the failed pipeline run (for cross-system tracing).
error:
DeadLetterError
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:47
Details of the error that caused the failure.
failedAt
Section titled “failedAt”failedAt:
string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:49
ISO-8601 timestamp of when the dead letter was produced.
handlerName
Section titled “handlerName”handlerName:
string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:43
Handler class name, e.g. CreateUserHandler.
id:
string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:33
Unique id of this dead letter (UUIDv7, so ids sort in capture order), used to redrive or resolve it.
lastError?
Section titled “lastError?”
optionallastError?:DeadLetterError
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:62
Error of the last failed redrive attempt, if any.
metadata?
Section titled “metadata?”
optionalmetadata?:Record<string,unknown>
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:51
Metadata from the metadata factory, plus tenantId when present.
payload
Section titled “payload”payload:
unknown
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:45
The original request payload (the command/query/event instance).
payloadRedacted
Section titled “payloadRedacted”payloadRedacted:
boolean
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:60
true when redaction changed the payload (or a custom redact ran): the
stored payload is not the original request, so it is not redriven as is.
requestKind
Section titled “requestKind”requestKind:
DeadLetterRequestKind
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:39
Whether the failed request was a command, query, event, or unknown.
requestName
Section titled “requestName”requestName:
string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:41
Request class name, e.g. CreateUserCommand.
resolvedAt?
Section titled “resolvedAt?”
optionalresolvedAt?:string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:64
ISO-8601 timestamp of when the record was resolved.
status
Section titled “status”status:
DeadLetterStatus
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:55
'open' until a redrive succeeds or it is resolved by hand.
tenantId?
Section titled “tenantId?”
optionaltenantId?:string
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:37
Active tenant identifier if execution occurred within a multi-tenant context.