Struct KeyDestructionOutcome
- Namespace
- Excalibur.Compliance
- Assembly
- Excalibur.Compliance.Abstractions.dll
The result of a key-destruction request: its State and, when known, the instant at which the key material is (or becomes) irrecoverable.
public readonly record struct KeyDestructionOutcome : IEquatable<KeyDestructionOutcome>
- Implements
- Inherited Members
Constructors
KeyDestructionOutcome(KeyDestructionState, DateTimeOffset?)
The result of a key-destruction request: its State and, when known, the instant at which the key material is (or becomes) irrecoverable.
public KeyDestructionOutcome(KeyDestructionState State, DateTimeOffset? IrreversibleAt)
Parameters
StateKeyDestructionStateThe destruction state.
IrreversibleAtDateTimeOffset?The UTC instant at which the key material is irrecoverable: the call time for Completed, the end of the retention window for ScheduledIrreversible, and null for NotFound.
Properties
IrreversibleAt
The UTC instant at which the key material is irrecoverable: the call time for Completed, the end of the retention window for ScheduledIrreversible, and null for NotFound.
public DateTimeOffset? IrreversibleAt { get; init; }
Property Value
IsIrreversibleNow
public bool IsIrreversibleNow { get; }
Property Value
NotFound
Gets the idempotent no-op outcome for a key that did not exist.
public static KeyDestructionOutcome NotFound { get; }
Property Value
State
The destruction state.
public KeyDestructionState State { get; init; }
Property Value
Methods
CompletedAt(DateTimeOffset)
Creates a Completed outcome irrecoverable as of at.
public static KeyDestructionOutcome CompletedAt(DateTimeOffset at)
Parameters
atDateTimeOffsetThe UTC instant at which the key material became irrecoverable.
Returns
ScheduledAt(DateTimeOffset)
Creates a ScheduledIrreversible outcome irrecoverable at irreversibleAt.
public static KeyDestructionOutcome ScheduledAt(DateTimeOffset irreversibleAt)
Parameters
irreversibleAtDateTimeOffsetThe UTC instant at which the scheduled key material becomes irrecoverable.