URLMap

UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL.

To get more information about UrlMap, see:

API documentation

Create a URLMap Resource

new URLMap(name: string, args?: URLMapArgs, opts?: CustomResourceOptions);

def URLMap(resource_name, opts=None, default_route_action=None, default_service=None, default_url_redirect=None, description=None, header_action=None, host_rules=None, name=None, path_matchers=None, project=None, tests=None, __props__=None);

func NewURLMap(ctx *Context, name string, args *URLMapArgs, opts ...ResourceOption) (*URLMap, error)

public URLMap(string name, URLMapArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args URLMapArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args URLMapArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args URLMapArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

URLMap Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The URLMap resource accepts the following input properties:

DefaultRouteAction URLMapDefaultRouteActionArgs: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
DefaultService string: The backend service or backend bucket to use when none of the given paths match.
DefaultUrlRedirect URLMapDefaultUrlRedirectArgs: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
Description string: Description of this test case.
HeaderAction URLMapHeaderActionArgs: 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. Structure is documented below.
HostRules List<URLMapHostRuleArgs>: The list of HostRules to use against the URL. Structure is documented below.
Name 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.
PathMatchers List<URLMapPathMatcherArgs>: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tests List<URLMapTestArgs>: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

DefaultRouteAction URLMapDefaultRouteAction: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
DefaultService string: The backend service or backend bucket to use when none of the given paths match.
DefaultUrlRedirect URLMapDefaultUrlRedirect: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
Description string: Description of this test case.
HeaderAction URLMapHeaderAction: 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. Structure is documented below.
HostRules []URLMapHostRule: The list of HostRules to use against the URL. Structure is documented below.
Name 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.
PathMatchers []URLMapPathMatcher: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tests []URLMapTest: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

defaultRouteAction URLMapDefaultRouteAction: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
defaultService string: The backend service or backend bucket to use when none of the given paths match.
defaultUrlRedirect URLMapDefaultUrlRedirect: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
description string: Description of this test case.
headerAction URLMapHeaderAction: 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. Structure is documented below.
hostRules URLMapHostRule[]: The list of HostRules to use against the URL. Structure is documented below.
name 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.
pathMatchers URLMapPathMatcher[]: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tests URLMapTest[]: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

default_route_action Dict[URLMapDefaultRouteAction]: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
default_service str: The backend service or backend bucket to use when none of the given paths match.
default_url_redirect Dict[URLMapDefaultUrlRedirect]: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
description str: Description of this test case.
header_action Dict[URLMapHeaderAction]: 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. Structure is documented below.
host_rules List[URLMapHostRule]: The list of HostRules to use against the URL. Structure is documented below.
name str: 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.
path_matchers List[URLMapPathMatcher]: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tests List[URLMapTest]: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the URLMap resource produces the following output properties:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Fingerprint string: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
Id string: The provider-assigned unique ID for this managed resource.
MapId int: The unique identifier for the resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Fingerprint string: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
Id string: The provider-assigned unique ID for this managed resource.
MapId int: The unique identifier for the resource.
SelfLink string: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
fingerprint string: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
id string: The provider-assigned unique ID for this managed resource.
mapId number: The unique identifier for the resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
fingerprint str: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
id str: The provider-assigned unique ID for this managed resource.
map_id float: The unique identifier for the resource.
self_link str: The URI of the created resource.

Look up an Existing URLMap Resource

Get an existing URLMap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: URLMapState, opts?: CustomResourceOptions): URLMap

static get(resource_name, id, opts=None, creation_timestamp=None, default_route_action=None, default_service=None, default_url_redirect=None, description=None, fingerprint=None, header_action=None, host_rules=None, map_id=None, name=None, path_matchers=None, project=None, self_link=None, tests=None, __props__=None);

func GetURLMap(ctx *Context, name string, id IDInput, state *URLMapState, opts ...ResourceOption) (*URLMap, error)

public static URLMap Get(string name, Input<string> id, URLMapState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
DefaultRouteAction URLMapDefaultRouteActionArgs: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
DefaultService string: The backend service or backend bucket to use when none of the given paths match.
DefaultUrlRedirect URLMapDefaultUrlRedirectArgs: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
Description string: Description of this test case.
Fingerprint string: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
HeaderAction URLMapHeaderActionArgs: 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. Structure is documented below.
HostRules List<URLMapHostRuleArgs>: The list of HostRules to use against the URL. Structure is documented below.
MapId int: The unique identifier for the resource.
Name 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.
PathMatchers List<URLMapPathMatcherArgs>: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Tests List<URLMapTestArgs>: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
DefaultRouteAction URLMapDefaultRouteAction: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
DefaultService string: The backend service or backend bucket to use when none of the given paths match.
DefaultUrlRedirect URLMapDefaultUrlRedirect: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
Description string: Description of this test case.
Fingerprint string: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
HeaderAction URLMapHeaderAction: 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. Structure is documented below.
HostRules []URLMapHostRule: The list of HostRules to use against the URL. Structure is documented below.
MapId int: The unique identifier for the resource.
Name 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.
PathMatchers []URLMapPathMatcher: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Tests []URLMapTest: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

creationTimestamp string: Creation timestamp in RFC3339 text format.
defaultRouteAction URLMapDefaultRouteAction: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
defaultService string: The backend service or backend bucket to use when none of the given paths match.
defaultUrlRedirect URLMapDefaultUrlRedirect: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
description string: Description of this test case.
fingerprint string: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
headerAction URLMapHeaderAction: 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. Structure is documented below.
hostRules URLMapHostRule[]: The list of HostRules to use against the URL. Structure is documented below.
mapId number: The unique identifier for the resource.
name 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.
pathMatchers URLMapPathMatcher[]: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
selfLink string: The URI of the created resource.
tests URLMapTest[]: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

creation_timestamp str: Creation timestamp in RFC3339 text format.
default_route_action Dict[URLMapDefaultRouteAction]: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
default_service str: The backend service or backend bucket to use when none of the given paths match.
default_url_redirect Dict[URLMapDefaultUrlRedirect]: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
description str: Description of this test case.
fingerprint str: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
header_action Dict[URLMapHeaderAction]: 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. Structure is documented below.
host_rules List[URLMapHostRule]: The list of HostRules to use against the URL. Structure is documented below.
map_id float: The unique identifier for the resource.
name str: 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.
path_matchers List[URLMapPathMatcher]: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
self_link str: The URI of the created resource.
tests List[URLMapTest]: The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

Supporting Types

URLMapDefaultRouteAction

CorsPolicy URLMapDefaultRouteActionCorsPolicyArgs: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapDefaultRouteActionFaultInjectionPolicyArgs: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapDefaultRouteActionRequestMirrorPolicyArgs: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapDefaultRouteActionRetryPolicyArgs: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapDefaultRouteActionTimeoutArgs: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapDefaultRouteActionUrlRewriteArgs: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices List<URLMapDefaultRouteActionWeightedBackendServiceArgs>: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

CorsPolicy URLMapDefaultRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapDefaultRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapDefaultRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapDefaultRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapDefaultRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapDefaultRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices []URLMapDefaultRouteActionWeightedBackendService: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy URLMapDefaultRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy URLMapDefaultRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy URLMapDefaultRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy URLMapDefaultRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
timeout URLMapDefaultRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite URLMapDefaultRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices URLMapDefaultRouteActionWeightedBackendService[]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy Dict[URLMapDefaultRouteActionCorsPolicy]: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy Dict[URLMapDefaultRouteActionFaultInjectionPolicy]: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy Dict[URLMapDefaultRouteActionRequestMirrorPolicy]: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy Dict[URLMapDefaultRouteActionRetryPolicy]: Specifies the retry policy associated with this route. Structure is documented below.
timeout Dict[URLMapDefaultRouteActionTimeout]: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite Dict[URLMapDefaultRouteActionUrlRewrite]: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices List[URLMapDefaultRouteActionWeightedBackendService]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

URLMapDefaultRouteActionCorsPolicy

AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders List<string>: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods List<string>: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes List<string>: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins List<string>: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
ExposeHeaders List<string>: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders []string: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods []string: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes []string: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins []string: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
ExposeHeaders []string: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

allowCredentials boolean: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders string[]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods string[]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes string[]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins string[]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled boolean: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
exposeHeaders string[]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge number: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

allowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders List[str]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods List[str]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes List[str]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins List[str]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
exposeHeaders List[str]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge float: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

URLMapDefaultRouteActionFaultInjectionPolicy

Abort URLMapDefaultRouteActionFaultInjectionPolicyAbortArgs: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapDefaultRouteActionFaultInjectionPolicyDelayArgs: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

Abort URLMapDefaultRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapDefaultRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort URLMapDefaultRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay URLMapDefaultRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort Dict[URLMapDefaultRouteActionFaultInjectionPolicyAbort]: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay Dict[URLMapDefaultRouteActionFaultInjectionPolicyDelay]: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

URLMapDefaultRouteActionFaultInjectionPolicyAbort

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus number: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus float: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapDefaultRouteActionFaultInjectionPolicyDelay

FixedDelay URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelayArgs: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

FixedDelay URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay Dict[URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelay]: Specifies the value of the fixed delay interval. Structure is documented below.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelay

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

URLMapDefaultRouteActionRequestMirrorPolicy

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

backendService string: The full or partial URL to the BackendService resource being mirrored to.

backend_service str: The full or partial URL to the BackendService resource being mirrored to.

URLMapDefaultRouteActionRetryPolicy

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapDefaultRouteActionRetryPolicyPerTryTimeoutArgs: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions List<string>: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapDefaultRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions []string: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries number: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout URLMapDefaultRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions string[]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries float: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout Dict[URLMapDefaultRouteActionRetryPolicyPerTryTimeout]: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions List[str]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

URLMapDefaultRouteActionRetryPolicyPerTryTimeout

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

URLMapDefaultRouteActionTimeout

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

URLMapDefaultRouteActionUrlRewrite

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite str: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite str: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

URLMapDefaultRouteActionWeightedBackendService

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
HeaderAction URLMapDefaultRouteActionWeightedBackendServiceHeaderActionArgs: 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. Structure is documented below.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
HeaderAction URLMapDefaultRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

backendService string: The full or partial URL to the BackendService resource being mirrored to.
headerAction URLMapDefaultRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.
weight number: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

backend_service str: The full or partial URL to the BackendService resource being mirrored to.
header_action Dict[URLMapDefaultRouteActionWeightedBackendServiceHeaderAction]: 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. Structure is documented below.
weight float: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

URLMapDefaultRouteActionWeightedBackendServiceHeaderAction

RequestHeadersToAdds List<URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapDefaultUrlRedirect

StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

stripQuery boolean: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
hostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

stripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
hostRedirect str: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect str: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect str: 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode str: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

URLMapHeaderAction

RequestHeadersToAdds List<URLMapHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapHostRule

Hosts List<string>: The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
PathMatcher 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.
Description string: Description of this test case.

Hosts []string: The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
PathMatcher 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.
Description string: Description of this test case.

hosts string[]: The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
pathMatcher 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.
description string: Description of this test case.

hosts List[str]: The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
pathMatcher str: The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.
description str: Description of this test case.

URLMapPathMatcher

Name 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.
DefaultRouteAction URLMapPathMatcherDefaultRouteActionArgs: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
DefaultService string: The backend service or backend bucket to use when none of the given paths match.
DefaultUrlRedirect URLMapPathMatcherDefaultUrlRedirectArgs: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
Description string: Description of this test case.
HeaderAction URLMapPathMatcherHeaderActionArgs: 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. Structure is documented below.
PathRules List<URLMapPathMatcherPathRuleArgs>: 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. Structure is documented below.
RouteRules List<URLMapPathMatcherRouteRuleArgs>: The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

Name 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.
DefaultRouteAction URLMapPathMatcherDefaultRouteAction: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
DefaultService string: The backend service or backend bucket to use when none of the given paths match.
DefaultUrlRedirect URLMapPathMatcherDefaultUrlRedirect: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
Description string: Description of this test case.
HeaderAction URLMapPathMatcherHeaderAction: 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. Structure is documented below.
PathRules []URLMapPathMatcherPathRule: 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. Structure is documented below.
RouteRules []URLMapPathMatcherRouteRule: The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

name 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.
defaultRouteAction URLMapPathMatcherDefaultRouteAction: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
defaultService string: The backend service or backend bucket to use when none of the given paths match.
defaultUrlRedirect URLMapPathMatcherDefaultUrlRedirect: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
description string: Description of this test case.
headerAction URLMapPathMatcherHeaderAction: 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. Structure is documented below.
pathRules URLMapPathMatcherPathRule[]: 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. Structure is documented below.
routeRules URLMapPathMatcherRouteRule[]: The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

name str: 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.
default_route_action Dict[URLMapPathMatcherDefaultRouteAction]: defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
default_service str: The backend service or backend bucket to use when none of the given paths match.
default_url_redirect Dict[URLMapPathMatcherDefaultUrlRedirect]: When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.
description str: Description of this test case.
header_action Dict[URLMapPathMatcherHeaderAction]: 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. Structure is documented below.
pathRules List[URLMapPathMatcherPathRule]: 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. Structure is documented below.
routeRules List[URLMapPathMatcherRouteRule]: The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

URLMapPathMatcherDefaultRouteAction

CorsPolicy URLMapPathMatcherDefaultRouteActionCorsPolicyArgs: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyArgs: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapPathMatcherDefaultRouteActionRequestMirrorPolicyArgs: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapPathMatcherDefaultRouteActionRetryPolicyArgs: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapPathMatcherDefaultRouteActionTimeoutArgs: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapPathMatcherDefaultRouteActionUrlRewriteArgs: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices List<URLMapPathMatcherDefaultRouteActionWeightedBackendServiceArgs>: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

CorsPolicy URLMapPathMatcherDefaultRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapPathMatcherDefaultRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapPathMatcherDefaultRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapPathMatcherDefaultRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapPathMatcherDefaultRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapPathMatcherDefaultRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices []URLMapPathMatcherDefaultRouteActionWeightedBackendService: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy URLMapPathMatcherDefaultRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy URLMapPathMatcherDefaultRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy URLMapPathMatcherDefaultRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy URLMapPathMatcherDefaultRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
timeout URLMapPathMatcherDefaultRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite URLMapPathMatcherDefaultRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices URLMapPathMatcherDefaultRouteActionWeightedBackendService[]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy Dict[URLMapPathMatcherDefaultRouteActionCorsPolicy]: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy Dict[URLMapPathMatcherDefaultRouteActionFaultInjectionPolicy]: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy Dict[URLMapPathMatcherDefaultRouteActionRequestMirrorPolicy]: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy Dict[URLMapPathMatcherDefaultRouteActionRetryPolicy]: Specifies the retry policy associated with this route. Structure is documented below.
timeout Dict[URLMapPathMatcherDefaultRouteActionTimeout]: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite Dict[URLMapPathMatcherDefaultRouteActionUrlRewrite]: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices List[URLMapPathMatcherDefaultRouteActionWeightedBackendService]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

URLMapPathMatcherDefaultRouteActionCorsPolicy

AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders List<string>: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods List<string>: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes List<string>: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins List<string>: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
ExposeHeaders List<string>: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders []string: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods []string: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes []string: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins []string: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
ExposeHeaders []string: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

allowCredentials boolean: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders string[]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods string[]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes string[]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins string[]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled boolean: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
exposeHeaders string[]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge number: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

allowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders List[str]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods List[str]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes List[str]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins List[str]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
exposeHeaders List[str]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge float: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

URLMapPathMatcherDefaultRouteActionFaultInjectionPolicy

Abort URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbortArgs: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayArgs: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

Abort URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort Dict[URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbort]: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay Dict[URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelay]: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbort

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus number: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus float: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelay

FixedDelay URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelayArgs: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

FixedDelay URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay Dict[URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelay]: Specifies the value of the fixed delay interval. Structure is documented below.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelay

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

URLMapPathMatcherDefaultRouteActionRequestMirrorPolicy

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

backendService string: The full or partial URL to the BackendService resource being mirrored to.

backend_service str: The full or partial URL to the BackendService resource being mirrored to.

URLMapPathMatcherDefaultRouteActionRetryPolicy

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeoutArgs: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions List<string>: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions []string: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries number: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions string[]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries float: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout Dict[URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeout]: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions List[str]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeout

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

URLMapPathMatcherDefaultRouteActionTimeout

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

URLMapPathMatcherDefaultRouteActionUrlRewrite

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite str: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite str: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

URLMapPathMatcherDefaultRouteActionWeightedBackendService

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
HeaderAction URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionArgs: 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. Structure is documented below.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
HeaderAction URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

backendService string: The full or partial URL to the BackendService resource being mirrored to.
headerAction URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.
weight number: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

backend_service str: The full or partial URL to the BackendService resource being mirrored to.
header_action Dict[URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderAction]: 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. Structure is documented below.
weight float: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderAction

RequestHeadersToAdds List<URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherDefaultUrlRedirect

StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

stripQuery boolean: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
hostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

stripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
hostRedirect str: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect str: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect str: 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode str: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

URLMapPathMatcherHeaderAction

RequestHeadersToAdds List<URLMapPathMatcherHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapPathMatcherHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapPathMatcherHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapPathMatcherHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapPathMatcherHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapPathMatcherHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapPathMatcherHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapPathMatcherHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapPathMatcherHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherPathRule

Paths List<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.
RouteAction URLMapPathMatcherPathRuleRouteActionArgs: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
Service string: The backend service or backend bucket link that should be matched by this test.
UrlRedirect URLMapPathMatcherPathRuleUrlRedirectArgs: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

Paths []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.
RouteAction URLMapPathMatcherPathRuleRouteAction: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
Service string: The backend service or backend bucket link that should be matched by this test.
UrlRedirect URLMapPathMatcherPathRuleUrlRedirect: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

paths 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.
routeAction URLMapPathMatcherPathRuleRouteAction: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
service string: The backend service or backend bucket link that should be matched by this test.
urlRedirect URLMapPathMatcherPathRuleUrlRedirect: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

paths List[str]: 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.
routeAction Dict[URLMapPathMatcherPathRuleRouteAction]: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
service str: The backend service or backend bucket link that should be matched by this test.
urlRedirect Dict[URLMapPathMatcherPathRuleUrlRedirect]: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

URLMapPathMatcherPathRuleRouteAction

CorsPolicy URLMapPathMatcherPathRuleRouteActionCorsPolicyArgs: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyArgs: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicyArgs: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapPathMatcherPathRuleRouteActionRetryPolicyArgs: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapPathMatcherPathRuleRouteActionTimeoutArgs: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapPathMatcherPathRuleRouteActionUrlRewriteArgs: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices List<URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceArgs>: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

CorsPolicy URLMapPathMatcherPathRuleRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapPathMatcherPathRuleRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapPathMatcherPathRuleRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapPathMatcherPathRuleRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices []URLMapPathMatcherPathRuleRouteActionWeightedBackendService: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy URLMapPathMatcherPathRuleRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy URLMapPathMatcherPathRuleRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
timeout URLMapPathMatcherPathRuleRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite URLMapPathMatcherPathRuleRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices URLMapPathMatcherPathRuleRouteActionWeightedBackendService[]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy Dict[URLMapPathMatcherPathRuleRouteActionCorsPolicy]: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy Dict[URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicy]: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy Dict[URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicy]: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy Dict[URLMapPathMatcherPathRuleRouteActionRetryPolicy]: Specifies the retry policy associated with this route. Structure is documented below.
timeout Dict[URLMapPathMatcherPathRuleRouteActionTimeout]: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite Dict[URLMapPathMatcherPathRuleRouteActionUrlRewrite]: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices List[URLMapPathMatcherPathRuleRouteActionWeightedBackendService]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

URLMapPathMatcherPathRuleRouteActionCorsPolicy

Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders List<string>: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods List<string>: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes List<string>: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins List<string>: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
ExposeHeaders List<string>: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders []string: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods []string: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes []string: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins []string: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
ExposeHeaders []string: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

disabled boolean: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
allowCredentials boolean: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders string[]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods string[]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes string[]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins string[]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
exposeHeaders string[]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge number: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
allowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders List[str]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods List[str]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes List[str]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins List[str]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
exposeHeaders List[str]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge float: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicy

Abort URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbortArgs: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayArgs: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

Abort URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort Dict[URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort]: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay Dict[URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay]: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus number: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus float: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay

FixedDelay URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelayArgs: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

FixedDelay URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay Dict[URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay]: Specifies the value of the fixed delay interval. Structure is documented below.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicy

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

backendService string: The full or partial URL to the BackendService resource being mirrored to.

backend_service str: The full or partial URL to the BackendService resource being mirrored to.

URLMapPathMatcherPathRuleRouteActionRetryPolicy

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeoutArgs: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions List<string>: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions []string: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries number: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions string[]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries float: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout Dict[URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout]: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions List[str]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

URLMapPathMatcherPathRuleRouteActionTimeout

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

URLMapPathMatcherPathRuleRouteActionUrlRewrite

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite str: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite str: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

URLMapPathMatcherPathRuleRouteActionWeightedBackendService

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
HeaderAction URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionArgs: 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. Structure is documented below.

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
HeaderAction URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.

backendService string: The full or partial URL to the BackendService resource being mirrored to.
weight number: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
headerAction URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.

backend_service str: The full or partial URL to the BackendService resource being mirrored to.
weight float: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
header_action Dict[URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction]: 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. Structure is documented below.

URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction

RequestHeadersToAdds List<URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherPathRuleUrlRedirect

StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

stripQuery boolean: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
hostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

stripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
hostRedirect str: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect str: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect str: 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode str: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

URLMapPathMatcherRouteRule

Priority int: For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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.
HeaderAction URLMapPathMatcherRouteRuleHeaderActionArgs: 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. Structure is documented below.
MatchRules List<URLMapPathMatcherRouteRuleMatchRuleArgs>: The rules for determining a match. Structure is documented below.
RouteAction URLMapPathMatcherRouteRuleRouteActionArgs: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
Service string: The backend service or backend bucket link that should be matched by this test.
UrlRedirect URLMapPathMatcherRouteRuleUrlRedirectArgs: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

Priority int: For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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.
HeaderAction URLMapPathMatcherRouteRuleHeaderAction: 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. Structure is documented below.
MatchRules []URLMapPathMatcherRouteRuleMatchRule: The rules for determining a match. Structure is documented below.
RouteAction URLMapPathMatcherRouteRuleRouteAction: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
Service string: The backend service or backend bucket link that should be matched by this test.
UrlRedirect URLMapPathMatcherRouteRuleUrlRedirect: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

priority number: For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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.
headerAction URLMapPathMatcherRouteRuleHeaderAction: 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. Structure is documented below.
matchRules URLMapPathMatcherRouteRuleMatchRule[]: The rules for determining a match. Structure is documented below.
routeAction URLMapPathMatcherRouteRuleRouteAction: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
service string: The backend service or backend bucket link that should be matched by this test.
urlRedirect URLMapPathMatcherRouteRuleUrlRedirect: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

priority float: For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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.
header_action Dict[URLMapPathMatcherRouteRuleHeaderAction]: 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. Structure is documented below.
matchRules List[URLMapPathMatcherRouteRuleMatchRule]: The rules for determining a match. Structure is documented below.
routeAction Dict[URLMapPathMatcherRouteRuleRouteAction]: In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.
service str: The backend service or backend bucket link that should be matched by this test.
urlRedirect Dict[URLMapPathMatcherRouteRuleUrlRedirect]: When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

URLMapPathMatcherRouteRuleHeaderAction

RequestHeadersToAdds List<URLMapPathMatcherRouteRuleHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapPathMatcherRouteRuleHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherRouteRuleMatchRule

FullPathMatch string: For satifying 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 between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
HeaderMatches List<URLMapPathMatcherRouteRuleMatchRuleHeaderMatchArgs>: Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.
IgnoreCase bool: Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false.
MetadataFilters List<URLMapPathMatcherRouteRuleMatchRuleMetadataFilterArgs>: Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, 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 in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.
PrefixMatch 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.
QueryParameterMatches List<URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatchArgs>: Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.
RegexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

FullPathMatch string: For satifying 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 between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
HeaderMatches []URLMapPathMatcherRouteRuleMatchRuleHeaderMatch: Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.
IgnoreCase bool: Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false.
MetadataFilters []URLMapPathMatcherRouteRuleMatchRuleMetadataFilter: Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, 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 in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.
PrefixMatch 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.
QueryParameterMatches []URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatch: Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.
RegexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

fullPathMatch string: For satifying 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 between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
headerMatches URLMapPathMatcherRouteRuleMatchRuleHeaderMatch[]: Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.
ignoreCase boolean: Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false.
metadataFilters URLMapPathMatcherRouteRuleMatchRuleMetadataFilter[]: Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, 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 in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.
prefixMatch 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.
queryParameterMatches URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatch[]: Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.
regexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

fullPathMatch str: For satifying 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 between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
headerMatches List[URLMapPathMatcherRouteRuleMatchRuleHeaderMatch]: Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.
ignoreCase bool: Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false.
metadata_filters List[URLMapPathMatcherRouteRuleMatchRuleMetadataFilter]: Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, 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 in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.
prefixMatch str: 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.
queryParameterMatches List[URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatch]: Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.
regexMatch str: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

URLMapPathMatcherRouteRuleMatchRuleHeaderMatch

HeaderName string: The name of the header to add.
ExactMatch string: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
InvertMatch bool: If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false.
PrefixMatch 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.
PresentMatch bool: 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 and regexMatch must be set.
RangeMatch URLMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatchArgs: 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. Structure is documented below.
RegexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.
SuffixMatch 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.

HeaderName string: The name of the header to add.
ExactMatch string: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
InvertMatch bool: If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false.
PrefixMatch 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.
PresentMatch bool: 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 and regexMatch must be set.
RangeMatch URLMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch: 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. Structure is documented below.
RegexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.
SuffixMatch 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.

headerName string: The name of the header to add.
exactMatch string: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
invertMatch boolean: If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false.
prefixMatch 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.
presentMatch 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 and regexMatch must be set.
rangeMatch URLMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch: 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. Structure is documented below.
regexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.
suffixMatch 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.

headerName str: The name of the header to add.
exactMatch str: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
invertMatch bool: If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false.
prefixMatch str: 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.
presentMatch bool: 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 and regexMatch must be set.
rangeMatch Dict[URLMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch]: 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. Structure is documented below.
regexMatch str: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.
suffixMatch str: 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.

URLMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch

RangeEnd int: The end of the range (exclusive).
RangeStart int: The start of the range (inclusive).

RangeEnd int: The end of the range (exclusive).
RangeStart int: The start of the range (inclusive).

rangeEnd number: The end of the range (exclusive).
rangeStart number: The start of the range (inclusive).

rangeEnd float: The end of the range (exclusive).
rangeStart float: The start of the range (inclusive).

URLMapPathMatcherRouteRuleMatchRuleMetadataFilter

FilterLabels List<URLMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabelArgs>: The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.
FilterMatchCriteria string: Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

FilterLabels []URLMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel: The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.
FilterMatchCriteria string: Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

filterLabels URLMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel[]: The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.
filterMatchCriteria string: Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

filterLabels List[URLMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel]: The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.
filterMatchCriteria str: Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

URLMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel

Name 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.
Value string: The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Name 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.
Value string: The value of the label must match the specified value. value can have a maximum length of 1024 characters.

name 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.
value string: The value of the label must match the specified value. value can have a maximum length of 1024 characters.

name str: 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.
value str: The value of the label must match the specified value. value can have a maximum length of 1024 characters.

URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatch

Name 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.
ExactMatch string: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
PresentMatch bool: 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 and regexMatch must be set.
RegexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

Name 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.
ExactMatch string: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
PresentMatch bool: 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 and regexMatch must be set.
RegexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

name 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.
exactMatch string: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
presentMatch 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 and regexMatch must be set.
regexMatch string: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

name str: 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.
exactMatch str: The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
presentMatch bool: 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 and regexMatch must be set.
regexMatch str: The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

URLMapPathMatcherRouteRuleRouteAction

CorsPolicy URLMapPathMatcherRouteRuleRouteActionCorsPolicyArgs: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyArgs: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapPathMatcherRouteRuleRouteActionRequestMirrorPolicyArgs: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapPathMatcherRouteRuleRouteActionRetryPolicyArgs: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapPathMatcherRouteRuleRouteActionTimeoutArgs: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapPathMatcherRouteRuleRouteActionUrlRewriteArgs: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices List<URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceArgs>: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

CorsPolicy URLMapPathMatcherRouteRuleRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
FaultInjectionPolicy URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
RequestMirrorPolicy URLMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
RetryPolicy URLMapPathMatcherRouteRuleRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
Timeout URLMapPathMatcherRouteRuleRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
UrlRewrite URLMapPathMatcherRouteRuleRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
WeightedBackendServices []URLMapPathMatcherRouteRuleRouteActionWeightedBackendService: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy URLMapPathMatcherRouteRuleRouteActionCorsPolicy: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy URLMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy URLMapPathMatcherRouteRuleRouteActionRetryPolicy: Specifies the retry policy associated with this route. Structure is documented below.
timeout URLMapPathMatcherRouteRuleRouteActionTimeout: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite URLMapPathMatcherRouteRuleRouteActionUrlRewrite: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices URLMapPathMatcherRouteRuleRouteActionWeightedBackendService[]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

corsPolicy Dict[URLMapPathMatcherRouteRuleRouteActionCorsPolicy]: The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
faultInjectionPolicy Dict[URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy]: 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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
requestMirrorPolicy Dict[URLMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy]: Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.
retryPolicy Dict[URLMapPathMatcherRouteRuleRouteActionRetryPolicy]: Specifies the retry policy associated with this route. Structure is documented below.
timeout Dict[URLMapPathMatcherRouteRuleRouteActionTimeout]: Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
urlRewrite Dict[URLMapPathMatcherRouteRuleRouteActionUrlRewrite]: The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
weightedBackendServices List[URLMapPathMatcherRouteRuleRouteActionWeightedBackendService]: 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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

URLMapPathMatcherRouteRuleRouteActionCorsPolicy

AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders List<string>: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods List<string>: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes List<string>: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins List<string>: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
ExposeHeaders List<string>: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

AllowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
AllowHeaders []string: Specifies the content for the Access-Control-Allow-Headers header.
AllowMethods []string: Specifies the content for the Access-Control-Allow-Methods header.
AllowOriginRegexes []string: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
AllowOrigins []string: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
Disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
ExposeHeaders []string: Specifies the content for the Access-Control-Expose-Headers header.
MaxAge int: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

allowCredentials boolean: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders string[]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods string[]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes string[]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins string[]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled boolean: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
exposeHeaders string[]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge number: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

allowCredentials bool: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.
allowHeaders List[str]: Specifies the content for the Access-Control-Allow-Headers header.
allowMethods List[str]: Specifies the content for the Access-Control-Allow-Methods header.
allowOriginRegexes List[str]: Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
allowOrigins List[str]: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled bool: If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
exposeHeaders List[str]: Specifies the content for the Access-Control-Expose-Headers header.
maxAge float: Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy

Abort URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbortArgs: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayArgs: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

Abort URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
Delay URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

abort Dict[URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort]: The specification for how client requests are aborted as part of fault injection. Structure is documented below.
delay Dict[URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay]: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

HttpStatus int: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus number: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

httpStatus float: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay

FixedDelay URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelayArgs: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage double: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

FixedDelay URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
Percentage float64: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay: Specifies the value of the fixed delay interval. Structure is documented below.
percentage number: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

fixedDelay Dict[URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay]: Specifies the value of the fixed delay interval. Structure is documented below.
percentage float: The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

URLMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

URLMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

BackendService string: The full or partial URL to the BackendService resource being mirrored to.

backendService string: The full or partial URL to the BackendService resource being mirrored to.

backend_service str: The full or partial URL to the BackendService resource being mirrored to.

URLMapPathMatcherRouteRuleRouteActionRetryPolicy

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeoutArgs: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions List<string>: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

NumRetries int: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
PerTryTimeout URLMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
RetryConditions []string: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries number: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout URLMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions string[]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

numRetries float: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
perTryTimeout Dict[URLMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout]: Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
retryConditions List[str]: Specfies one or more conditions when this retry rule applies. Valid values are: 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, 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: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

URLMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

URLMapPathMatcherRouteRuleRouteActionTimeout

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Nanos int: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos number: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos float: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

URLMapPathMatcherRouteRuleRouteActionUrlRewrite

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

HostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
PathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite string: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite string: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

hostRewrite str: Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
pathPrefixRewrite str: Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

URLMapPathMatcherRouteRuleRouteActionWeightedBackendService

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
HeaderAction URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionArgs: 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. Structure is documented below.

BackendService string: The full or partial URL to the BackendService resource being mirrored to.
Weight int: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
HeaderAction URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.

backendService string: The full or partial URL to the BackendService resource being mirrored to.
weight number: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
headerAction URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction: 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. Structure is documented below.

backend_service str: The full or partial URL to the BackendService resource being mirrored to.
weight float: Specifies the fraction of traffic sent to backendService, 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 backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000
header_action Dict[URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction]: 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. Structure is documented below.

URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction

RequestHeadersToAdds List<URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs>: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds List<URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs>: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves List<string>: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

RequestHeadersToAdds []URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
RequestHeadersToRemoves []string: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
ResponseHeadersToAdds []URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd: Headers to add the response prior to sending the response back to the client. Structure is documented below.
ResponseHeadersToRemoves []string: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves string[]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd[]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves string[]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

requestHeadersToAdds List[URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd]: Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
requestHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
responseHeadersToAdds List[URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd]: Headers to add the response prior to sending the response back to the client. Structure is documented below.
responseHeadersToRemoves List[str]: A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

HeaderName string: The name of the header to add.
HeaderValue string: The value of the header to add.
Replace bool: 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.

headerName string: The name of the header to add.
headerValue string: The value of the header to add.
replace 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.

headerName str: The name of the header to add.
headerValue str: The value of the header to add.
replace bool: 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.

URLMapPathMatcherRouteRuleUrlRedirect

HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.

HostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
HttpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
PathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
PrefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
RedirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
StripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.

hostRedirect string: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect string: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode string: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
stripQuery boolean: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.

hostRedirect str: The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
httpsRedirect bool: 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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
pathRedirect str: The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.
prefixRedirect str: 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 will be used for the redirect. The value must be between 1 and 1024 characters.
redirectResponseCode str: 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
stripQuery bool: If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.

URLMapTest

Host string: Host portion of the URL.
Path string: Path portion of the URL.
Service string: The backend service or backend bucket link that should be matched by this test.
Description string: Description of this test case.

Host string: Host portion of the URL.
Path string: Path portion of the URL.
Service string: The backend service or backend bucket link that should be matched by this test.
Description string: Description of this test case.

host string: Host portion of the URL.
path string: Path portion of the URL.
service string: The backend service or backend bucket link that should be matched by this test.
description string: Description of this test case.

host str: Host portion of the URL.
path str: Path portion of the URL.
service str: The backend service or backend bucket link that should be matched by this test.
description str: Description of this test case.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud