Class RouteQueryParameter

Namespace

Yarp.ReverseProxy.Configuration

Assembly

Yarp.ReverseProxy.dll

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

public sealed record RouteQueryParameter : IEquatable<RouteQueryParameter>

Inheritance

object

RouteQueryParameter

Implements

IEquatable<RouteQueryParameter>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

RouteQueryParameter()

public RouteQueryParameter()

Properties

IsCaseSensitive

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

public QueryParameterMatchMode Mode { get; init; }

Property Value

QueryParameterMatchMode

Name

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

public string Name { get; init; }

Property Value

string

Values

A collection of acceptable query parameter values used during routing.

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(RouteQueryParameter?)

public bool Equals(RouteQueryParameter? other)

Parameters

other RouteQueryParameter

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public RouteQueryParameter <Clone>$()

Returns

RouteQueryParameter

Operators

operator ==(RouteQueryParameter?, RouteQueryParameter?)

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

Parameters

left RouteQueryParameter

right RouteQueryParameter

Returns

bool

operator !=(RouteQueryParameter?, RouteQueryParameter?)

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

Parameters

left RouteQueryParameter

right RouteQueryParameter

Returns

bool