Skip to main content

CleanOverlayEntriesResultDto

Namespace: Meshmakers.Octo.Communication.Contracts.DataTransferObjects

Response body for DELETE {tenantId}/v1/clients/cleanOverlayEntries — strips entries where Source starts with overlay: (or matches a specific overlay:<name> if a name was supplied) from every blueprint-managed client's URI lists. Companion to the ApplyOverlayUrisDto family introduced in AB#4209 Step 4 — together they let operators apply and rescind overlay URIs declaratively without modifying the blueprint seed.

public sealed class CleanOverlayEntriesResultDto

Inheritance Object → CleanOverlayEntriesResultDto

Properties​

OverlayName​

The overlay name filter that was applied, or null if all overlay:* sources were targeted.

public string OverlayName { get; set; }

Property Value​

String

ClientsAffected​

Number of clients that had at least one matching entry removed (and thus received an UpdateAsync + cache invalidation).

public int ClientsAffected { get; set; }

Property Value​

Int32

TotalEntriesRemoved​

Total number of URI entries removed across every list across every client.

public int TotalEntriesRemoved { get; set; }

Property Value​

Int32

ClientResults​

Per-client breakdown — one entry per client that had at least one matching URI removed (clients with zero removals are omitted to keep the response small).

public List<CleanOverlayEntriesClientResultDto> ClientResults { get; set; }

Property Value​

List<CleanOverlayEntriesClientResultDto>

Constructors​

CleanOverlayEntriesResultDto()​

Caution​

Constructors of types with required members are not supported in this version of your compiler.

public CleanOverlayEntriesResultDto()