Class AuditHistoryRetentionSettings
Namespace: Cephalon.Engine.Configuration
Assembly: Cephalon.Engine.dll
Describes configuration-driven retention settings for durable audit history.
public sealed class AuditHistoryRetentionSettingsInheritance
Section titled “Inheritance”object ← AuditHistoryRetentionSettings
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”AuditHistoryRetentionSettings(bool?, int?, int?, bool?, int?)
Section titled “ AuditHistoryRetentionSettings(bool?, int?, int?, bool?, int?)”Initializes a new instance of the
public AuditHistoryRetentionSettings(bool? enabled = null, int? maxAgeDays = null, int? deleteBatchSize = null, bool? applyOnStartup = null, int? runIntervalMinutes = null)Parameters
Section titled “Parameters”enabled bool?
Whether retention was explicitly enabled.
maxAgeDays int?
The maximum age, in days, to retain durable audit rows.
deleteBatchSize int?
The maximum number of rows deleted per retention batch.
applyOnStartup bool?
Whether one retention pass should run during host startup.
runIntervalMinutes int?
The optional recurring retention interval in minutes.
Fields
Section titled “Fields”DefaultDeleteBatchSize
Section titled “ DefaultDeleteBatchSize”Gets the default delete-batch size used by the engine-owned retention baseline.
public const int DefaultDeleteBatchSize = 500Field Value
Section titled “Field Value”Properties
Section titled “Properties”ApplyOnStartup
Section titled “ ApplyOnStartup”Gets a value indicating whether one retention pass should run during host startup.
public bool? ApplyOnStartup { get; }Property Value
Section titled “Property Value”bool?
DeleteBatchSize
Section titled “ DeleteBatchSize”Gets the maximum number of rows deleted per retention batch.
public int? DeleteBatchSize { get; }Property Value
Section titled “Property Value”int?
Gets an empty audit-history retention settings instance.
public static AuditHistoryRetentionSettings Empty { get; }Property Value
Section titled “Property Value”Enabled
Section titled “ Enabled”Gets a value indicating whether retention was explicitly enabled.
public bool? Enabled { get; }Property Value
Section titled “Property Value”bool?
HasValues
Section titled “ HasValues”Gets a value indicating whether any retention settings were explicitly supplied.
public bool HasValues { get; }Property Value
Section titled “Property Value”MaxAgeDays
Section titled “ MaxAgeDays”Gets the maximum age, in days, to retain durable audit rows.
public int? MaxAgeDays { get; }Property Value
Section titled “Property Value”int?
RunIntervalMinutes
Section titled “ RunIntervalMinutes”Gets the optional recurring retention interval in minutes.
public int? RunIntervalMinutes { get; }Property Value
Section titled “Property Value”int?
Methods
Section titled “Methods”FromSection(IConfigurationSection?)
Section titled “ FromSection(IConfigurationSection?)”Reads retention settings from the supplied configuration section.
public static AuditHistoryRetentionSettings FromSection(IConfigurationSection? section)Parameters
Section titled “Parameters”section IConfigurationSection?
The retention configuration section to read.
Returns
Section titled “Returns”The parsed retention settings.