Table of Contents

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

State KeyDestructionState

The destruction state.

IrreversibleAt DateTimeOffset?

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

DateTimeOffset?

IsIrreversibleNow

Gets a value indicating whether the key material is irrecoverable now (i.e. State is Completed).

public bool IsIrreversibleNow { get; }

Property Value

bool

NotFound

Gets the idempotent no-op outcome for a key that did not exist.

public static KeyDestructionOutcome NotFound { get; }

Property Value

KeyDestructionOutcome

State

The destruction state.

public KeyDestructionState State { get; init; }

Property Value

KeyDestructionState

Methods

CompletedAt(DateTimeOffset)

Creates a Completed outcome irrecoverable as of at.

public static KeyDestructionOutcome CompletedAt(DateTimeOffset at)

Parameters

at DateTimeOffset

The UTC instant at which the key material became irrecoverable.

Returns

KeyDestructionOutcome

ScheduledAt(DateTimeOffset)

Creates a ScheduledIrreversible outcome irrecoverable at irreversibleAt.

public static KeyDestructionOutcome ScheduledAt(DateTimeOffset irreversibleAt)

Parameters

irreversibleAt DateTimeOffset

The UTC instant at which the scheduled key material becomes irrecoverable.

Returns

KeyDestructionOutcome