Class RestEndpointAuthoringPolicyDescriptor
Namespace: Cephalon.Abstractions.Transports
Assembly: Cephalon.Abstractions.dll
Describes one behavior-level REST authoring policy together with its runtime effect.
public sealed class RestEndpointAuthoringPolicyDescriptorInheritance
Section titled “Inheritance”object ← RestEndpointAuthoringPolicyDescriptor
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”This descriptor keeps authoring-policy intent readable as a first-class runtime answer while preserving separate buckets for authoring-policy suppression, later precedence suppression, and later governance suppression.
Constructors
Section titled “Constructors”RestEndpointAuthoringPolicyDescriptor(string, bool, bool, string?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointAuthoringPolicySuppressionKind>?, IReadOnlyList<RestEndpointAuthoringPolicySuppressionSummaryDescriptor>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointAuthoringPolicyAuthoringStyleDescriptor>?, IReadOnlyList<RestEndpointGovernanceSuppressionSummaryDescriptor>?, IReadOnlyList<RestEndpointGovernanceOverrideSummaryDescriptor>?, IReadOnlyList<RestEndpointGovernanceSkippedSuppressionSummaryDescriptor>?, IReadOnlyList<RestEndpointGovernanceSkippedOverrideSummaryDescriptor>?)
Section titled “ RestEndpointAuthoringPolicyDescriptor(string, bool, bool, string?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointAuthoringPolicySuppressionKind>?, IReadOnlyList<RestEndpointAuthoringPolicySuppressionSummaryDescriptor>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointAuthoringPolicyAuthoringStyleDescriptor>?, IReadOnlyList<RestEndpointGovernanceSuppressionSummaryDescriptor>?, IReadOnlyList<RestEndpointGovernanceOverrideSummaryDescriptor>?, IReadOnlyList<RestEndpointGovernanceSkippedSuppressionSummaryDescriptor>?, IReadOnlyList<RestEndpointGovernanceSkippedOverrideSummaryDescriptor>?)”Creates a REST authoring-policy runtime descriptor.
public RestEndpointAuthoringPolicyDescriptor(string behaviorId, bool isConfigured = false, bool allowMultiplePublishedCandidates = false, string? preferredAuthoringStyle = null, IReadOnlyList<string>? allowedAuthoringStyles = null, IReadOnlyList<string>? disallowedAuthoringStyles = null, IReadOnlyList<string>? candidateIds = null, IReadOnlyList<string>? retainedCandidateIds = null, IReadOnlyList<string>? publishedCandidateIds = null, IReadOnlyList<string>? precedenceSuppressedCandidateIds = null, IReadOnlyList<string>? governanceSuppressedCandidateIds = null, IReadOnlyList<string>? suppressedCandidateIds = null, IReadOnlyList<RestEndpointAuthoringPolicySuppressionKind>? suppressionKinds = null, IReadOnlyList<RestEndpointAuthoringPolicySuppressionSummaryDescriptor>? suppressionSummaries = null, IReadOnlyList<string>? hostGovernanceEligibleCandidateIds = null, IReadOnlyList<string>? hostGovernanceIneligibleCandidateIds = null, IReadOnlyList<string>? skippedSuppressionIds = null, IReadOnlyList<string>? skippedOverrideIds = null, IReadOnlyList<RestEndpointAuthoringPolicyAuthoringStyleDescriptor>? authoringStyleSummaries = null, IReadOnlyList<RestEndpointGovernanceSuppressionSummaryDescriptor>? governanceSuppressionSummaries = null, IReadOnlyList<RestEndpointGovernanceOverrideSummaryDescriptor>? governanceOverrideSummaries = null, IReadOnlyList<RestEndpointGovernanceSkippedSuppressionSummaryDescriptor>? skippedSuppressionSummaries = null, IReadOnlyList<RestEndpointGovernanceSkippedOverrideSummaryDescriptor>? skippedOverrideSummaries = null)Parameters
Section titled “Parameters”behaviorId string
The stable behavior identifier that this policy applies to.
isConfigured bool
true when the policy was supplied through host configuration; otherwise false when the runtime is exposing the implicit default policy.
allowMultiplePublishedCandidates bool
true when the policy explicitly allows more than one projection candidate to remain published for the same behavior boundary after authoring-policy enforcement.
preferredAuthoringStyle string?
The normalized preferred authoring style when the policy declares one.
allowedAuthoringStyles IReadOnlyList<string>?
The normalized authoring styles that the policy explicitly allows for this behavior boundary when one or more are declared.
disallowedAuthoringStyles IReadOnlyList<string>?
The normalized authoring styles that the policy explicitly disallows for this behavior boundary when one or more are declared.
candidateIds IReadOnlyList<string>?
The ordered candidate identifiers visible for this behavior boundary before authoring-policy enforcement is considered.
retainedCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers that survived authoring-policy enforcement, even if a later precedence or host-governance step suppressed them.
publishedCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers that remain published after all runtime publication steps.
precedenceSuppressedCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers that survived authoring policy but were later suppressed by candidate precedence.
governanceSuppressedCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers that survived authoring policy but were later suppressed by host-level REST governance.
suppressedCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers that were suppressed by behavior-level authoring-policy enforcement.
suppressionKinds IReadOnlyList<RestEndpointAuthoringPolicySuppressionKind>?
The grouped authoring-policy suppression kinds that appear in the runtime effect.
suppressionSummaries IReadOnlyList<RestEndpointAuthoringPolicySuppressionSummaryDescriptor>?
The grouped authoring-policy suppression outcomes summarized by suppression kind.
hostGovernanceEligibleCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers whose original projections allowed host governance to participate for this behavior boundary.
hostGovernanceIneligibleCandidateIds IReadOnlyList<string>?
The ordered candidate identifiers whose original projections kept host governance out of scope for this behavior boundary.
skippedSuppressionIds IReadOnlyList<string>?
The ordered suppression-rule identifiers that targeted host-governance-ineligible candidates in this behavior boundary.
skippedOverrideIds IReadOnlyList<string>?
The ordered override-rule identifiers that targeted host-governance-ineligible candidates in this behavior boundary.
authoringStyleSummaries IReadOnlyList<RestEndpointAuthoringPolicyAuthoringStyleDescriptor>?
The per-authoring-style runtime buckets that explain how this policy’s candidate, retained, published, precedence-suppressed, governance-suppressed, and authoring-policy-suppressed outcomes distribute across authoring styles.
governanceSuppressionSummaries IReadOnlyList<RestEndpointGovernanceSuppressionSummaryDescriptor>?
The grouped host-governance suppression-rule outcomes summarized by rule for this behavior boundary.
governanceOverrideSummaries IReadOnlyList<RestEndpointGovernanceOverrideSummaryDescriptor>?
The grouped host-governance override-rule outcomes summarized by rule for this behavior boundary.
skippedSuppressionSummaries IReadOnlyList<RestEndpointGovernanceSkippedSuppressionSummaryDescriptor>?
The grouped host-governance-skipped suppression-rule outcomes summarized by rule for this behavior boundary.
skippedOverrideSummaries IReadOnlyList<RestEndpointGovernanceSkippedOverrideSummaryDescriptor>?
The grouped host-governance-skipped override-rule outcomes summarized by rule for this behavior boundary.
Properties
Section titled “Properties”AllowMultiplePublishedCandidates
Section titled “ AllowMultiplePublishedCandidates”Gets a value indicating whether the policy explicitly allows multiple published candidates for the same behavior boundary after authoring-policy enforcement.
public bool AllowMultiplePublishedCandidates { get; }Property Value
Section titled “Property Value”AllowedAuthoringStyles
Section titled “ AllowedAuthoringStyles”Gets the normalized authoring styles that the policy explicitly allows.
public IReadOnlyList<string> AllowedAuthoringStyles { get; }Property Value
Section titled “Property Value”AuthoringStyleSummaries
Section titled “ AuthoringStyleSummaries”Gets the per-authoring-style runtime buckets that explain how this policy’s outcomes distribute across authoring styles.
public IReadOnlyList<RestEndpointAuthoringPolicyAuthoringStyleDescriptor> AuthoringStyleSummaries { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointAuthoringPolicyAuthoringStyleDescriptor>
BehaviorId
Section titled “ BehaviorId”Gets the stable behavior identifier that this authoring policy applies to.
public string BehaviorId { get; }Property Value
Section titled “Property Value”CandidateIds
Section titled “ CandidateIds”Gets the ordered candidate identifiers visible for this behavior boundary.
public IReadOnlyList<string> CandidateIds { get; }Property Value
Section titled “Property Value”DisallowedAuthoringStyles
Section titled “ DisallowedAuthoringStyles”Gets the normalized authoring styles that the policy explicitly disallows.
public IReadOnlyList<string> DisallowedAuthoringStyles { get; }Property Value
Section titled “Property Value”GovernanceOverrideSummaries
Section titled “ GovernanceOverrideSummaries”Gets the grouped host-governance override-rule outcomes summarized by rule.
public IReadOnlyList<RestEndpointGovernanceOverrideSummaryDescriptor> GovernanceOverrideSummaries { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointGovernanceOverrideSummaryDescriptor>
GovernanceSuppressedCandidateIds
Section titled “ GovernanceSuppressedCandidateIds”Gets the ordered candidate identifiers that survived authoring policy but were later suppressed by host governance.
public IReadOnlyList<string> GovernanceSuppressedCandidateIds { get; }Property Value
Section titled “Property Value”GovernanceSuppressionSummaries
Section titled “ GovernanceSuppressionSummaries”Gets the grouped host-governance suppression-rule outcomes summarized by rule.
public IReadOnlyList<RestEndpointGovernanceSuppressionSummaryDescriptor> GovernanceSuppressionSummaries { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointGovernanceSuppressionSummaryDescriptor>
HostGovernanceEligibleCandidateIds
Section titled “ HostGovernanceEligibleCandidateIds”Gets the ordered candidate identifiers whose original projections allowed host governance to participate.
public IReadOnlyList<string> HostGovernanceEligibleCandidateIds { get; }Property Value
Section titled “Property Value”HostGovernanceIneligibleCandidateIds
Section titled “ HostGovernanceIneligibleCandidateIds”Gets the ordered candidate identifiers whose original projections kept host governance out of scope.
public IReadOnlyList<string> HostGovernanceIneligibleCandidateIds { get; }Property Value
Section titled “Property Value”IsConfigured
Section titled “ IsConfigured”Gets a value indicating whether this authoring policy came from explicit host configuration.
public bool IsConfigured { get; }Property Value
Section titled “Property Value”PrecedenceSuppressedCandidateIds
Section titled “ PrecedenceSuppressedCandidateIds”Gets the ordered candidate identifiers that survived authoring policy but were later suppressed by precedence.
public IReadOnlyList<string> PrecedenceSuppressedCandidateIds { get; }Property Value
Section titled “Property Value”PreferredAuthoringStyle
Section titled “ PreferredAuthoringStyle”Gets the normalized preferred authoring style when the policy declares one.
public string? PreferredAuthoringStyle { get; }Property Value
Section titled “Property Value”PublishedCandidateIds
Section titled “ PublishedCandidateIds”Gets the ordered candidate identifiers that remain published after all runtime publication steps.
public IReadOnlyList<string> PublishedCandidateIds { get; }Property Value
Section titled “Property Value”RetainedCandidateIds
Section titled “ RetainedCandidateIds”Gets the ordered candidate identifiers that survived authoring-policy enforcement.
public IReadOnlyList<string> RetainedCandidateIds { get; }Property Value
Section titled “Property Value”SkippedOverrideIds
Section titled “ SkippedOverrideIds”Gets the ordered override-rule identifiers that targeted host-governance-ineligible candidates in this behavior boundary.
public IReadOnlyList<string> SkippedOverrideIds { get; }Property Value
Section titled “Property Value”SkippedOverrideSummaries
Section titled “ SkippedOverrideSummaries”Gets the grouped host-governance-skipped override-rule outcomes summarized by rule.
public IReadOnlyList<RestEndpointGovernanceSkippedOverrideSummaryDescriptor> SkippedOverrideSummaries { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointGovernanceSkippedOverrideSummaryDescriptor>
SkippedSuppressionIds
Section titled “ SkippedSuppressionIds”Gets the ordered suppression-rule identifiers that targeted host-governance-ineligible candidates in this behavior boundary.
public IReadOnlyList<string> SkippedSuppressionIds { get; }Property Value
Section titled “Property Value”SkippedSuppressionSummaries
Section titled “ SkippedSuppressionSummaries”Gets the grouped host-governance-skipped suppression-rule outcomes summarized by rule.
public IReadOnlyList<RestEndpointGovernanceSkippedSuppressionSummaryDescriptor> SkippedSuppressionSummaries { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointGovernanceSkippedSuppressionSummaryDescriptor>
SuppressedCandidateIds
Section titled “ SuppressedCandidateIds”Gets the ordered candidate identifiers that were suppressed by behavior-level authoring-policy enforcement.
public IReadOnlyList<string> SuppressedCandidateIds { get; }Property Value
Section titled “Property Value”SuppressionKinds
Section titled “ SuppressionKinds”Gets the grouped authoring-policy suppression kinds visible in the runtime effect.
public IReadOnlyList<RestEndpointAuthoringPolicySuppressionKind> SuppressionKinds { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointAuthoringPolicySuppressionKind>
SuppressionSummaries
Section titled “ SuppressionSummaries”Gets the grouped authoring-policy suppression outcomes summarized by suppression kind.
public IReadOnlyList<RestEndpointAuthoringPolicySuppressionSummaryDescriptor> SuppressionSummaries { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointAuthoringPolicySuppressionSummaryDescriptor>