YarpRoute
Represents a route for YARP
type YarpRoute interface{}Methods
WithMatch WithMatch(match *YarpRouteMatch) YarpRouteParameters
match*YarpRouteMatch Returns
YarpRoute Returns a handle; failures surface later via Err().
WithMatchHeaders WithMatchHeaders(headers []*YarpRouteHeaderMatch) YarpRouteParameters
headers[]*YarpRouteHeaderMatch Returns
YarpRoute Returns a handle; failures surface later via Err().
WithMatchHosts WithMatchHosts(hosts []string) YarpRouteParameters
hosts[]string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithMatchMethods WithMatchMethods(methods []string) YarpRouteParameters
methods[]string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithMatchPath WithMatchPath(path string) YarpRouteParameters
pathstringReturns
YarpRoute Returns a handle; failures surface later via Err().
WithMatchRouteQueryParameter(queryParameters []*YarpRouteQueryParameterMatch) YarpRouteParameters
queryParameters []*YarpRouteQueryParameterMatch Returns
YarpRoute Returns a handle; failures surface later via Err().
WithMaxRequestBodySize WithMaxRequestBodySize(maxRequestBodySize float64) YarpRouteParameters
maxRequestBodySize float64Returns
YarpRoute Returns a handle; failures surface later via Err().
WithMetadata WithMetadata(metadata map[string]string) YarpRouteParameters
metadatamap[string]string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithOrder WithOrder(order *float64) YarpRouteParameters
order*float64Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransform WithTransform(transform map[string]string) YarpRouteParameters
transformmap[string]string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformClientCertHeader(headerName string) YarpRouteParameters
headerName stringReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformCopyRequestHeaders(options ...*WithTransformCopyRequestHeadersOptions) YarpRouteParameters
options...*WithTransformCopyRequestHeadersOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformCopyRequestHeadersOptions argument.
Copy*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformCopyResponseHeaders(options ...*WithTransformCopyResponseHeadersOptions) YarpRouteParameters
options...*WithTransformCopyResponseHeadersOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformCopyResponseHeadersOptions argument.
Copy*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformCopyResponseTrailers(options ...*WithTransformCopyResponseTrailersOptions) YarpRouteParameters
options...*WithTransformCopyResponseTrailersOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformCopyResponseTrailersOptions argument.
Copy*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformForwarded WithTransformForwarded(options ...*WithTransformForwardedOptions) YarpRouteParameters
options...*WithTransformForwardedOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformForwardedOptions argument.
UseHost *boolUseProto *boolForFormat *NodeFormat ByFormat *NodeFormat Action*ForwardedTransformActions Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformHttpMethodChange( fromHttpMethod string, toHttpMethod string,) YarpRouteParameters
fromHttpMethod stringtoHttpMethod stringReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformPathPrefix WithTransformPathPrefix(prefix string) YarpRouteParameters
prefixstringThe path prefix to add.Returns
YarpRoute The configured Yarp.
Returns a handle; failures surface later via Err().
WithTransformPathRemovePrefix(prefix string) YarpRouteParameters
prefixstringThe matching prefix to remove.Returns
YarpRoute The configured Yarp.
Returns a handle; failures surface later via Err().
WithTransformPathRouteValues(pattern string) YarpRouteParameters
patternstringThe route pattern to apply.Returns
YarpRoute The configured Yarp.
Returns a handle; failures surface later via Err().
WithTransformPathSet WithTransformPathSet(path string) YarpRouteParameters
pathstringThe path value to set.Returns
YarpRoute The configured Yarp.
Returns a handle; failures surface later via Err().
WithTransformQueryRemoveKey(queryKey string) YarpRouteParameters
queryKey stringReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformQueryRouteValue( queryKey string, routeValueKey string, options ...*WithTransformQueryRouteValueOptions,) YarpRouteParameters
queryKey stringrouteValueKey stringoptions...*WithTransformQueryRouteValueOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformQueryRouteValueOptions argument.
Append*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformQueryValue WithTransformQueryValue( queryKey string, value string, options ...*WithTransformQueryValueOptions,) YarpRouteParameters
queryKey stringvaluestringoptions...*WithTransformQueryValueOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformQueryValueOptions argument.
Append*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformRequestHeader( headerName string, value string, options ...*WithTransformRequestHeaderOptions,) YarpRouteParameters
headerName stringvaluestringoptions...*WithTransformRequestHeaderOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformRequestHeaderOptions argument.
Append*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformRequestHeaderRemove(headerName string) YarpRouteParameters
headerName stringReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformRequestHeaderRouteValue( headerName string, routeValueKey string, options ...*WithTransformRequestHeaderRouteValueOptions,) YarpRouteParameters
headerName stringrouteValueKey stringoptions...*WithTransformRequestHeaderRouteValueOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformRequestHeaderRouteValueOptions argument.
Append*boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformRequestHeadersAllowed(allowedHeaders []string) YarpRouteParameters
allowedHeaders []string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformResponseHeader( headerName string, value string, options ...*WithTransformResponseHeaderOptions,) YarpRouteParameters
headerName stringvaluestringoptions...*WithTransformResponseHeaderOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformResponseHeaderOptions argument.
Append*boolCondition*ResponseCondition Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformResponseHeaderRemove( headerName string, options ...*WithTransformResponseHeaderRemoveOptions,) YarpRouteParameters
headerName stringoptions...*WithTransformResponseHeaderRemoveOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformResponseHeaderRemoveOptions argument.
Condition*ResponseCondition Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformResponseHeadersAllowed(allowedHeaders []string) YarpRouteParameters
allowedHeaders []string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformResponseTrailer( headerName string, value string, options ...*WithTransformResponseTrailerOptions,) YarpRouteParameters
headerName stringvaluestringoptions...*WithTransformResponseTrailerOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformResponseTrailerOptions argument.
Append*boolCondition*ResponseCondition Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformResponseTrailerRemove( headerName string, options ...*WithTransformResponseTrailerRemoveOptions,) YarpRouteParameters
headerName stringoptions...*WithTransformResponseTrailerRemoveOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformResponseTrailerRemoveOptions argument.
Condition*ResponseCondition Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformResponseTrailersAllowed(allowedHeaders []string) YarpRouteParameters
allowedHeaders []string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransforms WithTransforms(transforms []map[string]string) YarpRouteParameters
transforms[]map[string]string Returns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformUseOriginalHostHeader(options ...*WithTransformUseOriginalHostHeaderOptions) YarpRouteParameters
options...*WithTransformUseOriginalHostHeaderOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformUseOriginalHostHeaderOptions argument.
UseOriginal *boolReturns
YarpRoute Returns a handle; failures surface later via Err().
WithTransformXForwarded WithTransformXForwarded(options ...*WithTransformXForwardedOptions) YarpRouteParameters
options...*WithTransformXForwardedOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithTransformXForwardedOptions argument.
HeaderPrefix *stringXDefault *ForwardedTransformActions XFor *ForwardedTransformActions XHost *ForwardedTransformActions XProto *ForwardedTransformActions XPrefix *ForwardedTransformActions Returns
YarpRoute Returns a handle; failures surface later via Err().