Class RouteMatch

Describes the matching criteria for a route.

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

Properties

| Improve this Doc View Source

Headers

Only match requests that contain all of these headers.

Declaration
public IReadOnlyList<RouteHeader>? Headers { get; set; }
Property Value
Type Description
System.Nullable<IReadOnlyList<RouteHeader>>
| Improve this Doc View Source

Hosts

Only match requests with the given Host header. Supports wildcards and ports. For unicode host names, do not use punycode.

Declaration
public IReadOnlyList<string>? Hosts { get; set; }
Property Value
Type Description
System.Nullable<IReadOnlyList<System.String>>
| Improve this Doc View Source

Methods

Only match requests that use these optional HTTP methods. E.g. GET, POST.

Declaration
public IReadOnlyList<string>? Methods { get; set; }
Property Value
Type Description
System.Nullable<IReadOnlyList<System.String>>
| Improve this Doc View Source

Path

Only match requests with the given Path pattern.

Declaration
public string? Path { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

QueryParameters

Only match requests that contain all of these query parameters.

Declaration
public IReadOnlyList<RouteQueryParameter>? QueryParameters { get; set; }
Property Value
Type Description
System.Nullable<IReadOnlyList<RouteQueryParameter>>

Methods

| Improve this Doc View Source

Equals(RouteMatch)

Declaration
public bool Equals(RouteMatch other)
Parameters
Type Name Description
RouteMatch 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<>