Class QueryTransformExtensions

Extensions for adding query transforms.

Inheritance

System.Object

QueryTransformExtensions

Namespace: Yarp.ReverseProxy.Transforms

Assembly: Yarp.ReverseProxy.dll

Syntax

public static class QueryTransformExtensions : object

Methods

| Improve this Doc View Source

AddQueryRemoveKey(TransformBuilderContext, String)

Adds the transform that will remove the given query key.

Declaration

public static TransformBuilderContext AddQueryRemoveKey(this TransformBuilderContext context, string queryKey)

Parameters

Type	Name	Description
TransformBuilderContext	context
System.String	queryKey

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

AddQueryRouteValue(TransformBuilderContext, String, String, Boolean)

Adds the transform that will append or set the query parameter from a route value.

Declaration

public static TransformBuilderContext AddQueryRouteValue(this TransformBuilderContext context, string queryKey, string routeValueKey, bool append = true)

Parameters

Type	Name	Description
TransformBuilderContext	context
System.String	queryKey
System.String	routeValueKey
System.Boolean	append

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

AddQueryValue(TransformBuilderContext, String, String, Boolean)

Adds the transform that will append or set the query parameter from the given value.

Declaration

public static TransformBuilderContext AddQueryValue(this TransformBuilderContext context, string queryKey, string value, bool append = true)

Parameters

Type	Name	Description
TransformBuilderContext	context
System.String	queryKey
System.String	value
System.Boolean	append

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

WithTransformQueryRemoveKey(RouteConfig, String)

Clones the route and adds the transform that will remove the given query key.

Declaration

public static RouteConfig WithTransformQueryRemoveKey(this RouteConfig route, string queryKey)

Parameters

Type	Name	Description
RouteConfig	route
System.String	queryKey

Returns

Type	Description
RouteConfig

| Improve this Doc View Source

WithTransformQueryRouteValue(RouteConfig, String, String, Boolean)

Clones the route and adds the transform that will append or set the query parameter from a route value.

Declaration

public static RouteConfig WithTransformQueryRouteValue(this RouteConfig route, string queryKey, string routeValueKey, bool append = true)

Parameters

Type	Name	Description
RouteConfig	route
System.String	queryKey
System.String	routeValueKey
System.Boolean	append

Returns

Type	Description
RouteConfig

| Improve this Doc View Source

WithTransformQueryValue(RouteConfig, String, String, Boolean)

Clones the route and adds the transform that will append or set the query parameter from the given value.

Declaration

public static RouteConfig WithTransformQueryValue(this RouteConfig route, string queryKey, string value, bool append = true)

Parameters

Type	Name	Description
RouteConfig	route
System.String	queryKey
System.String	value
System.Boolean	append

Returns

Type	Description
RouteConfig