Table of Contents

Class CascadeErasureResult

Namespace
Excalibur.Compliance
Assembly
Excalibur.Compliance.Abstractions.dll

Result of a cascade erasure operation.

public sealed record CascadeErasureResult : IEquatable<CascadeErasureResult>
Inheritance
CascadeErasureResult
Implements
Inherited Members

Properties

BlockedSubjects

Gets the identifiers of subjects whose erasure was blocked (e.g. by a legal hold) and therefore not performed. A non-empty list forces Success to false.

public IReadOnlyList<string> BlockedSubjects { get; init; }

Property Value

IReadOnlyList<string>

ErrorMessage

Gets the error message if the operation failed.

public string? ErrorMessage { get; init; }

Property Value

string

FailedSubjects

Gets the identifiers of subjects whose erasure failed or was cancelled without completing. A non-empty list forces Success to false.

public IReadOnlyList<string> FailedSubjects { get; init; }

Property Value

IReadOnlyList<string>

IsDryRun

Gets a value indicating whether this was a dry run.

public bool IsDryRun { get; init; }

Property Value

bool

PrimarySubjectId

Gets the primary subject identifier that was erased.

public required string PrimarySubjectId { get; init; }

Property Value

string

RelatedSubjectsErased

Gets the identifiers of related subjects whose erasure was accepted (erased or scheduled). Subjects that were blocked or failed are reported in BlockedSubjects and FailedSubjects instead.

public IReadOnlyList<string> RelatedSubjectsErased { get; init; }

Property Value

IReadOnlyList<string>

SubjectsErased

Gets the number of subjects (including primary) whose erasure completed synchronously (status Completed or PartiallyCompleted). Erasure typically executes asynchronously via the scheduler, so this is often zero — see SubjectsScheduled.

public int SubjectsErased { get; init; }

Property Value

int

SubjectsScheduled

Gets the number of subjects (including primary) whose erasure was accepted for later execution (status Pending, Scheduled, or InProgress) but has not yet completed.

public int SubjectsScheduled { get; init; }

Property Value

int

Success

Gets a value indicating whether the cascade erasure completed successfully.

public required bool Success { get; init; }

Property Value

bool