API Reference
Class
RuleInventoryEntry
Inventory view of a rule's source, visibility, and migration state.
Inheritance
- Object
- RuleInventoryEntry
Constructors
public RuleInventoryEntry(String Name, String DisplayName, RuleSourceType Type, Boolean Enabled, RuleVisibility Visibility, Boolean Deprecated, IReadOnlyList<Category> Categories, IReadOnlyList<String> Tags, RuleMigrationState State, Boolean SuppressedByDefault, String AssessmentArea, IReadOnlyList<String> Supersedes, IReadOnlyList<String> SupersededBy) #Inventory view of a rule's source, visibility, and migration state.
Parameters
- Name System.String
- Canonical rule name.
- DisplayName System.String
- Friendly rule name.
- Type TestimoX.Definitions.RuleSourceType
- Source implementation type.
- Enabled System.Boolean
- Whether the rule is enabled by default.
- Visibility TestimoX.Definitions.RuleVisibility
- Visibility in normal UX flows.
- Deprecated System.Boolean
- Whether the rule is deprecated.
- Categories System.Collections.Generic.IReadOnlyList{TestimoX.Definitions.Category}
- Rule categories.
- Tags System.Collections.Generic.IReadOnlyList{System.String}
- Rule tags.
- State TestimoX.Execution.RuleMigrationState
- Derived migration state.
- SuppressedByDefault System.Boolean
- Whether supersedence suppresses this rule by default.
- AssessmentArea System.String
- Optional curated assessment area when inventory is built for a specific profile.
- Supersedes System.Collections.Generic.IReadOnlyList{System.String}
- Rules explicitly superseded by this rule.
- SupersededBy System.Collections.Generic.IReadOnlyList{System.String}
- Rules that explicitly supersede this rule.
Methods
public RuleInventoryEntry <Clone>$() #Returns:
RuleInventoryEntrypublic Void Deconstruct(out String Name, out String DisplayName, out RuleSourceType Type, out Boolean Enabled, out RuleVisibility Visibility, out Boolean Deprecated, out IReadOnlyList<Category> Categories, out IReadOnlyList<String> Tags, out RuleMigrationState State, out Boolean SuppressedByDefault, out String AssessmentArea, out IReadOnlyList<String> Supersedes, out IReadOnlyList<String> SupersededBy) #Returns:
VoidParameters
- Name String
- DisplayName String
- Type RuleSourceType
- Enabled Boolean
- Visibility RuleVisibility
- Deprecated Boolean
- Categories IReadOnlyList<Category>
- Tags IReadOnlyList<String>
- State RuleMigrationState
- SuppressedByDefault Boolean
- AssessmentArea String
- Supersedes IReadOnlyList<String>
- SupersededBy IReadOnlyList<String>
public override Int32 GetHashCode() #Returns:
Int32public override String ToString() #Returns:
StringInherited Methods
Properties
public String DisplayName { get; set; } #Friendly rule name.
public RuleSourceType Type { get; set; } #Source implementation type.
public Boolean Enabled { get; set; } #Whether the rule is enabled by default.
public RuleVisibility Visibility { get; set; } #Visibility in normal UX flows.
public Boolean Deprecated { get; set; } #Whether the rule is deprecated.
public IReadOnlyList<Category> Categories { get; set; } #Rule categories.
public IReadOnlyList<String> Tags { get; set; } #Rule tags.
public RuleMigrationState State { get; set; } #Derived migration state.
public Boolean SuppressedByDefault { get; set; } #Whether supersedence suppresses this rule by default.
public String AssessmentArea { get; set; } #Optional curated assessment area when inventory is built for a specific profile.
public IReadOnlyList<String> Supersedes { get; set; } #Rules explicitly superseded by this rule.
public IReadOnlyList<String> SupersededBy { get; set; } #Rules that explicitly supersede this rule.