Class RouteHeader

Namespace

Yarp.ReverseProxy.Configuration

Assembly

Yarp.ReverseProxy.dll

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

public sealed record RouteHeader : IEquatable<RouteHeader>

Inheritance

object

RouteHeader

Implements

IEquatable<RouteHeader>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

RouteHeader()

public RouteHeader()

Properties

IsCaseSensitive

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

public bool IsCaseSensitive { get; init; }

Property Value

bool

Mode

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

public HeaderMatchMode Mode { get; init; }

Property Value

HeaderMatchMode

Name

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

public string Name { get; init; }

Property Value

string

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.

public IReadOnlyList<string>? Values { get; init; }

Property Value

IReadOnlyList<string>

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(RouteHeader?)

public bool Equals(RouteHeader? other)

Parameters

other RouteHeader

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public RouteHeader <Clone>$()

Returns

RouteHeader

Operators

operator ==(RouteHeader?, RouteHeader?)

public static bool operator ==(RouteHeader? left, RouteHeader? right)

Parameters

left RouteHeader

right RouteHeader

Returns

bool

operator !=(RouteHeader?, RouteHeader?)

public static bool operator !=(RouteHeader? left, RouteHeader? right)

Parameters

left RouteHeader

right RouteHeader

Returns

bool