Class RateLimitingOverrideSettings
Namespace: Cephalon.Engine.Configuration
Assembly: Cephalon.Engine.dll
Describes one named rate-limiting override configured for a subset of transports or behaviors.
public sealed class RateLimitingOverrideSettingsInheritance
Section titled “Inheritance”object ← RateLimitingOverrideSettings
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”RateLimitingOverrideSettings(string, IReadOnlyList<string>?, IReadOnlyList<string>?, bool?, string?, int?, int?, int?, int?)
Section titled “ RateLimitingOverrideSettings(string, IReadOnlyList<string>?, IReadOnlyList<string>?, bool?, string?, int?, int?, int?, int?)”Initializes a new instance of the
public RateLimitingOverrideSettings(string id, IReadOnlyList<string>? behaviorIds = null, IReadOnlyList<string>? transportIds = null, bool? enabled = null, string? algorithm = null, int? permitLimit = null, int? queueLimit = null, int? windowSeconds = null, int? segmentsPerWindow = null)Parameters
Section titled “Parameters”id string
The stable override identifier.
behaviorIds IReadOnlyList<string>?
The targeted behavior identifiers.
transportIds IReadOnlyList<string>?
The targeted transport identifiers.
enabled bool?
Whether the override explicitly enables or disables rate limiting.
algorithm string?
The requested rate-limiting algorithm, such as FixedWindow or TokenBucket.
permitLimit int?
The maximum permits available per limiter window or bucket.
queueLimit int?
The maximum queued requests allowed before rejection.
windowSeconds int?
The limiter window duration in seconds when the selected algorithm uses windows.
segmentsPerWindow int?
The number of segments per window when sliding windows are used.
Properties
Section titled “Properties”Algorithm
Section titled “ Algorithm”Gets the requested rate-limiting algorithm, such as FixedWindow or TokenBucket.
public string? Algorithm { get; }Property Value
Section titled “Property Value”BehaviorIds
Section titled “ BehaviorIds”Gets the targeted behavior identifiers.
public IReadOnlyList<string> BehaviorIds { get; }Property Value
Section titled “Property Value”Enabled
Section titled “ Enabled”Gets a value indicating whether rate limiting was explicitly enabled or disabled.
public bool? Enabled { get; }Property Value
Section titled “Property Value”bool?
HasValues
Section titled “ HasValues”Gets a value indicating whether any override settings were explicitly supplied.
public bool HasValues { get; }Property Value
Section titled “Property Value”Gets the stable override identifier.
public string Id { get; }Property Value
Section titled “Property Value”PermitLimit
Section titled “ PermitLimit”Gets the maximum permits available per limiter window or bucket.
public int? PermitLimit { get; }Property Value
Section titled “Property Value”int?
QueueLimit
Section titled “ QueueLimit”Gets the maximum queued requests allowed before rejection.
public int? QueueLimit { get; }Property Value
Section titled “Property Value”int?
SegmentsPerWindow
Section titled “ SegmentsPerWindow”Gets the number of segments per window when sliding windows are used.
public int? SegmentsPerWindow { get; }Property Value
Section titled “Property Value”int?
TransportIds
Section titled “ TransportIds”Gets the targeted transport identifiers.
public IReadOnlyList<string> TransportIds { get; }Property Value
Section titled “Property Value”WindowSeconds
Section titled “ WindowSeconds”Gets the limiter window duration in seconds when the selected algorithm uses windows.
public int? WindowSeconds { get; }Property Value
Section titled “Property Value”int?