Class RouteHeader

Route criteria for a header that must be present on the incoming request.

Inheritance
System.Object
RouteHeader
Implements
System.IEquatable<RouteHeader>
Namespace: Yarp.ReverseProxy.Configuration
Assembly: Yarp.ReverseProxy.dll
Syntax
public sealed class RouteHeader : object

Properties

| Improve this Doc View Source

IsCaseSensitive

Specifies whether header value comparisons should ignore case. When true, is used. When false, is used. Defaults to false.

Declaration
public bool IsCaseSensitive { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Mode

Specifies how header values should be compared (e.g. exact matches Vs. by prefix). Defaults to ExactHeader.

Declaration
public HeaderMatchMode Mode { get; set; }
Property Value
Type Description
HeaderMatchMode
| Improve this Doc View Source

Name

Name of the header to look for. This field is case insensitive and required.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Values

A collection of acceptable header values used during routing. Only one value must match. The list must not be empty unless using Exists or NotExists.

Declaration
public IReadOnlyList<string>? Values { get; set; }
Property Value
Type Description
System.Nullable<IReadOnlyList<System.String>>

Methods

| Improve this Doc View Source

Equals(RouteHeader)

Declaration
public bool Equals(RouteHeader other)
Parameters
Type Name Description
RouteHeader other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Implements

System.IEquatable<>