Class ContractVersionCheckOptions
- Namespace
- Excalibur.Dispatch.Options.Middleware
- Assembly
- Excalibur.Dispatch.dll
Configuration options for contract version check middleware.
public sealed class ContractVersionCheckOptions
- Inheritance
-
ContractVersionCheckOptions
- Inherited Members
- Extension Methods
Properties
BypassVersionCheckForTypes
Gets or sets message types that bypass version checking.
public string[]? BypassVersionCheckForTypes { get; set; }
Property Value
- string[]
The current BypassVersionCheckForTypes value.
Enabled
Gets or sets a value indicating whether contract version checking is enabled.
public bool Enabled { get; set; }
Property Value
- bool
Default is true.
FailOnIncompatibleVersions
Gets or sets a value indicating whether to fail on incompatible versions.
public bool FailOnIncompatibleVersions { get; set; }
Property Value
- bool
Default is true.
FailOnUnknownVersions
Gets or sets a value indicating whether to fail on unknown versions.
public bool FailOnUnknownVersions { get; set; }
Property Value
- bool
Default is false.
Headers
Gets or sets the header name configuration for version checking.
public VersionCheckHeaders Headers { get; set; }
Property Value
- VersionCheckHeaders
A VersionCheckHeaders instance with default header names.
RecordDeprecationMetrics
Gets or sets a value indicating whether to record deprecation metrics.
public bool RecordDeprecationMetrics { get; set; }
Property Value
- bool
Default is true.
RequireExplicitVersions
Gets or sets a value indicating whether explicit versions are required.
public bool RequireExplicitVersions { get; set; }
Property Value
- bool
Default is false.
SupportedVersions
Gets or sets the list of supported versions.
public string[]? SupportedVersions { get; set; }
Property Value
- string[]
The current SupportedVersions value.