Class StranglerFigRouteDescriptor
Namespace: Cephalon.Abstractions.Patterns
Assembly: Cephalon.Abstractions.dll
Describes one strangler-fig route owned by a Cephalon module.
public sealed class StranglerFigRouteDescriptorInheritance
Section titled “Inheritance”object ← StranglerFigRouteDescriptor
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”StranglerFigRouteDescriptor(string, string, string, string, string, StranglerFigTarget, string?, string?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)
Section titled “ StranglerFigRouteDescriptor(string, string, string, string, string, StranglerFigTarget, string?, string?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”Creates a strangler-fig route descriptor.
public StranglerFigRouteDescriptor(string id, string sourceModuleId, string displayName, string description, string pathPrefix, StranglerFigTarget preferredTarget = StranglerFigTarget.Modern, string? legacyEndpoint = null, string? modernEndpoint = null, IReadOnlyList<string>? methods = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable route identifier.
sourceModuleId string
The Cephalon module that owns the modern boundary for this route.
displayName string
The operator-facing route name.
description string
The human-readable description of the migration boundary.
pathPrefix string
The rooted path prefix that this route should match.
preferredTarget StranglerFigTarget
The preferred boundary for matched requests.
legacyEndpoint string?
The legacy boundary identifier or endpoint.
modernEndpoint string?
The modern Cephalon boundary identifier or endpoint.
methods IReadOnlyList<string>?
Optional request methods that this route should match.
metadata IReadOnlyDictionary<string, string>?
Optional route metadata.
Properties
Section titled “Properties”Description
Section titled “ Description”Gets the human-readable description of the migration boundary.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the operator-facing route name.
public string DisplayName { get; }Property Value
Section titled “Property Value”Gets the stable route identifier.
public string Id { get; }Property Value
Section titled “Property Value”LegacyEndpoint
Section titled “ LegacyEndpoint”Gets the legacy boundary identifier or endpoint when one is configured.
public string? LegacyEndpoint { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets optional route metadata.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Methods
Section titled “ Methods”Gets the normalized request methods that this route should match.
public IReadOnlyList<string> Methods { get; }Property Value
Section titled “Property Value”ModernEndpoint
Section titled “ ModernEndpoint”Gets the modern Cephalon boundary identifier or endpoint when one is configured.
public string? ModernEndpoint { get; }Property Value
Section titled “Property Value”PathPrefix
Section titled “ PathPrefix”Gets the rooted path prefix that should match this route.
public string PathPrefix { get; }Property Value
Section titled “Property Value”PreferredTarget
Section titled “ PreferredTarget”Gets the preferred boundary for matched requests.
public StranglerFigTarget PreferredTarget { get; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets the module that owns the modern Cephalon boundary for this route.
public string SourceModuleId { get; }