DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
Provider
DurableWorkGetRequest
SourceRequests a privacy-bounded snapshot of one work aggregate in an already authorized scope.
ScopeId
WorkId
DurableWorkId WorkId { get; }
Source
Gets the opaque work identifier.
DurableWorkSnapshot
SourceReports authoritative work state without returning the original work payload or provider diagnostics.
Remarks
Registered names, versions, and terminal codes accept only ASCII letters, digits, hyphens, underscores, periods, and colons. Empty, whitespace-only, control-containing, and other-character values are rejected; a terminal code may instead be null.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the work aggregate identity.
ActivityId
string ActivityId { get; }
Source
Gets the immutable effect activity identity.
WorkName
string WorkName { get; }
Source
Gets the registered Work name, limited to 200 durable-identifier characters.
WorkVersion
string WorkVersion { get; }
Source
Gets the registered Work version, limited to 100 durable-identifier characters.
State
DurableWorkState State { get; }
Source
Gets the current authoritative state.
ProviderSafety
DurableProviderSafety ProviderSafety { get; }
Source
Gets the accepted provider ambiguity policy.
ProviderKey
string ProviderKey { get; }
Source
Gets the immutable provider-safe idempotency key.
AttemptNumber
int AttemptNumber { get; }
Source
Gets the number of claims that reached this aggregate.
Revision
long Revision { get; }
Source
Gets the optimistic-concurrency revision.
AcceptedAtUtc
DateTimeOffset AcceptedAtUtc { get; }
Source
Gets the authoritative store acceptance timestamp.
DueAtUtc
DateTimeOffset DueAtUtc { get; }
Source
Gets the current eligibility timestamp.
UpdatedAtUtc
DateTimeOffset UpdatedAtUtc { get; }
Source
Gets the most recent authoritative update timestamp.
TerminalAtUtc
DateTimeOffset? TerminalAtUtc { get; }
Source
Gets the terminal timestamp when terminal.
TerminalCode
string? TerminalCode { get; }
Source
Gets the safe terminal or suspension code, limited to 120 durable-identifier characters, when present.
Result
DurableEncodedPayload? Result { get; }
Source
Gets the encoded terminal business result when work succeeded.
Remarks
The original work payload and stale provider observations are intentionally not returned.
DurableWorkCancelRequest
SourceRequests an audited cancellation under optimistic concurrency.
Remarks
The application must authorize the actor and scope before calling this API. Actor and reason values must be privacy-safe identifiers, not free-form user content.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the work aggregate identity.
ActorId
string ActorId { get; }
Source
Gets the privacy-safe authorized actor identity written to history.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe reason code written to history.
ExpectedRevision
long ExpectedRevision { get; }
Source
Gets the required current revision.
DurableWorkCancelResult
SourceReports a successful work cancellation command.
Deconstruct
void Deconstruct(out DurableWorkId WorkId, out DurableWorkCancelOutcome Outcome, out DurableWorkState State, out long Revision)
Source
Deconstructs the result in its original positional-record field order.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the affected Work aggregate.
Outcome
DurableWorkCancelOutcome Outcome { get; }
Source
Gets the accepted cancellation outcome.
State
DurableWorkState State { get; }
Source
Gets the resulting authoritative Work state.
Revision
long Revision { get; }
Source
Gets the resulting aggregate revision.
DurableWorkListRequest
SourceRequests one bounded, ordered, payload-free page of Work operations in an authorized scope.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
State
DurableWorkState? State { get; }
Source
Gets the optional public Work state filter.
RequiresRecoveryReleaseOnly
bool RequiresRecoveryReleaseOnly { get; }
Source
Gets whether only nonterminal rows owned by an older runtime epoch should be returned.
PageSize
int PageSize { get; }
Source
Gets the maximum page size.
ContinuationToken
string? ContinuationToken { get; }
Source
Gets the prior page's opaque continuation token.
DurableWorkListItem
SourceReports one payload-free Work inventory item for recovery and operations.
Remarks
Registered names, versions, and terminal codes accept only ASCII letters, digits, hyphens, underscores, periods, and colons. Empty, whitespace-only, control-containing, and other-character values are rejected; a terminal code may instead be null.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the opaque Work identity.
ActivityId
string ActivityId { get; }
Source
Gets the immutable activity identity used for cross-surface correlation.
WorkName
string WorkName { get; }
Source
Gets the registered Work name, limited to 200 durable-identifier characters.
WorkVersion
string WorkVersion { get; }
Source
Gets the immutable Work version, limited to 100 durable-identifier characters.
State
DurableWorkState State { get; }
Source
Gets the public authoritative state.
ProviderSafety
DurableProviderSafety ProviderSafety { get; }
Source
Gets the immutable provider-safety class.
AttemptNumber
int AttemptNumber { get; }
Source
Gets the current attempt number.
Revision
long Revision { get; }
Source
Gets the current aggregate revision required by operator commands.
AcceptedAtUtc
DateTimeOffset AcceptedAtUtc { get; }
Source
Gets the authoritative store acceptance time.
DueAtUtc
DateTimeOffset DueAtUtc { get; }
Source
Gets the current eligibility time.
UpdatedAtUtc
DateTimeOffset UpdatedAtUtc { get; }
Source
Gets the last authoritative mutation time.
TerminalCode
string? TerminalCode { get; }
Source
Gets the safe terminal or suspension code, limited to 120 durable-identifier characters, when present.
CancellationRequested
bool CancellationRequested { get; }
Source
Gets whether cancellation intent has been recorded.
RequiresRecoveryRelease
bool RequiresRecoveryRelease { get; }
Source
Gets whether this nonterminal Work row belongs to an older runtime epoch.
DurableWorkListResult
SourceReports one bounded Work inventory page.
Items
IReadOnlyList<DurableWorkListItem> Items { get; }
Source
Gets the ordered payload-free items.
ContinuationToken
string? ContinuationToken { get; }
Source
Gets the opaque token for the next page, or null when complete.
IDurableWorkControlClient
SourceProvides application-authorized query and cancellation operations for work aggregates.
GetAsync
ValueTask<DurableOperationResult<DurableWorkSnapshot>> GetAsync(DurableWorkGetRequest request, CancellationToken cancellationToken = default)
Source
Reads one scoped work snapshot.
ListAsync
ValueTask<DurableOperationResult<DurableWorkListResult>> ListAsync(DurableWorkListRequest request, CancellationToken cancellationToken = default)
Source
Lists one bounded payload-free Work inventory page in an already authorized scope.
CancelAsync
ValueTask<DurableOperationResult<DurableWorkCancelResult>> CancelAsync(DurableWorkCancelRequest request, CancellationToken cancellationToken = default)
Source
Requests audited cancellation under optimistic concurrency.
DurableScopeDisableRequest
SourceRequests disabling an owning durable scope and fencing every prior scope generation.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
ActorId
string ActorId { get; }
Source
Gets the privacy-safe authorized actor identity.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe reason code.
ExpectedGeneration
long ExpectedGeneration { get; }
Source
Gets the required active generation.
DurableScopeDisableResult
SourceReports a successful scope disable command.
Deconstruct
void Deconstruct(out DurableScopeId ScopeId, out DurableScopeDisableOutcome Outcome, out long Generation)
Source
Deconstructs the result in its original positional-record field order.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the disabled owning scope.
Outcome
DurableScopeDisableOutcome Outcome { get; }
Source
Gets the accepted disable outcome.
Generation
long Generation { get; }
Source
Gets the resulting scope lifecycle generation.
IDurableScopeControlClient
SourceProvides application-authorized scope lifecycle fencing.
DisableAsync
ValueTask<DurableOperationResult<DurableScopeDisableResult>> DisableAsync(DurableScopeDisableRequest request, CancellationToken cancellationToken = default)
Source
Disables a scope and increments its generation atomically.
DurableWorkOperatorResult
SourceReports the authoritative result of a work operator command.
Deconstruct
void Deconstruct(out DurableWorkId WorkId, out DurableWorkOperatorOutcome Outcome, out DurableWorkState State, out long Revision)
Source
Deconstructs the result in its original positional-record field order.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the affected Work aggregate.
Outcome
DurableWorkOperatorOutcome Outcome { get; }
Source
Gets the idempotent operator-command outcome.
State
DurableWorkState State { get; }
Source
Gets the resulting authoritative Work state.
Revision
long Revision { get; }
Source
Gets the resulting aggregate revision.
DurableWorkReconcileRequest
SourceRequests side-effect-free reconciliation for suspended ReconcileBeforeRetry work.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the suspended work aggregate.
CommandId
DurableCommandId CommandId { get; }
Source
Gets the idempotent operator command identity.
ActorId
string ActorId { get; }
Source
Gets the authorized privacy-safe actor identity.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe reason code.
ExpectedRevision
long ExpectedRevision { get; }
Source
Gets the expected work revision.
Fingerprint
DurableCommandFingerprint Fingerprint { get; }
Source
Gets the computed semantic command fingerprint.
DurableWorkManualResolutionRequest
SourceRequests an audited resolution for ManualResolution work.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the suspended work aggregate.
CommandId
DurableCommandId CommandId { get; }
Source
Gets the idempotent operator command identity.
ActorId
string ActorId { get; }
Source
Gets the authorized privacy-safe actor identity.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe reason code.
ExpectedRevision
long ExpectedRevision { get; }
Source
Gets the expected work revision.
Resolution
DurableManualResolutionKind Resolution { get; }
Source
Gets the provider proof supplied by the operator.
Result
DurableEncodedPayload? Result { get; }
Source
Gets the exact registered result when the effect is proven applied.
Fingerprint
DurableCommandFingerprint Fingerprint { get; }
Source
Gets the computed semantic command fingerprint.
DurableWorkRetrySafeRequest
SourceRequests release of suspended work only when its effect policy proves a retry is safe.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the suspended work aggregate.
CommandId
DurableCommandId CommandId { get; }
Source
Gets the idempotent operator command identity.
ActorId
string ActorId { get; }
Source
Gets the authorized privacy-safe actor identity.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe reason code.
ExpectedRevision
long ExpectedRevision { get; }
Source
Gets the expected work revision.
Fingerprint
DurableCommandFingerprint Fingerprint { get; }
Source
Gets the computed semantic command fingerprint.
DurableWorkRecoveryReleaseRequest
SourceRequests release of nonterminal work fenced by a rotated restore epoch.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the old-epoch nonterminal work aggregate.
CommandId
DurableCommandId CommandId { get; }
Source
Gets the idempotent operator command identity.
ActorId
string ActorId { get; }
Source
Gets the authorized privacy-safe actor identity.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe reason code.
ExpectedRevision
long ExpectedRevision { get; }
Source
Gets the expected work revision.
Fingerprint
DurableCommandFingerprint Fingerprint { get; }
Source
Gets the computed semantic command fingerprint.
IDurableWorkOperatorClient
SourceProvides audited recovery operations for suspended durable work.
Remarks
Applications must authorize scope and actor before calling this surface. Reconciliation is a provider read and must never repeat the mutation. Manual resolution accepts only an exact registered result or proof of no effect. Safe retry and recovery release fail closed when a prior permit remains ambiguous.
ReconcileAsync
ValueTask<DurableOperationResult<DurableWorkOperatorResult>> ReconcileAsync(DurableWorkReconcileRequest request, CancellationToken cancellationToken = default)
Source
Runs the registered side-effect-free reconciler and commits its proof.
ResolveAsync
ValueTask<DurableOperationResult<DurableWorkOperatorResult>> ResolveAsync(DurableWorkManualResolutionRequest request, CancellationToken cancellationToken = default)
Source
Commits authorized applied or proven-not-applied provider truth for manual work or canceled replay-safe ambiguity.
Remarks
Idempotent and provider-keyed work is eligible only while suspended with an ambiguous permit and a preserved cancellation request. Applied proof becomes succeeded-after-cancel; proven-not-applied proof becomes canceled before effect. This lets an operator honor cancellation without authorizing replay.
RetrySafeAsync
ValueTask<DurableOperationResult<DurableWorkOperatorResult>> RetrySafeAsync(DurableWorkRetrySafeRequest request, CancellationToken cancellationToken = default)
Source
Releases suspended work only when replay is safe under its immutable provider policy.
Remarks
This audited command explicitly overrides and consumes a preserved cancellation request before making work eligible again. Use ResolveAsync instead when provider proof can honor cancellation without replay.
ReleaseAfterRecoveryAsync
ValueTask<DurableOperationResult<DurableWorkOperatorResult>> ReleaseAfterRecoveryAsync(DurableWorkRecoveryReleaseRequest request, CancellationToken cancellationToken = default)
Source
Re-fences old-epoch nonterminal work to the configured runtime epoch without erasing due time or effect evidence.
DurableWorkCancelOutcome
SourceIdentifies an accepted work cancellation outcome.
DurableScopeDisableOutcome
SourceIdentifies an accepted scope disable outcome.
DurableWorkOperatorOutcome
SourceIdentifies an idempotent operator mutation outcome.
DurableManualResolutionKind
SourceIdentifies the proof supplied by an authorized manual-resolution command.
ProviderCommandFingerprints
SourceCreates canonical versioned fingerprints for provider/operator mutation commands.
Create
DurableCommandFingerprint Create(string schemaId, DurableScopeId scopeId, DurableWorkId workId, string actorId, string reasonCode, long expectedRevision, DurableManualResolutionKind? resolution = null, DurableEncodedPayload? result = null)
Source
Hashes the ordered semantic fields of one Work operator command.
Parameters
schemaIdVersioned canonical encoding schema.scopeIdAuthorized scope identity.workIdTarget Work identity.actorIdAuthorized privacy-safe actor identity.reasonCodePrivacy-safe audit reason.expectedRevisionExpected aggregate revision.resolutionOptional manual-resolution outcome.resultRequired encoded result only for an applied manual resolution.
Returns
A canonical fingerprint for persisted replay/conflict comparison.
Remarks
Any change to field ordering or encoding requires a new schemaId.
DurableRuntimeHealthSnapshot
SourceReports compatibility, heartbeat, sweep, drain, and due-dispatch lag without exposing durable payloads.
Remarks
Worker ids and problem codes accept only ASCII letters, digits, hyphens, underscores, periods, and colons. Empty, whitespace-only, control-containing, and other-character values are rejected; a problem code may instead be null.
State
DurableRuntimeHealthState State { get; }
Source
Gets the overall liveness verdict.
ProblemCode
string? ProblemCode { get; }
Source
Gets the stable diagnostic code, limited to 120 durable-identifier characters, for a non-healthy verdict.
SchemaCompatible
bool SchemaCompatible { get; }
Source
Gets whether installed reader and writer ranges include this package.
EpochCompatible
bool EpochCompatible { get; }
Source
Gets whether the configured out-of-band runtime epoch matches the store.
InstalledSchemaVersion
int InstalledSchemaVersion { get; }
Source
Gets the highest installed schema migration.
RequiredSchemaVersion
int RequiredSchemaVersion { get; }
Source
Gets the schema migration required by this package.
ConfiguredRuntimeEpoch
Guid ConfiguredRuntimeEpoch { get; }
Source
Gets the process-configured out-of-band recovery epoch.
ActiveRuntimeEpoch
Guid? ActiveRuntimeEpoch { get; }
Source
Gets the store-wide active recovery epoch, when readable.
WorkerId
string WorkerId { get; }
Source
Gets the privacy-safe configured worker identity, limited to 200 durable-identifier characters.
WorkerInstanceId
Guid? WorkerInstanceId { get; }
Source
Gets the process-instance correlation id currently owning the worker identity.
HostedSurfaces
DurableRuntimeSurface HostedSurfaces { get; }
Source
Gets the surfaces this worker is configured to pump.
ObservedAtUtc
DateTimeOffset ObservedAtUtc { get; }
Source
Gets the authoritative store observation time.
StartedAtUtc
DateTimeOffset? StartedAtUtc { get; }
Source
Gets when the current worker instance first registered.
LastHeartbeatAtUtc
DateTimeOffset? LastHeartbeatAtUtc { get; }
Source
Gets the most recent attempted pump heartbeat.
LastSuccessfulSweepAtUtc
DateTimeOffset? LastSuccessfulSweepAtUtc { get; }
Source
Gets the most recent successfully completed bounded sweep.
IsDraining
bool IsDraining { get; }
Source
Gets whether this worker is refusing new passes while already-started operations drain.
IsPassActive
bool IsPassActive { get; }
Source
Gets whether this worker instance has an in-flight bounded pump pass.
DueDispatchCount
long DueDispatchCount { get; }
Source
Gets the number of selected-surface dispatch rows currently overdue and available or reclaimable.
OldestDueAtUtc
DateTimeOffset? OldestDueAtUtc { get; }
Source
Gets the oldest selected-surface available or reclaimable dispatch instant.
OldestDueAge
TimeSpan? OldestDueAge { get; }
Source
Gets the authoritative-store-observed age of the oldest overdue dispatch.
IDurableRuntimeHealth
SourceReads the configured worker's provider-backed compatibility and liveness snapshot.
Remarks
This API is safe to expose through an application-owned health endpoint. It contains no payloads or scope and aggregate identifiers. Applications should alert on DurableRuntimeHealthState.Stale, an incompatible schema or epoch, and oldest-due age outside their own service objective.
GetAsync
ValueTask<DurableRuntimeHealthSnapshot> GetAsync(CancellationToken cancellationToken = default)
Source
Reads one non-mutating health snapshot.
IDurableRuntimeDrainControl
SourceControls process-local graceful drain for the configured worker identity.
Remarks
Beginning drain prevents future pump passes from claiming new aggregates. It does not revoke an effect permit, cancel provider I/O already in progress, or wait for the caller's currently running pass. The host must wait for its in-flight pass to return before shutting down. Resume is intended for a canceled deployment rollback, not for bypassing a restore or compatibility fence.
BeginDrainAsync
ValueTask BeginDrainAsync(CancellationToken cancellationToken = default)
Source
Marks the current worker instance as draining and refuses subsequent pump passes.
ResumeAsync
ValueTask ResumeAsync(CancellationToken cancellationToken = default)
Source
Clears process-local drain after compatibility and recovery preconditions remain satisfied.
DurableRuntimeHealthState
SourceDescribes the safe, low-cardinality liveness state of one configured durable runtime worker.
DurableRuntimePumpRequest
SourceBounds one runtime pump pass for hosted and externally activated execution.
MaximumItems
int MaximumItems { get; }
Source
Gets the total item bound.
TimeBudget
TimeSpan TimeBudget { get; }
Source
Gets the wall-clock budget for discovering and beginning additional items.
Remarks
An already-started provider call or authoritative-store transaction may finish past this budget. The runtime does not manufacture an ambiguous external outcome merely to enforce a hard stopwatch deadline.
Surfaces
DurableRuntimeSurface Surfaces { get; }
Source
Gets the selected durable surfaces.
DurableRuntimePumpResult
SourceSummarizes one bounded runtime pump pass without high-cardinality identifiers.
Discovered
int Discovered { get; }
Source
Gets discovered candidate count.
Claimed
int Claimed { get; }
Source
Gets successfully claimed count.
Processed
int Processed { get; }
Source
Gets successfully processed count.
Deferred
int Deferred { get; }
Source
Gets policy-deferred count.
Failed
int Failed { get; }
Source
Gets safely failed or suspended count.
HasMore
bool HasMore { get; }
Source
Gets whether immediately eligible work may remain.
NextDueAtUtc
DateTimeOffset? NextDueAtUtc { get; }
Source
Gets the earliest known future due time.
Elapsed
TimeSpan Elapsed { get; }
Source
Gets elapsed duration of the bounded pass.
IDurableRuntimePump
SourceExecutes one bounded pass of the authoritative durable runtime.
Remarks
Hosted loops and external activators must call this same primitive. A notification, queue, or HTTP wake-up may accelerate a pass but cannot become a correctness dependency.
RunOnceAsync
ValueTask<DurableRuntimePumpResult> RunOnceAsync(DurableRuntimePumpRequest request, CancellationToken cancellationToken = default)
Source
Executes one bounded processing pass.
DurableRuntimeSurface
SourceSelects which durable surfaces a bounded pump pass may process.
ProviderContractValidation
SourceValidates provider-facing identifiers at the contract boundary.
Require
4 overloads
void Require(DurableScopeId value, string parameterName)
Source
Requires a non-default scope identifier.
Parameters
valueScope identifier to validate.parameterNameParameter name used by validation exceptions.
Exceptions
ArgumentExceptionThrown when the identifier is default or invalid.
void Require(DurableWorkId value, string parameterName)
Source
Requires a non-default work identifier.
Parameters
valueWork identifier to validate.parameterNameParameter name used by validation exceptions.
Exceptions
ArgumentExceptionThrown when the identifier is default or invalid.
void Require(DurableCommandId value, string parameterName)
Source
Requires a non-default command identifier.
Parameters
valueCommand identifier to validate.parameterNameParameter name used by validation exceptions.
Exceptions
ArgumentExceptionThrown when the identifier is default or invalid.
string Require(string value, string parameterName, int maximumLength)
Source
Requires bounded portable identifier text.
Parameters
valueIdentifier text to validate.parameterNameParameter name used by validation exceptions.maximumLengthMaximum accepted character count.
Returns
The original validated value.
Exceptions
ArgumentExceptionThrown when the value is blank, too long, or contains another character.
Remarks
Accepted characters are ASCII letters, digits, hyphens, underscores, periods, and colons.
DurableRetentionManifestId
SourceIdentifies one immutable, one-Flow retention manifest.
New
DurableRetentionManifestId New()
Source
Creates a cryptographically random manifest identifier.
Value
string Value { get; }
Source
Gets the opaque manifest identifier.
DurableRetentionDigest
SourceIdentifies the versioned canonical bytes represented by a SHA-256 digest.
Remarks
This value identifies source correspondence only. It never claims that an application-owned external archive is durable, available, encrypted, or legally sufficient.
SchemaId
string SchemaId { get; }
Source
Gets the versioned canonicalization schema.
Sha256
string Sha256 { get; }
Source
Gets the lowercase SHA-256 digest.
DurableRetentionAssessmentRequest
SourceRequests a bounded, non-mutating assessment of one Flow retention closure.
Remarks
Assessment never archives, changes state, or deletes. It applies no universal age threshold: applications own the policy that decides which terminal Flow to assess.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the application-authorized owner scope.
FlowInstanceId
DurableFlowInstanceId FlowInstanceId { get; }
Source
Gets the one Flow candidate.
MaximumClosureItems
int MaximumClosureItems { get; }
Source
Gets the maximum inventory count, from one through 10,000.
MaximumArchiveBytes
int MaximumArchiveBytes { get; }
Source
Gets the maximum canonical archive size, from one byte through 64 MiB.
DurableRetentionAssessment
SourceReports a bounded Flow retention decision and its reproducible source facts.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the assessed scope.
FlowInstanceId
DurableFlowInstanceId FlowInstanceId { get; }
Source
Gets the assessed Flow.
Status
DurableRetentionAssessmentStatus Status { get; }
Source
Gets whether the provider proved safety, found a blocker, or could not prove the closure.
Reason
DurableRetentionAssessmentReason Reason { get; }
Source
Gets the privacy-safe deterministic explanation.
ClosureDigest
DurableRetentionDigest? ClosureDigest { get; }
Source
Gets the canonical closure digest when the source could be inventoried.
SourceWatermark
DurableRetentionDigest? SourceWatermark { get; }
Source
Gets the current source watermark when the source could be inventoried.
ClosureItemCount
int ClosureItemCount { get; }
Source
Gets the canonical inventory item count.
ArchiveByteCount
long ArchiveByteCount { get; }
Source
Gets the exact canonical archive byte count when available.
DurableRetentionManifest
SourceReports immutable manifest facts together with its current lifecycle projection.
ManifestId
DurableRetentionManifestId ManifestId { get; }
Source
Gets the immutable manifest identity.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the owning scope.
FlowInstanceId
DurableFlowInstanceId FlowInstanceId { get; }
Source
Gets the single Flow selected by this manifest.
ClosureDigest
DurableRetentionDigest ClosureDigest { get; }
Source
Gets the immutable canonical closure digest.
SourceWatermark
DurableRetentionDigest SourceWatermark { get; }
Source
Gets the immutable source watermark recorded when the manifest was created.
ClosureItemCount
int ClosureItemCount { get; }
Source
Gets the frozen inventory count.
ArchiveByteCount
long ArchiveByteCount { get; }
Source
Gets the frozen canonical archive size.
State
DurableRetentionManifestState State { get; }
Source
Gets the current event-derived lifecycle state.
LifecycleSequence
long LifecycleSequence { get; }
Source
Gets the compare-and-swap sequence for the projected lifecycle state.
CreatedAtUtc
DateTimeOffset CreatedAtUtc { get; }
Source
Gets when immutable manifest facts were recorded.
DurableRetentionManifestCreateRequest
SourceRequests creation of an immutable manifest from a successful bounded assessment.
CommandId
DurableCommandId CommandId { get; }
Source
Gets the idempotent command identity.
Assessment
DurableRetentionAssessment Assessment { get; }
Source
Gets the successful assessment whose source facts must still match.
Fingerprint
DurableCommandFingerprint Fingerprint { get; }
Source
Gets the versioned semantic command fingerprint.
DurableRetentionManifestCreateResult
SourceReports an immutable-manifest creation result.
Outcome
DurableRetentionManifestCreateOutcome Outcome { get; }
Source
Gets whether this command created or replayed the manifest.
Manifest
DurableRetentionManifest Manifest { get; }
Source
Gets the immutable manifest and its current projection.
DurableArchiveReceiptV1
SourceRepresents a content-addressed adopter assertion about a durable-flow archive package.
ReceiptId
string ReceiptId { get; }
Source
Gets the adopter-owned opaque receipt identity; it is not a URI or external-storage claim.
PackageDigest
DurableRetentionDigest PackageDigest { get; }
Source
Gets the DFA1 package digest claimed by the archive writer.
ClosureDigest
DurableRetentionDigest ClosureDigest { get; }
Source
Gets the frozen closure digest named by the receipt.
RecordCount
int RecordCount { get; }
Source
Gets the canonical package record count.
DurableArchivePackageV1
SourceReturns a reproducible DFA1 archive package without writing to external storage.
Manifest
DurableRetentionManifest Manifest { get; }
Source
Gets the manifest whose exact source facts the package represents.
Bytes
ReadOnlyMemory<byte> Bytes { get; }
Source
Gets the reproducible package bytes. The caller writes these bytes to application-owned storage.
PackageDigest
DurableRetentionDigest PackageDigest { get; }
Source
Gets the package's canonical SHA-256 digest.
RecordCount
int RecordCount { get; }
Source
Gets the manifest-ordered record count.
DurableRetentionMutationResult
SourceReports a successful lifecycle command.
ManifestId
DurableRetentionManifestId ManifestId { get; }
Source
Gets the affected manifest.
Outcome
DurableRetentionMutationOutcome Outcome { get; }
Source
Gets whether the mutation was applied, duplicated, or found after purge.
State
DurableRetentionManifestState State { get; }
Source
Gets the projected lifecycle state after the command.
LifecycleSequence
long LifecycleSequence { get; }
Source
Gets the projected lifecycle sequence after the command.
DurableRetentionMutationRequest
SourceRequests one idempotent, compare-and-swap retention lifecycle mutation.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the application-authorized scope.
ManifestId
DurableRetentionManifestId ManifestId { get; }
Source
Gets the exact target manifest.
CommandId
DurableCommandId CommandId { get; }
Source
Gets the idempotent command identity.
ActorId
string ActorId { get; }
Source
Gets the privacy-safe authorized actor identity.
ReasonCode
string ReasonCode { get; }
Source
Gets the privacy-safe audit reason.
ExpectedLifecycleSequence
long ExpectedLifecycleSequence { get; }
Source
Gets the required current lifecycle sequence.
Fingerprint
DurableCommandFingerprint Fingerprint { get; }
Source
Gets the versioned semantic fingerprint.
DurableRetentionRecordArchiveReceiptRequest
SourceRecords an adopter assertion that it stored one DFA1 package externally.
Receipt
DurableArchiveReceiptV1 Receipt { get; }
Source
Gets the opaque external-archive assertion to record.
DurableRetentionVerifyArchiveRequest
SourceRequests source-correspondence verification for a recorded archive receipt.
DurableRetentionHoldRequest
SourceRequests an explicit hold placement or release on a verified retention manifest.
PlaceHold
bool PlaceHold { get; }
Source
Gets whether this command places rather than releases the hold.
DurableRetentionPurgeRequest
SourceRequests the separately authorized, irreversible purge of a verified and unheld manifest.
IDurableFlowRetentionClient
SourceProvides application-authorized verified retention lifecycle operations for one Flow at a time.
Remarks
The application owns authorization, retention cadence, external archive transport, encryption, availability, and compliance. This API never accepts a date-range delete, archive URI, arbitrary SQL, continuation token, or a multi-Flow manifest. Verification proves only that the claimed package corresponds to the frozen source set.
AssessAsync
ValueTask<DurableOperationResult<DurableRetentionAssessment>> AssessAsync(DurableRetentionAssessmentRequest request, CancellationToken cancellationToken = default)
Source
Assesses one bounded Flow closure without mutating source rows.
CreateManifestAsync
ValueTask<DurableOperationResult<DurableRetentionManifestCreateResult>> CreateManifestAsync(DurableRetentionManifestCreateRequest request, CancellationToken cancellationToken = default)
Source
Freezes a still-matching successful assessment as an immutable manifest.
GetManifestAsync
ValueTask<DurableOperationResult<DurableRetentionManifest>> GetManifestAsync(DurableScopeId scopeId, DurableRetentionManifestId manifestId, CancellationToken cancellationToken = default)
Source
Reads one scope-isolated manifest lifecycle projection.
BuildArchivePackageAsync
ValueTask<DurableOperationResult<DurableArchivePackageV1>> BuildArchivePackageAsync(DurableScopeId scopeId, DurableRetentionManifestId manifestId, CancellationToken cancellationToken = default)
Source
Builds a reproducible package from a still-matching immutable manifest without external I/O.
RecordArchiveReceiptAsync
ValueTask<DurableOperationResult<DurableRetentionMutationResult>> RecordArchiveReceiptAsync(DurableRetentionRecordArchiveReceiptRequest request, CancellationToken cancellationToken = default)
Source
Records an adopter-provided archive receipt; this does not verify external storage.
VerifyArchiveAsync
ValueTask<DurableOperationResult<DurableRetentionMutationResult>> VerifyArchiveAsync(DurableRetentionVerifyArchiveRequest request, CancellationToken cancellationToken = default)
Source
Rebuilds the source package and verifies source correspondence with the receipt.
SetHoldAsync
ValueTask<DurableOperationResult<DurableRetentionMutationResult>> SetHoldAsync(DurableRetentionHoldRequest request, CancellationToken cancellationToken = default)
Source
Places or releases an application-owned hold on a verified manifest.
PurgeAsync
ValueTask<DurableOperationResult<DurableRetentionMutationResult>> PurgeAsync(DurableRetentionPurgeRequest request, CancellationToken cancellationToken = default)
Source
Atomically records separate purge authorization and deletes only verified manifest-covered source rows.
DurableRetentionAssessmentStatus
SourceClassifies the safety of removing one exact Flow history source set.
DurableRetentionAssessmentReason
SourceProvides a privacy-safe, deterministic reason for a retention assessment.
DurableRetentionManifestState
SourceRepresents the append-only lifecycle state projected for a frozen retention manifest.
DurableRetentionManifestCreateOutcome
SourceIdentifies an idempotent manifest-create result.
DurableRetentionMutationOutcome
SourceIdentifies an idempotent lifecycle mutation result.
DurableClaimedWork
SourceCarries one provider claim across the storage-to-executor boundary.
Remarks
Providers create this only after a scoped, fenced claim succeeds. The claim is not authorization by itself; the provider must record the matching effect permit before invoking prepared work.
ToExecutionContext
DurableWorkExecutionContext ToExecutionContext()
Source
Creates the validated application execution context for this provider claim.
ScopeId
DurableScopeId ScopeId { get; }
Source
Gets the trusted owning scope.
WorkId
DurableWorkId WorkId { get; }
Source
Gets the immutable work aggregate identifier.
ActivityId
string ActivityId { get; }
Source
Gets the immutable provider-operation activity identifier.
WorkName
string WorkName { get; }
Source
Gets the registered work name.
WorkVersion
string WorkVersion { get; }
Source
Gets the registered work version.
Payload
DurableEncodedPayload Payload { get; }
Source
Gets the encoded work payload.
ProviderSafety
DurableProviderSafety ProviderSafety { get; }
Source
Gets the provider ambiguity policy snapshot.
AttemptNumber
int AttemptNumber { get; }
Source
Gets the monotonically increasing attempt number.
LeaseGeneration
long LeaseGeneration { get; }
Source
Gets the claim lease generation.
ScopeGeneration
long ScopeGeneration { get; }
Source
Gets the owning scope lifecycle generation.
RuntimeEpoch
string RuntimeEpoch { get; }
Source
Gets the out-of-band recovery epoch.
DurablePreparedWorkInvocation
SourceWraps already prepared application work for invocation after the provider commits its effect permit.
InvokeAsync
ValueTask<DurableEncodedPayload> InvokeAsync(CancellationToken cancellationToken = default)
Source
Invokes the prepared application executor and returns its encoded terminal result.
DurableProviderWorkAdapter
SourceAdapts validated provider claims to adopter-owned work registrations.
Prepare
DurablePreparedWorkInvocation Prepare(DurableWorkRegistration registration, IServiceProvider services, DurableClaimedWork claim)
Source
Prepares an application executor without performing provider I/O.
ReconcileAsync
ValueTask<DurableEncodedEffectReconciliation> ReconcileAsync(DurableWorkRegistration registration, IServiceProvider services, DurableClaimedWork claim, CancellationToken cancellationToken = default)
Source
Runs the adopter-owned side-effect-free reconciler for a validated provider claim.