REST Resource: regionUrlMaps

string

An optional description of this resource. Provide this property when you create the resource.

string

The list of host patterns to match. They must be valid hostnames with optional port numbers in the format

host

:

port

.

*

matches any string of

([a-z0-9-.]*)

. In that case,

*

must be the first character, and if followed by anything, the immediate following character must be either

-

or

.

.

*

based matching is not supported when the URL map is bound to a target gRPC proxy that has the

validateForProxyless

field set to

true

.

string

The name of the

PathMatcher

to use to match the path portion of the URL if the

hostRule

matches the URL's host portion.

string

The name to which this

PathMatcher

is referred by the

HostRule

.

string

An optional description of this resource. Provide this property when you create the resource.

string

The full or partial URL to the

BackendService

resource. This URL is used if none of the

pathRules

or

routeRules

defined by this

PathMatcher

are matched. For example, the following are all valid URLs to a

BackendService

resource:

• https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

• compute/v1/projects/project/global/backendServices/backendService

• global/backendServices/backendService

defaultRouteAction

is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

Only one of

defaultUrlRedirect

,

defaultService

or

defaultRouteAction.weightedBackendService

can be set.

Authorization requires one or more of the following Google IAM permissions on the specified resource defaultService:

• compute.backendBuckets.use

• compute.backendServices.use

object (HttpRouteAction)

defaultRouteAction

takes effect when none of the

pathRules

or

routeRules

match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

Only one of

defaultUrlRedirect

,

defaultService

or

defaultRouteAction.weightedBackendService

can be set.

URL maps for classic Application Load Balancers only support the

urlRewrite

action within a path matcher's

defaultRouteAction

.

object (HttpRedirectAction)

When none of the specified

pathRules

or

routeRules

match, the request is redirected to a URL specified by

defaultUrlRedirect

.

Only one of

defaultUrlRedirect

,

defaultService

or

defaultRouteAction.weightedBackendService

can be set.

Not supported when the URL map is bound to a target gRPC proxy.

object (PathRule)

The list of path rules. Use this list instead of

routeRules

when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

For example: a

pathRule

with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

Within a given

pathMatcher

, only one of

pathRules

or

routeRules

must be set.

object (HttpRouteRule)

The list of HTTP route rules. Use this list instead of

pathRules

when advanced route matching and routing actions are desired.

routeRules

are evaluated in order of priority, from the lowest to highest number.

Within a given

pathMatcher

, you can set only one of

pathRules

or

routeRules

.

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected backend service.

HeaderAction specified here are applied after the matching

HttpRouteRule

HeaderAction

and before the

HeaderAction

in the

UrlMap

HeaderAction

is not supported for load balancers that have their

loadBalancingScheme

set to

EXTERNAL

.

Not supported when the URL map is bound to a target gRPC proxy that has

validateForProxyless

field set to

true

.

object (CustomErrorResponsePolicy)

defaultCustomErrorResponsePolicy

specifies how the Load Balancer returns error responses when

BackendService

or

BackendBucket

responds with an error.

This policy takes effect at the

PathMatcher

level and applies only when no policy has been defined for the error code at lower levels like

RouteRule

and

PathRule

within this

PathMatcher

. If an error code does not have a policy defined in

defaultCustomErrorResponsePolicy

, then a policy defined for the error code in

UrlMap.defaultCustomErrorResponsePolicy

takes effect.

For example, consider a UrlMap with the following configuration:

• UrlMap.defaultCustomErrorResponsePolicy

  is configured with policies for

  5xx

  and

  4xx

  errors

• A RouteRule for

  /coming_soon/

  is configured for the error code

  404

  .

If the request is for

www.myotherdomain.com

and a

404

is encountered, the policy under

UrlMap.defaultCustomErrorResponsePolicy

takes effect. If a

404

response is encountered for the request

www.example.com/current_events/

, the pathMatcher's policy takes effect. If however, the request for

www.example.com/coming_soon/

encounters a

404

, the policy in

RouteRule.customErrorResponsePolicy

takes effect. If any of the requests in this example encounter a

500

error code, the policy at

UrlMap.defaultCustomErrorResponsePolicy

takes effect.

When used in conjunction with

pathMatcher.defaultRouteAction.retryPolicy

, retries take precedence. Only once all retries are exhausted, the

defaultCustomErrorResponsePolicy

is applied. While attempting a retry, if

load balancer

is successful in reaching the service, the

defaultCustomErrorResponsePolicy

is ignored and the response from the service is returned to the client.

defaultCustomErrorResponsePolicy

is supported only for global external Application Load Balancers.

object (WeightedBackendService)

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding

backend service

. If all traffic needs to go to a single backend service, there must be one

weightedBackendService

with weight set to a non-zero number.

After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this

HttpRouteAction

.

object (UrlRewrite)

The spec to modify the URL of the request, before forwarding the request to the matched service.

urlRewrite

is the only action supported in UrlMaps for classic Application Load Balancers.

Not supported when the URL map is bound to a target gRPC proxy that has the

validateForProxyless

field set to

true

.

object (Duration)

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries.

If not specified, this field uses the largest timeout among all backend services associated with the route.

Not supported when the URL map is bound to a target gRPC proxy that has

validateForProxyless

field set to

true

.

object (HttpRetryPolicy)

Specifies the retry policy associated with this route.

object (RequestMirrorPolicy)

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with

-shadow

.

Not supported when the URL map is bound to a target gRPC proxy that has the

validateForProxyless

field set to

true

.

object (CorsPolicy)

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.

Not supported when the URL map is bound to a target gRPC proxy.

object (HttpFaultInjection)

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.

timeout

and

retryPolicy

is ignored by clients that are configured with a

faultInjectionPolicy

if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the classic Application Load Balancer . To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.

object (Duration)

Specifies the maximum duration (timeout) for streams on the selected route. Unlike the

timeout

field where the timeout duration starts from the time the request has been fully processed (known as end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed.

If not specified, this field uses the maximum

maxStreamDuration

value among all backend services associated with the route.

This field is only allowed if the Url map is used with backend services with

loadBalancingScheme

set to

INTERNAL_SELF_MANAGED

.

string

The full or partial URL to the default

BackendService

resource. Before forwarding the request to

backendService

, the load balancer applies any relevant

headerActions

specified as part of this

backendServiceWeight

.

integer (uint32 format)

Specifies the fraction of traffic sent to a backend service, computed as

weight / (sum of all weightedBackendService weights in routeAction)

.

The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence.

The value must be from 0 to 1000.

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected

backendService

.

headerAction

specified here take effect before

headerAction

in the enclosing

HttpRouteRule

,

PathMatcher

and

UrlMap

.

headerAction

is not supported for load balancers that have their

loadBalancingScheme

set to

EXTERNAL

.

Not supported when the URL map is bound to a target gRPC proxy that has

validateForProxyless

field set to

true

.

string

A list of header names for headers that need to be removed from the request before forwarding the request to the

backendService

.

object (HttpHeaderOption)

Headers to add to a matching request before forwarding the request to the

backendService

.

string

A list of header names for headers that need to be removed from the response before sending the response back to the client.

object (HttpHeaderOption)

Headers to add the response before sending the response back to the client.

string

The name of the header.

string

The value of the header to add.

boolean

If

false

,

headerValue

is appended to any values that already exist for the header. If true,

headerValue

is set for the header, discarding any values that were set for that header.

The default value is

false

.

string

Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by

pathPrefixRewrite

.

The value must be from 1 to 1024 characters.

string

Before forwarding the request to the selected service, the request's host header is replaced with contents of

hostRewrite

.

The value must be from 1 to 255 characters.

string

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.

A corresponding pathTemplateMatch must be specified. Any template variables must exist in the pathTemplateMatch field.

• -At least one variable must be specified in the pathTemplateMatch field
• You can omit variables from the rewritten URL
• The

  *

  and

  **

  operators cannot be matched unless they have a corresponding variable name - e.g.

  {format=*}

  or

  {var=**}

  .

For example, a pathTemplateMatch of

/static/{format=**}

could be rewritten as

/static/content/{format}

to prefix

/content

to the URL. Variables can also be re-ordered in a rewrite, so that

/{country}/{format}/{suffix=**}

can be rewritten as

/content/{format}/{country}/{suffix}

.

At least one non-empty

routeRules[].matchRules[].path_template_match

is required.

Only one of

pathPrefixRewrite

or

pathTemplateRewrite

may be specified.

string

Specifies one or more conditions when this retry policy applies. Valid values are:

• 5xx

  : retry is attempted if the instance or endpoint responds with any

  5xx

  response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams.

• gateway-error

  : Similar to

  5xx

  , but only applies to response codes

  502

  ,

  503

  or

  504

  .

• connect-failure

  : a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts.

• retriable-4xx

  : a retry is attempted if the instance or endpoint responds with a

  4xx

  response code. The only error that you can retry is error code

  409

  .

• refused-stream

  : a retry is attempted if the instance or endpoint resets the stream with a

  REFUSED_STREAM

  error code. This reset type indicates that it is safe to retry.

• cancelled

  : a retry is attempted if the gRPC status code in the response header is set to

  cancelled

  .

• deadline-exceeded

  : a retry is attempted if the gRPC status code in the response header is set to

  deadline-exceeded

  .

• internal

  : a retry is attempted if the gRPC status code in the response header is set to

  internal

  .

• resource-exhausted

  : a retry is attempted if the gRPC status code in the response header is set to

  resource-exhausted

  .

• unavailable

  : a retry is attempted if the gRPC status code in the response header is set to

  unavailable

  .

Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

• cancelled

• deadline-exceeded

• internal

• resource-exhausted

• unavailable

integer (uint32 format)

Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

object (Duration)

Specifies a non-zero timeout per retry attempt.

If not specified, will use the timeout set in the

HttpRouteAction

field. If timeout in the

HttpRouteAction

field is not set, this field uses the largest timeout among all backend services associated with the route.

Not supported when the URL map is bound to a target gRPC proxy that has the

validateForProxyless

field set to

true

.

string

The full or partial URL to the

BackendService

resource being mirrored to.

The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map.

Serverless NEG backends are not currently supported as a mirrored backend service.

string

Specifies the list of origins that is allowed to do CORS requests.

An origin is allowed if it matches either an item in

allowOrigins

or an item in

allowOriginRegexes

.

string

Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax .

An origin is allowed if it matches either an item in

allowOrigins

or an item in

allowOriginRegexes

.

Regular expressions can only be used when the loadBalancingScheme is set to

INTERNAL_SELF_MANAGED

.

string

Specifies the content for the

Access-Control-Allow-Methods

header.

string

Specifies the content for the

Access-Control-Allow-Headers

header.

string

Specifies the content for the

Access-Control-Expose-Headers

header.

integer

Specifies how long results of a preflight request can be cached in seconds. This field translates to the

Access-Control-Max-Age

header.

boolean

In response to a preflight request, setting this to

true

indicates that the actual request can include user credentials. This field translates to the

Access-Control-Allow-Credentials

header.

Default is

false

.

boolean

If

true

, disables the CORS policy. The default value is

false

, which indicates that the CORS policy is in effect.

object (HttpFaultDelay)

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

object (HttpFaultAbort)

The specification for how client requests are aborted as part of fault injection.

object (Duration)

Specifies the value of the fixed delay interval.

number

The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection.

The value must be from 0.0 to 100.0 inclusive.

integer (uint32 format)

The HTTP status code used to abort the request.

The value must be from 200 to 599 inclusive.

For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

number

The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection.

The value must be from 0.0 to 100.0 inclusive.

string

The host that is used in the redirect response instead of the one that was supplied in the request.

The value must be from 1 to 255 characters.

string

The path that is used in the redirect response instead of the one that was supplied in the request.

pathRedirect

cannot be supplied together with

prefixRedirect

. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect.

The value must be from 1 to 1024 characters.

string

The prefix that replaces the

prefixMatch

specified in the

HttpRouteRuleMatch

, retaining the remaining portion of the URL before redirecting the request.

prefixRedirect

cannot be supplied together with

pathRedirect

. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect.

The value must be from 1 to 1024 characters.

enum (RedirectResponseCode)

The HTTP Status code to use for this RedirectAction.

Supported values are:

• MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
• FOUND, which corresponds to 302.
• SEE_OTHER which corresponds to 303.
• TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained.
• PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.

boolean

If set to

true

, the URL scheme in the redirected request is set to

HTTPS

. If set to

false

, the URL scheme of the redirected request remains the same as that of the request.

This must only be set for URL maps used in

TargetHttpProxy

s. Setting this true for

TargetHttpsProxy

is not permitted.

The default is set to

false

.

boolean

If set to

true

, any accompanying query portion of the original URL is removed before redirecting the request. If set to

false

, the query portion of the original URL is retained.

The default is set to

false

.

string

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If

routeAction

is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

Only one of

urlRedirect

,

service

or

routeAction.weightedBackendService

can be set.

object (HttpRouteAction)

In response to a matching

path

, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

Only one of

urlRedirect

,

service

or

routeAction.weightedBackendService

can be set.

URL maps for classic Application Load Balancers only support the

urlRewrite

action within a path rule's

routeAction

.

object (HttpRedirectAction)

When a path pattern is matched, the request is redirected to a URL specified by

urlRedirect

.

Only one of

urlRedirect

,

service

or

routeAction.weightedBackendService

can be set.

Not supported when the URL map is bound to a target gRPC proxy.

string

The list of path patterns to match. Each must start with

/

and the only place a

*

is allowed is at the end following a

/

. The string fed to the path matcher does not include any text after the first

?

or

#

, and those chars are not allowed here.

object (CustomErrorResponsePolicy)

customErrorResponsePolicy

specifies how the Load Balancer returns error responses when

BackendService

or

BackendBucket

responds with an error.

If a policy for an error code is not configured for the

PathRule

, a policy for the error code configured in

pathMatcher.defaultCustomErrorResponsePolicy

is applied. If one is not specified in

pathMatcher.defaultCustomErrorResponsePolicy

, the policy configured in

UrlMap.defaultCustomErrorResponsePolicy

takes effect.

For example, consider a UrlMap with the following configuration:

• UrlMap.defaultCustomErrorResponsePolicy

  are configured with policies for

  5xx

  and

  4xx

  errors

• A PathRule for

  /coming_soon/

  is configured for the error code

  404

  .

If the request is for

www.myotherdomain.com

and a

404

is encountered, the policy under

UrlMap.defaultCustomErrorResponsePolicy

takes effect. If a

404

response is encountered for the request

www.example.com/current_events/

, the pathMatcher's policy takes effect. If however, the request for

www.example.com/coming_soon/

encounters a

404

, the policy in

PathRule.customErrorResponsePolicy

takes effect. If any of the requests in this example encounter a

500

error code, the policy at

UrlMap.defaultCustomErrorResponsePolicy

takes effect.

customErrorResponsePolicy

is supported only for global external Application Load Balancers.

object (CustomErrorResponseRule)

Specifies rules for returning error responses.

In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for

401

(Un-authorized) code, and another for all 4 series error codes

(4XX)

. If the backend service returns a

401

, then the rule for

401

will be applied. However if the backend service returns a

403

, the rule for

4xx

takes effect.

string

The full or partial URL to the

BackendBucket

resource that contains the custom error content. Examples are:

• https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket

• compute/v1/projects/project/global/backendBuckets/myBackendBucket

• global/backendBuckets/myBackendBucket

If

errorService

is not specified at lower levels like

pathMatcher

,

pathRule

and

routeRule

, an

errorService

specified at a higher level in the

UrlMap

will be used. If

UrlMap.defaultCustomErrorResponsePolicy

contains one or more

errorResponseRules[]

, it must specify

errorService

.

If

load balancer

cannot reach the

backendBucket

, a simple

Not Found Error

will be returned, with the original response code (or

overrideResponseCode

if configured).

errorService

is not supported for internal or regional

HTTP/HTTPS

load balancers.

string

Valid values include:

• A number between 400 and 599

  : For example

  401

  or

  503

  , in which case the load balancer applies the policy if the error code exactly matches this value.

• 5xx

  : Load Balancer will apply the policy if the backend service responds with any response code in the range of

  500

  to

  599

  .

• 4xx

  : Load Balancer will apply the policy if the backend service responds with any response code in the range of

  400

  to

  499

  .

Values must be unique within matchResponseCodes and across all

errorResponseRules

of

CustomErrorResponsePolicy

.

string

The full path to a file within

backendBucket

. For example:

/errors/defaultError.html

path

must start with a leading slash.

path

cannot have trailing slashes.

If the file is not available in

backendBucket

or the load balancer cannot reach the

BackendBucket

, a simple

Not Found Error

is returned to the client.

The value must be from

1

to

1024

characters

integer

The HTTP status code returned with the response containing the custom error content. If

overrideResponseCode

is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.

integer

For

routeRules

within a given

pathMatcher

, priority determines the order in which a load balancer interprets

routeRules

.

RouteRules

are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive.

Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

string

The short description conveying the intent of this

routeRule

.

The description can have a maximum length of 1024 characters.

object (HttpRouteRuleMatch)

The list of criteria for matching attributes of a request to this

routeRule

. This list has OR semantics: the request matches this

routeRule

when any of the

matchRules

are satisfied. However predicates within a given

matchRule

have AND semantics. All predicates within a

matchRule

must match for the request to match the rule.

string

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If

routeAction

is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

Only one of

urlRedirect

,

service

or

routeAction.weightedBackendService

can be set.

object (HttpRouteAction)

In response to a matching

matchRule

, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

Only one of

urlRedirect

,

service

or

routeAction.weightedBackendService

can be set.

URL maps for classic Application Load Balancers only support the

urlRewrite

action within a route rule's

routeAction

.

object (HttpRedirectAction)

When this rule is matched, the request is redirected to a URL specified by

urlRedirect

.

Only one of

urlRedirect

,

service

or

routeAction.weightedBackendService

can be set.

Not supported when the URL map is bound to a target gRPC proxy.

object (HttpHeaderAction)

Specifies changes to request and response headers that need to take effect for the selected

backendService

.

The

headerAction

value specified here is applied before the matching

pathMatchers[].headerAction

and after

pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

HeaderAction

is not supported for load balancers that have their

loadBalancingScheme

set to

EXTERNAL

.

Not supported when the URL map is bound to a target gRPC proxy that has

validateForProxyless

field set to

true

.

object (CustomErrorResponsePolicy)

customErrorResponsePolicy

specifies how the Load Balancer returns error responses when

BackendService

or

BackendBucket

responds with an error.

If a policy for an error code is not configured for the

RouteRule

, a policy for the error code configured in

pathMatcher.defaultCustomErrorResponsePolicy

is applied. If one is not specified in

pathMatcher.defaultCustomErrorResponsePolicy

, the policy configured in

UrlMap.defaultCustomErrorResponsePolicy

takes effect.

For example, consider a UrlMap with the following configuration:

• UrlMap.defaultCustomErrorResponsePolicy

  are configured with policies for

  5xx

  and

  4xx

  errors

• A RouteRule for

  /coming_soon/

  is configured for the error code

  404

  .

If the request is for

www.myotherdomain.com

and a

404

is encountered, the policy under

UrlMap.defaultCustomErrorResponsePolicy

takes effect. If a

404

response is encountered for the request

www.example.com/current_events/

, the pathMatcher's policy takes effect. If however, the request for

www.example.com/coming_soon/

encounters a

404

, the policy in

RouteRule.customErrorResponsePolicy

takes effect. If any of the requests in this example encounter a

500

error code, the policy at

UrlMap.defaultCustomErrorResponsePolicy

takes effect.

When used in conjunction with

routeRules.routeAction.retryPolicy

, retries take precedence. Only once all retries are exhausted, the

customErrorResponsePolicy

is applied. While attempting a retry, if

load balancer

is successful in reaching the service, the

customErrorResponsePolicy

is ignored and the response from the service is returned to the client.

customErrorResponsePolicy

is supported only for global external Application Load Balancers.

string

For satisfying the

matchRule

condition, the request's path must begin with the specified

prefixMatch

.

prefixMatch

must begin with a

/

.

The value must be from 1 to 1024 characters.

Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

string

For satisfying the

matchRule

condition, the path of the request must exactly match the value specified in

fullPathMatch

after removing any query parameters and anchor that may be part of the original URL.

fullPathMatch

must be from 1 to 1024 characters.

Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

string

For satisfying the

matchRule

condition, the path of the request must satisfy the regular expression specified in

regexMatch

after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax.

Only one of

prefixMatch

,

fullPathMatch

or

regexMatch

must be specified.

Regular expressions can only be used when the loadBalancingScheme is set to

INTERNAL_SELF_MANAGED

.

boolean

Specifies that

prefixMatch

and

fullPathMatch

matches are case sensitive.

The default value is false.

ignoreCase must not be used with regexMatch.

Not supported when the URL map is bound to a target gRPC proxy.

object (HttpHeaderMatch)

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

object (HttpQueryParameterMatch)

Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Not supported when the URL map is bound to a target gRPC proxy.

object (MetadataFilter)

Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.

For each

metadataFilter

in this list, if its

filterMatchCriteria

is set to MATCH_ANY, at least one of the

filterLabels

must match the corresponding label provided in the metadata. If its

filterMatchCriteria

is set to MATCH_ALL, then all of its

filterLabels

must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match.

metadataFilters

specified here is applied after those specified in

ForwardingRule

that refers to the

UrlMap

this

HttpRouteRuleMatch

belongs to.

metadataFilters

only applies to load balancers that have

loadBalancingScheme

set to

INTERNAL_SELF_MANAGED

.

Not supported when the URL map is bound to a target gRPC proxy that has

validateForProxyless

field set to

true

.

string

If specified, the route is a pattern match expression that must match the :path header once the query string is removed.

A pattern match allows you to match

• The value must be between 1 and 1024 characters
• The pattern must start with a leading slash ("/")
• There may be no more than 5 operators in pattern

Precisely one of

prefixMatch

,

fullPathMatch

,

regexMatch

or

pathTemplateMatch

must be set.

string

The name of the HTTP header to match.

For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

For matching a request's method, use the headerName ":method".

When the URL map is bound to a target gRPC proxy that has the

validateForProxyless

field set to

true

, only non-binary user-specified custom metadata and the content-type header are supported. The following transport-level headers cannot be used in header matching rules: :authority, :method, :path, :scheme, user-agent, accept-encoding, content-encoding, grpc-accept-encoding, grpc-encoding, grpc-previous-rpc-attempts, grpc-tags-bin, grpc-timeout and grpc-trace-bin.

string

The value should exactly match contents of

exactMatch

.

Only one of

exactMatch

,

prefixMatch

,

suffixMatch

,

regexMatch

,

presentMatch

or

rangeMatch

must be set.

string

The value of the header must match the regular expression specified in

regexMatch

. For more information about regular expression syntax, see Syntax.

For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

Only one of

exactMatch

,

prefixMatch

,

suffixMatch

,

regexMatch

,

presentMatch

or

rangeMatch

must be set.

Regular expressions can only be used when the loadBalancingScheme is set to

INTERNAL_SELF_MANAGED

.

object (Int64RangeMatch)

The header value must be an integer and its value must be in the range specified in

rangeMatch

. If the header does not contain an integer, number or is empty, the match fails.

For example for a range [-5, 0]

• -3 will match.
• 0 will not match.
• 0.25 will not match.
• -3someString will not match.

Only one of

exactMatch

,

prefixMatch

,

suffixMatch

,

regexMatch

,

presentMatch

or

rangeMatch

must be set.

rangeMatch

is not supported for load balancers that have

loadBalancingScheme

set to

EXTERNAL

.

boolean

A header with the contents of

headerName

must exist. The match takes place whether or not the request's header has a value.

Only one of

exactMatch

,

prefixMatch

,

suffixMatch

,

regexMatch

,

presentMatch

or

rangeMatch

must be set.

string

The value of the header must start with the contents of

prefixMatch

.

Only one of

exactMatch

,

prefixMatch

,

suffixMatch

,

regexMatch

,

presentMatch

or

rangeMatch

must be set.

string

The value of the header must end with the contents of

suffixMatch

.

Only one of

exactMatch

,

prefixMatch

,

suffixMatch

,

regexMatch

,

presentMatch

or

rangeMatch

must be set.

boolean

If set to

false

, the

headerMatch

is considered a match if the preceding match criteria are met. If set to

true

, the

headerMatch

is considered a match if the preceding match criteria are NOT met.

The default setting is

false

.

string (int64 format)

The start of the range (inclusive) in signed long integer format.

string (int64 format)

The end of the range (exclusive) in signed long integer format.

string

The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

boolean

Specifies that the

queryParameterMatch

matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

Only one of

presentMatch

,

exactMatch

, or

regexMatch

must be set.

string

The

queryParameterMatch

matches if the value of the parameter exactly matches the contents of

exactMatch

.

Only one of

presentMatch

,

exactMatch

, or

regexMatch

must be set.

string

The

queryParameterMatch

matches if the value of the parameter matches the regular expression specified by

regexMatch

. For more information about regular expression syntax, see Syntax.

Only one of

presentMatch

,

exactMatch

, or

regexMatch

must be set.

Regular expressions can only be used when the loadBalancingScheme is set to

INTERNAL_SELF_MANAGED

.

string

Description of this test case.

string

Host portion of the URL. If

headers

contains a host header, then

host

must also match the header value.

string

Path portion of the URL.

object (Header)

HTTP headers for this request. If

headers

contains a host header, then

host

must also match the header value.

string

Expected

BackendService

or

BackendBucket

resource the given URL should be mapped to.

The

service

field cannot be set if

expectedRedirectResponseCode

is set.

string

The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters.

For rules that forward requests to backends, the test passes only when

expectedOutputUrl

matches the request forwarded by the load balancer to backends. For rules with

urlRewrite

, the test verifies that the forwarded request matches

hostRewrite

and

pathPrefixRewrite

in the

urlRewrite

action. When

service

is specified,

expectedOutputUrl

`s scheme is ignored.

For rules with

urlRedirect

, the test passes only if

expectedOutputUrl

matches the URL in the load balancer's redirect response. If

urlRedirect

specifies

httpsRedirect

, the test passes only if the scheme in

expectedOutputUrl

is also set to

HTTPS

. If

urlRedirect

specifies

stripQuery

, the test passes only if

expectedOutputUrl

does not contain any query parameters.

expectedOutputUrl

is optional when

service

is specified.

integer

For rules with

urlRedirect

, the test passes only if

expectedRedirectResponseCode

matches the HTTP status code in load balancer's redirect response.

expectedRedirectResponseCode

cannot be set when

service

is set.

string

Header name.

string

Header value.