Skip to content
API referenceDevelopmentEngine APIEngine ccf7d03f
Synced
  • Plans retirement by budget pressure or an explicit request to retire every unreferenced artifact.

API: engine
Project: Inno.Build.Toolchains

public static Inno.Build.Toolchains.BuildCacheCleanupPlan Inno.Build.Toolchains.BuildCacheCleanupPlan.Create(string workspace, System.Collections.Generic.IReadOnlyList<Inno.Build.Toolchains.BuildCacheOwnerDescriptor> owners, Inno.Build.Toolchains.BuildCachePolicy policy, bool retireAll = false, string? targetId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))

Parameter workspace: The absolute checkout boundary; no owner may manage it or its parent.

Parameter owners: Explicit registrations; callbacks remain borrowed until execution completes.

Parameter policy: The immutable size, free-space and duration budgets.

Parameter retireAll: Whether to propose all unreferenced generations regardless of size pressure.

Parameter cancellationToken: Cancels planning before any directory is removed.

Parameter targetId: An exact producer-declared target filter, or null to manage all registered scopes. Outside-scope generations and their dependencies remain protected.

A fixed proposal; execution rechecks ownership, roots and active readers before deletion.

Exception T:System.ArgumentException: Owners overlap, identities repeat, or dependency metadata forms a cycle.

Exception T:System.IO.IOException: An owner, artifact or lease escapes its boundary or traverses a link.

Exception T:System.IO.InvalidDataException: An inventory has ambiguous ownership or undeclared dependencies.

Exception T:System.OperationCanceledException: Planning was canceled.

Exception T:System.TimeoutException: Inventory exceeded the complete operation budget; no artifact was removed.