Class RetentionContributorResult
- Namespace
- Excalibur.Compliance
- Assembly
- Excalibur.Compliance.Abstractions.dll
Result of an IRetentionContributor enforcement pass.
public sealed record RetentionContributorResult : IEquatable<RetentionContributorResult>
- Inheritance
-
RetentionContributorResult
- Implements
- Inherited Members
Properties
ErrorMessage
public string? ErrorMessage { get; init; }
Property Value
RecordsCleaned
Gets the number of records cleaned (deleted) by this contributor.
public int RecordsCleaned { get; init; }
Property Value
Success
Gets a value indicating whether the contributor completed successfully.
public required bool Success { get; init; }
Property Value
Methods
Failed(string)
Creates a failed result with the supplied error message.
public static RetentionContributorResult Failed(string errorMessage)
Parameters
errorMessagestringThe error message.
Returns
Succeeded(int)
Creates a successful result for the given number of cleaned records.
public static RetentionContributorResult Succeeded(int recordsCleaned)
Parameters
recordsCleanedintThe number of records cleaned.
Returns
- RetentionContributorResult
A successful RetentionContributorResult.