Class RestEndpointSuppressionOptions
Namespace: Cephalon.AspNetCore.Hosting
Assembly: Cephalon.AspNetCore.dll
Describes one host-level suppression rule for descriptor-backed REST shorthand candidates.
public sealed class RestEndpointSuppressionOptionsInheritance
Section titled “Inheritance”object ← RestEndpointSuppressionOptions
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”RestEndpointSuppressionOptions(string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<int>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointBindingFallbackMode>?, IReadOnlyList<RestEndpointBindingDescriptor>?, IReadOnlyList<string>?, IReadOnlyList<string>?)
Section titled “ RestEndpointSuppressionOptions(string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<int>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointBindingFallbackMode>?, IReadOnlyList<RestEndpointBindingDescriptor>?, IReadOnlyList<string>?, IReadOnlyList<string>?)”Initializes a new instance of the
public RestEndpointSuppressionOptions(string id, IReadOnlyList<string>? candidateIds = null, IReadOnlyList<string>? behaviorIds = null, IReadOnlyList<string>? sourceModuleIds = null, IReadOnlyList<string>? authoringStyles = null, IReadOnlyList<int>? apiVersionMajors = null, IReadOnlyList<string>? methods = null, IReadOnlyList<string>? relativePatterns = null, IReadOnlyList<string>? routeGroupPrefixes = null, IReadOnlyList<string>? openApiDocumentNames = null, IReadOnlyList<string>? tagNames = null, IReadOnlyList<string>? endpointNames = null, IReadOnlyList<RestEndpointBindingFallbackMode>? bindingFallbackModes = null, IReadOnlyList<RestEndpointBindingDescriptor>? targetBindings = null, IReadOnlyList<string>? hostGovernanceScopes = null, IReadOnlyList<string>? behaviorIdPrefixes = null)Parameters
Section titled “Parameters”id string
The stable suppression identifier.
candidateIds IReadOnlyList<string>?
The original shorthand candidate identifiers targeted by the suppression rule.
behaviorIds IReadOnlyList<string>?
The behavior identifiers targeted by the suppression rule.
sourceModuleIds IReadOnlyList<string>?
The source-module identifiers targeted by the suppression rule.
authoringStyles IReadOnlyList<string>?
The module-owned REST authoring styles targeted by the suppression rule. When omitted, the
rule targets only shorthand styles behavior-module-profile and
behavior-module-generated. Explicit behavior-module-dsl routes participate
only when the owning route group opted into host governance.
apiVersionMajors IReadOnlyList<int>?
The effective API major versions targeted by the suppression rule before any override actions are applied.
methods IReadOnlyList<string>?
The effective HTTP methods targeted by the suppression rule before any override actions are applied.
relativePatterns IReadOnlyList<string>?
The shorthand relative route patterns targeted by the suppression rule before any override actions are applied.
routeGroupPrefixes IReadOnlyList<string>?
The published route-group prefixes targeted by the suppression rule before any override actions are applied.
openApiDocumentNames IReadOnlyList<string>?
The original shorthand OpenAPI document names targeted by the suppression rule before any override actions are applied.
tagNames IReadOnlyList<string>?
The original shorthand primary OpenAPI tag names targeted by the suppression rule before any override actions are applied.
endpointNames IReadOnlyList<string>?
The original shorthand endpoint names targeted by the suppression rule before any override actions are applied.
bindingFallbackModes IReadOnlyList<RestEndpointBindingFallbackMode>?
The original shorthand request-binding fallback modes targeted by the suppression rule before any override actions are applied.
targetBindings IReadOnlyList<RestEndpointBindingDescriptor>?
The original shorthand explicit binding descriptors targeted by the suppression rule before any override actions are applied.
hostGovernanceScopes IReadOnlyList<string>?
The original shorthand host-governance scopes targeted by the suppression rule before any override actions are applied. This selector can also serve as the rule’s primary target when candidate, behavior, and source-module identifiers are intentionally omitted.
behaviorIdPrefixes IReadOnlyList<string>?
The behavior-id prefixes targeted by the suppression rule. Prefix matches use the stable dot-separated behavior-id hierarchy, so a prefix targets the exact behavior id and any descendant behavior ids beneath that prefix.
Properties
Section titled “Properties”ApiVersionMajors
Section titled “ ApiVersionMajors”Gets the effective API major versions targeted by this suppression rule before override actions are applied.
public IReadOnlyList<int> ApiVersionMajors { get; }Property Value
Section titled “Property Value”AuthoringStyles
Section titled “ AuthoringStyles”Gets the normalized shorthand authoring styles targeted by this suppression rule.
public IReadOnlyList<string> AuthoringStyles { get; }Property Value
Section titled “Property Value”BehaviorIdPrefixes
Section titled “ BehaviorIdPrefixes”Gets the behavior-id prefixes targeted by this suppression rule.
public IReadOnlyList<string> BehaviorIdPrefixes { get; }Property Value
Section titled “Property Value”BehaviorIds
Section titled “ BehaviorIds”Gets the behavior identifiers targeted by this suppression rule.
public IReadOnlyList<string> BehaviorIds { get; }Property Value
Section titled “Property Value”BindingFallbackModes
Section titled “ BindingFallbackModes”Gets the original shorthand request-binding fallback modes targeted by this suppression rule before override actions are applied.
public IReadOnlyList<RestEndpointBindingFallbackMode> BindingFallbackModes { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointBindingFallbackMode>
CandidateIds
Section titled “ CandidateIds”Gets the original shorthand candidate identifiers targeted by this suppression rule.
public IReadOnlyList<string> CandidateIds { get; }Property Value
Section titled “Property Value”EndpointNames
Section titled “ EndpointNames”Gets the original shorthand endpoint names targeted by this suppression rule before override actions are applied.
public IReadOnlyList<string> EndpointNames { get; }Property Value
Section titled “Property Value”HasValues
Section titled “ HasValues”Gets a value indicating whether any targeting values were explicitly supplied.
public bool HasValues { get; }Property Value
Section titled “Property Value”HostGovernanceScopes
Section titled “ HostGovernanceScopes”Gets the original shorthand host-governance scopes targeted by this suppression rule before override actions are applied. These scopes can also act as the rule’s primary target.
public IReadOnlyList<string> HostGovernanceScopes { get; }Property Value
Section titled “Property Value”Gets the stable suppression identifier.
public string Id { get; }Property Value
Section titled “Property Value”Methods
Section titled “ Methods”Gets the effective HTTP methods targeted by this suppression rule before override actions are applied.
public IReadOnlyList<string> Methods { get; }Property Value
Section titled “Property Value”OpenApiDocumentNames
Section titled “ OpenApiDocumentNames”Gets the original shorthand OpenAPI document names targeted by this suppression rule before override actions are applied.
public IReadOnlyList<string> OpenApiDocumentNames { get; }Property Value
Section titled “Property Value”RelativePatterns
Section titled “ RelativePatterns”Gets the shorthand relative route patterns targeted by this suppression rule before override actions are applied.
public IReadOnlyList<string> RelativePatterns { get; }Property Value
Section titled “Property Value”RouteGroupPrefixes
Section titled “ RouteGroupPrefixes”Gets the published route-group prefixes targeted by this suppression rule before override actions are applied.
public IReadOnlyList<string> RouteGroupPrefixes { get; }Property Value
Section titled “Property Value”SourceModuleIds
Section titled “ SourceModuleIds”Gets the source-module identifiers targeted by this suppression rule.
public IReadOnlyList<string> SourceModuleIds { get; }Property Value
Section titled “Property Value”TagNames
Section titled “ TagNames”Gets the original shorthand primary OpenAPI tag names targeted by this suppression rule before override actions are applied.
public IReadOnlyList<string> TagNames { get; }Property Value
Section titled “Property Value”TargetBindings
Section titled “ TargetBindings”Gets the original shorthand explicit binding descriptors targeted by this suppression rule before override actions are applied.
public IReadOnlyList<RestEndpointBindingDescriptor> TargetBindings { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointBindingDescriptor>