Class RateLimitingRuntimeDescriptor
Namespace: Cephalon.Abstractions.Resilience
Assembly: Cephalon.Abstractions.dll
Describes one effective HTTP rate-limiting policy exposed by the current runtime.
public sealed record RateLimitingRuntimeDescriptor : IEquatable<RateLimitingRuntimeDescriptor>Inheritance
Section titled “Inheritance”object ← RateLimitingRuntimeDescriptor
Implements
Section titled “Implements”IEquatable<RateLimitingRuntimeDescriptor>
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”RateLimitingRuntimeDescriptor(string, string, string, string, string, int, IReadOnlyList<string>, IReadOnlyList<string>, RateLimitingSelection, RateLimitingSelection, IReadOnlyDictionary<string, string>)
Section titled “ RateLimitingRuntimeDescriptor(string, string, string, string, string, int, IReadOnlyList<string>, IReadOnlyList<string>, RateLimitingSelection, RateLimitingSelection, IReadOnlyDictionary<string, string>)”Describes one effective HTTP rate-limiting policy exposed by the current runtime.
public RateLimitingRuntimeDescriptor(string Id, string DisplayName, string Description, string ExecutionMode, string Scope, int RejectionStatusCode, IReadOnlyList<string> TransportIds, IReadOnlyList<string> ExcludedPathPrefixes, RateLimitingSelection Requested, RateLimitingSelection Effective, IReadOnlyDictionary<string, string> Metadata)Parameters
Section titled “Parameters”Id string
The stable runtime policy identifier.
DisplayName string
The human-readable policy name.
Description string
The human-readable policy description.
ExecutionMode string
The enforcement mode used by the active host, such as aspnetcore-global-middleware or disabled.
Scope string
The runtime scope covered by the policy, such as public-http-endpoints.
RejectionStatusCode int
The HTTP status code returned when the limiter rejects a request.
TransportIds IReadOnlyList<string>
The transport identifiers whose HTTP surfaces are covered by the policy.
ExcludedPathPrefixes IReadOnlyList<string>
The rooted path prefixes intentionally excluded from enforcement, such as operator or documentation routes.
Requested RateLimitingSelection
The requested app-model selection that asked for rate limiting.
Effective RateLimitingSelection
The effective policy values after host defaults and adapter-specific normalization have been applied.
Metadata IReadOnlyDictionary<string, string>
Additional host-specific metadata describing the policy.
Properties
Section titled “Properties”Description
Section titled “ Description”The human-readable policy description.
public string Description { get; init; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”The human-readable policy name.
public string DisplayName { get; init; }Property Value
Section titled “Property Value”Effective
Section titled “ Effective”The effective policy values after host defaults and adapter-specific normalization have been applied.
public RateLimitingSelection Effective { get; init; }Property Value
Section titled “Property Value”ExcludedPathPrefixes
Section titled “ ExcludedPathPrefixes”The rooted path prefixes intentionally excluded from enforcement, such as operator or documentation routes.
public IReadOnlyList<string> ExcludedPathPrefixes { get; init; }Property Value
Section titled “Property Value”ExecutionMode
Section titled “ ExecutionMode”The enforcement mode used by the active host, such as aspnetcore-global-middleware or disabled.
public string ExecutionMode { get; init; }Property Value
Section titled “Property Value”The stable runtime policy identifier.
public string Id { get; init; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Additional host-specific metadata describing the policy.
public IReadOnlyDictionary<string, string> Metadata { get; init; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
RejectionStatusCode
Section titled “ RejectionStatusCode”The HTTP status code returned when the limiter rejects a request.
public int RejectionStatusCode { get; init; }Property Value
Section titled “Property Value”Requested
Section titled “ Requested”The requested app-model selection that asked for rate limiting.
public RateLimitingSelection Requested { get; init; }Property Value
Section titled “Property Value”The runtime scope covered by the policy, such as public-http-endpoints.
public string Scope { get; init; }Property Value
Section titled “Property Value”TransportIds
Section titled “ TransportIds”The transport identifiers whose HTTP surfaces are covered by the policy.
public IReadOnlyList<string> TransportIds { get; init; }