Class RouteQueryParameter

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

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

Properties

| Improve this Doc View Source

IsCaseSensitive

Specifies whether query parameter 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 query parameter values should be compared (e.g. exact matches Vs. contains). Defaults to Exact.

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

Name

Name of the query parameter 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 query parameter values used during routing.

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

Methods

| Improve this Doc View Source

Equals(RouteQueryParameter)

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