Class RestEndpointOverrideOptions
Namespace: Cephalon.AspNetCore.Hosting
Assembly: Cephalon.AspNetCore.dll
Describes one host-level override rule for descriptor-backed REST shorthand candidates.
public sealed class RestEndpointOverrideOptionsInheritance
Section titled “Inheritance”object ← RestEndpointOverrideOptions
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”RestEndpointOverrideOptions(string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<int>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, int?, string?, string?, string?, string?, string?, string?, string?, string?, string?, bool, IReadOnlyList<string>?, bool, IReadOnlyList<RestEndpointBindingDescriptor>?, IReadOnlyList<string>?, bool, RestEndpointOverrideBindingMode, bool, bool, bool, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointBindingFallbackMode>?, IReadOnlyList<RestEndpointBindingDescriptor>?, IReadOnlyList<string>?, IReadOnlyList<string>?, bool)
Section titled “ RestEndpointOverrideOptions(string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<int>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, int?, string?, string?, string?, string?, string?, string?, string?, string?, string?, bool, IReadOnlyList<string>?, bool, IReadOnlyList<RestEndpointBindingDescriptor>?, IReadOnlyList<string>?, bool, RestEndpointOverrideBindingMode, bool, bool, bool, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointBindingFallbackMode>?, IReadOnlyList<RestEndpointBindingDescriptor>?, IReadOnlyList<string>?, IReadOnlyList<string>?, bool)”Initializes a new instance of the
public RestEndpointOverrideOptions(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, int? apiVersionMajor = null, string? method = null, string? pattern = null, string? routeGroupPrefix = null, string? openApiDocumentName = null, string? tagName = null, string? endpointName = null, string? summary = null, string? description = null, string? requiredCapabilityKey = null, bool clearRequiredCapability = false, IReadOnlyList<string>? requiredFeatureFlagIds = null, bool clearRequiredFeatureFlags = false, IReadOnlyList<RestEndpointBindingDescriptor>? bindings = null, IReadOnlyList<string>? removedBindingProperties = null, bool clearBindings = false, RestEndpointOverrideBindingMode bindingMode = RestEndpointOverrideBindingMode.Unspecified, bool clearEndpointName = false, bool clearSummary = false, bool clearDescription = false, 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, bool preserveImplicitQueryFallback = false)Parameters
Section titled “Parameters”id string
The stable override identifier.
candidateIds IReadOnlyList<string>?
The original shorthand candidate identifiers targeted by the override rule.
behaviorIds IReadOnlyList<string>?
The behavior identifiers targeted by the override rule.
sourceModuleIds IReadOnlyList<string>?
The source-module identifiers targeted by the override rule.
authoringStyles IReadOnlyList<string>?
The module-owned REST authoring styles targeted by the override 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 override rule before any override actions are applied.
methods IReadOnlyList<string>?
The effective HTTP methods targeted by the override rule before any override actions are applied.
relativePatterns IReadOnlyList<string>?
The shorthand relative route patterns targeted by the override rule before any override actions are applied.
routeGroupPrefixes IReadOnlyList<string>?
The published route-group prefixes targeted by the override rule before any override actions are applied.
apiVersionMajor int?
The effective API major version applied when the rule matches a shorthand candidate.
method string?
The effective HTTP method applied when the rule matches a shorthand candidate.
pattern string?
The effective relative route pattern applied when the rule matches a shorthand candidate.
routeGroupPrefix string?
The effective published route-group prefix applied when the rule matches a shorthand candidate.
openApiDocumentName string?
The effective OpenAPI document name applied when the rule matches a shorthand candidate.
tagName string?
The effective primary OpenAPI tag name applied when the rule matches a shorthand candidate.
endpointName string?
The effective endpoint name applied when the rule matches a shorthand candidate.
summary string?
The effective OpenAPI summary applied when the rule matches a shorthand candidate.
description string?
The effective OpenAPI description applied when the rule matches a shorthand candidate.
requiredCapabilityKey string?
The required Cephalon capability key enforced at the REST boundary when the rule matches a shorthand candidate.
clearRequiredCapability bool
true when the rule removes any previously declared Cephalon capability boundary from the matched shorthand candidate.
requiredFeatureFlagIds IReadOnlyList<string>?
The required Cephalon feature-flag identifiers enforced at the REST boundary when the rule matches a shorthand candidate.
clearRequiredFeatureFlags bool
true when the rule removes any previously declared Cephalon feature-flag requirements from the matched shorthand candidate.
bindings IReadOnlyList<RestEndpointBindingDescriptor>?
The effective explicit request-binding plan applied when the rule matches a shorthand candidate.
removedBindingProperties IReadOnlyList<string>?
The explicit shorthand binding properties removed from the source binding plan when the rule matches.
clearBindings bool
true when the rule removes the matched shorthand candidate’s entire explicit binding plan and returns publication to the implicit request-binding baseline.
bindingMode RestEndpointOverrideBindingMode
The mode used to apply bindings and
removedBindingProperties to the shorthand candidate’s explicit binding
plan.
clearEndpointName bool
true when the rule removes any previously declared shorthand endpoint name from the matched candidate.
clearSummary bool
true when the rule removes any previously declared shorthand endpoint summary from the matched candidate.
clearDescription bool
true when the rule removes any previously declared shorthand endpoint description from the matched candidate.
openApiDocumentNames IReadOnlyList<string>?
The original shorthand OpenAPI document names targeted by the override rule before any override actions are applied.
tagNames IReadOnlyList<string>?
The original shorthand primary OpenAPI tag names targeted by the override rule before any override actions are applied.
endpointNames IReadOnlyList<string>?
The original shorthand endpoint names targeted by the override rule before any override actions are applied.
bindingFallbackModes IReadOnlyList<RestEndpointBindingFallbackMode>?
The original shorthand request-binding fallback modes targeted by the override rule before any override actions are applied.
targetBindings IReadOnlyList<RestEndpointBindingDescriptor>?
The original shorthand explicit binding descriptors targeted by the override rule before any override actions are applied.
hostGovernanceScopes IReadOnlyList<string>?
The original shorthand host-governance scopes targeted by the override 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 override 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.
preserveImplicitQueryFallback bool
true when the rule opts the matched explicit-binding shorthand candidate into preserved implicit-query fallback for any remaining unbound query properties.
Properties
Section titled “Properties”ActionKinds
Section titled “ ActionKinds”Gets the normalized action dimensions declared by this override rule.
public IReadOnlyList<RestEndpointOverrideActionKind> ActionKinds { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointOverrideActionKind>
ApiVersionMajor
Section titled “ ApiVersionMajor”Gets the effective API major version applied when this override rule matches.
public int? ApiVersionMajor { get; }Property Value
Section titled “Property Value”int?
ApiVersionMajors
Section titled “ ApiVersionMajors”Gets the effective API major versions targeted by this override 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 override rule.
public IReadOnlyList<string> AuthoringStyles { get; }Property Value
Section titled “Property Value”BehaviorIdPrefixes
Section titled “ BehaviorIdPrefixes”Gets the behavior-id prefixes targeted by this override rule.
public IReadOnlyList<string> BehaviorIdPrefixes { get; }Property Value
Section titled “Property Value”BehaviorIds
Section titled “ BehaviorIds”Gets the behavior identifiers targeted by this override 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 override rule before any override actions are applied.
public IReadOnlyList<RestEndpointBindingFallbackMode> BindingFallbackModes { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointBindingFallbackMode>
BindingMode
Section titled “ BindingMode”Gets how
public RestEndpointOverrideBindingMode BindingMode { get; }Property Value
Section titled “Property Value”RestEndpointOverrideBindingMode
Bindings
Section titled “ Bindings”Gets the effective explicit request-binding plan applied when this override rule matches.
public IReadOnlyList<RestEndpointBindingDescriptor> Bindings { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointBindingDescriptor>
CandidateIds
Section titled “ CandidateIds”Gets the original shorthand candidate identifiers targeted by this override rule.
public IReadOnlyList<string> CandidateIds { get; }Property Value
Section titled “Property Value”ClearBindings
Section titled “ ClearBindings”Gets a value indicating whether this override rule clears the matched shorthand candidate’s entire explicit binding plan.
public bool ClearBindings { get; }Property Value
Section titled “Property Value”ClearDescription
Section titled “ ClearDescription”Gets a value indicating whether this override rule clears any previously declared endpoint description from the matched shorthand candidate.
public bool ClearDescription { get; }Property Value
Section titled “Property Value”ClearEndpointName
Section titled “ ClearEndpointName”Gets a value indicating whether this override rule clears any previously declared endpoint name from the matched shorthand candidate.
public bool ClearEndpointName { get; }Property Value
Section titled “Property Value”ClearRequiredCapability
Section titled “ ClearRequiredCapability”Gets a value indicating whether this override rule clears any previously declared Cephalon capability boundary from the matched shorthand candidate.
public bool ClearRequiredCapability { get; }Property Value
Section titled “Property Value”ClearRequiredFeatureFlags
Section titled “ ClearRequiredFeatureFlags”Gets a value indicating whether this override rule clears any previously declared Cephalon feature-flag requirements from the matched shorthand candidate.
public bool ClearRequiredFeatureFlags { get; }Property Value
Section titled “Property Value”ClearSummary
Section titled “ ClearSummary”Gets a value indicating whether this override rule clears any previously declared endpoint summary from the matched shorthand candidate.
public bool ClearSummary { get; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets the effective OpenAPI description applied when this override rule matches.
public string? Description { get; }Property Value
Section titled “Property Value”EndpointName
Section titled “ EndpointName”Gets the effective endpoint name applied when this override rule matches.
public string? EndpointName { get; }Property Value
Section titled “Property Value”EndpointNames
Section titled “ EndpointNames”Gets the original shorthand endpoint names targeted by this override rule before any 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 or override actions 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 override rule before any 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 override identifier.
public string Id { get; }Property Value
Section titled “Property Value”Method
Section titled “ Method”Gets the effective HTTP method applied when this override rule matches.
public string? Method { get; }Property Value
Section titled “Property Value”Methods
Section titled “ Methods”Gets the effective HTTP methods targeted by this override rule before override actions are applied.
public IReadOnlyList<string> Methods { get; }Property Value
Section titled “Property Value”OpenApiDocumentName
Section titled “ OpenApiDocumentName”Gets the effective OpenAPI document name applied when this override rule matches.
public string? OpenApiDocumentName { get; }Property Value
Section titled “Property Value”OpenApiDocumentNames
Section titled “ OpenApiDocumentNames”Gets the original shorthand OpenAPI document names targeted by this override rule before any override actions are applied.
public IReadOnlyList<string> OpenApiDocumentNames { get; }Property Value
Section titled “Property Value”Pattern
Section titled “ Pattern”Gets the effective relative route pattern applied when this override rule matches.
public string? Pattern { get; }Property Value
Section titled “Property Value”PreserveImplicitQueryFallback
Section titled “ PreserveImplicitQueryFallback”Gets a value indicating whether this override rule opts the matched explicit-binding shorthand candidate into preserved implicit-query fallback for remaining unbound query properties.
public bool PreserveImplicitQueryFallback { get; }Property Value
Section titled “Property Value”RelativePatterns
Section titled “ RelativePatterns”Gets the shorthand relative route patterns targeted by this override rule before override actions are applied.
public IReadOnlyList<string> RelativePatterns { get; }Property Value
Section titled “Property Value”RemovedBindingProperties
Section titled “ RemovedBindingProperties”Gets the explicit shorthand binding properties removed from the source binding plan when this override rule matches.
public IReadOnlyList<string> RemovedBindingProperties { get; }Property Value
Section titled “Property Value”RequiredCapabilityKey
Section titled “ RequiredCapabilityKey”Gets the required Cephalon capability key enforced at the REST boundary when this override rule matches.
public string? RequiredCapabilityKey { get; }Property Value
Section titled “Property Value”RequiredFeatureFlagIds
Section titled “ RequiredFeatureFlagIds”Gets the required Cephalon feature-flag identifiers enforced at the REST boundary when this override rule matches.
public IReadOnlyList<string> RequiredFeatureFlagIds { get; }Property Value
Section titled “Property Value”RouteGroupPrefix
Section titled “ RouteGroupPrefix”Gets the effective published route-group prefix applied when this override rule matches.
public string? RouteGroupPrefix { get; }Property Value
Section titled “Property Value”RouteGroupPrefixes
Section titled “ RouteGroupPrefixes”Gets the published route-group prefixes targeted by this override 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 override rule.
public IReadOnlyList<string> SourceModuleIds { get; }Property Value
Section titled “Property Value”Summary
Section titled “ Summary”Gets the effective OpenAPI summary applied when this override rule matches.
public string? Summary { get; }Property Value
Section titled “Property Value”TagName
Section titled “ TagName”Gets the effective primary OpenAPI tag name applied when this override rule matches.
public string? TagName { get; }Property Value
Section titled “Property Value”TagNames
Section titled “ TagNames”Gets the original shorthand primary OpenAPI tag names targeted by this override rule before any 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 override rule before any override actions are applied.
public IReadOnlyList<RestEndpointBindingDescriptor> TargetBindings { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointBindingDescriptor>