Zum Hauptinhalt springen

SecretSweepRunDto

Namespace: Meshmakers.Octo.Communication.Contracts.DataTransferObjects

One secret sweep run of a tenant (bot services GET {tenantId}/v1/secrets/sweep-runs, newest first, the last 50 are kept per tenant; AB#5528/AB#5544). Counts only - never a value, never ciphertext.

public class SecretSweepRunDto

Inheritance Object → SecretSweepRunDto

Properties​

RunId​

Run id (the Hangfire job id); addresses the run's dump.

public string RunId { get; set; }

Property Value​

String

Mode​

Mode: Verify, Encrypt, Reprotect or CleanupUnreadable.

public SecretSweepModeDto Mode { get; set; }

Property Value​

SecretSweepModeDto

Trigger​

What started the run.

public SecretSweepTriggerDto Trigger { get; set; }

Property Value​

SecretSweepTriggerDto

Outcome​

Outcome; SecretSweepOutcomeDto.Running while the run is in progress.

public SecretSweepOutcomeDto Outcome { get; set; }

Property Value​

SecretSweepOutcomeDto

Reason​

Why the run was skipped or failed, or a remark (as in the report); e.g. Interrupted (service restart) for a run whose bot process ended while it was running. Never contains a value; null while running or when there is nothing to say.

public string Reason { get; set; }

Property Value​

String

StartedAt​

Start (UTC).

public DateTime StartedAt { get; set; }

Property Value​

DateTime

CompletedAt​

End (UTC); null while running.

public Nullable<DateTime> CompletedAt { get; set; }

Property Value​

Nullable<DateTime>

TriggeredBy​

User name of whoever started the run, or null (recurring, restore).

public string TriggeredBy { get; set; }

Property Value​

String

Totals​

Counts per stored form BEFORE the run: the forms as found by the run's own scan (for a post-restore run its first step). For SecretSweepModeDto.Verify the same as SecretSweepRunDto.TotalsAfter.

public SecretFormCountsReportDto Totals { get; set; }

Property Value​

SecretFormCountsReportDto

TotalsAfter​

Counts per stored form AFTER the run: the follow-up Verify of a writing run (Encrypt, Reprotect, CleanupUnreadable, restore), the run's own scan for a Verify. null while running and when the run was skipped or failed before that scan (AB#5539).

public SecretFormCountsReportDto TotalsAfter { get; set; }

Property Value​

SecretFormCountsReportDto

ValuesRewritten​

Values written by this run (encrypted, re-protected, placeholders normalised, cleared); a value whose write did not happen is not counted.

public long ValuesRewritten { get; set; }

Property Value​

Int64

EncryptedCount​

Values converted from legacy clear text or enc:v1 to enc:v2 by this run (included in SecretSweepRunDto.ValuesRewritten).

public long EncryptedCount { get; set; }

Property Value​

Int64

SkippedConcurrentlyModified​

Values left as stored because they changed while the run was working on them; a run with such values is SecretSweepOutcomeDto.CompletedWithFailures - run it again.

public long SkippedConcurrentlyModified { get; set; }

Property Value​

Int64

PlaceholdersNormalized​

Legacy clear-text placeholders converted once to "not set" (migration only).

public long PlaceholdersNormalized { get; set; }

Property Value​

Int64

SkippedLegacyV1KeyMissing​

SecretSweepModeDto.CleanupUnreadable only: legacy enc:v1 values kept although unreadable, because only the legacy key is missing (configuration gap, not key loss).

public long SkippedLegacyV1KeyMissing { get; set; }

Property Value​

Int64

UnreadableCount​

Stored values that cannot be read (unknown key id) - re-entry tasks.

public long UnreadableCount { get; set; }

Property Value​

Int64

Dump​

The pre-sweep dump; null for Verify (no dump).

public SecretSweepDumpDto Dump { get; set; }

Property Value​

SecretSweepDumpDto

Constructors​

SecretSweepRunDto()​

public SecretSweepRunDto()