docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html
index e43230c..3680b4b 100644
--- a/docs/dyn/compute_beta.regionUrlMaps.html
+++ b/docs/dyn/compute_beta.regionUrlMaps.html
@@ -75,6 +75,9 @@
<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionUrlMaps.html">regionUrlMaps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(project, region, urlMap, requestId=None)</a></code></p>
<p class="firstline">Deletes the specified UrlMap resource.</p>
<p class="toc_element">
@@ -87,7 +90,7 @@
<code><a href="#invalidateCache">invalidateCache(project, region, urlMap, body=None, requestId=None)</a></code></p>
<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
<p class="firstline">Retrieves the list of UrlMap resources available to the specified project in the specified region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -103,6 +106,11 @@
<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(project, region, urlMap, requestId=None)</code>
<pre>Deletes the specified UrlMap resource.
@@ -197,6 +205,10 @@
#
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.
#
+ # For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.
+ #
+ # For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.
+ #
# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.
#
# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
@@ -204,7 +216,9 @@
"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules 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.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.
+ # defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -229,6 +243,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -245,9 +260,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -270,22 +287,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -317,8 +338,10 @@
},
"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
+ # defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -346,6 +369,8 @@
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here take effect after headerAction specified under pathMatcher.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -373,6 +398,7 @@
{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ # * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"A String",
],
"pathMatcher": "A 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.
@@ -387,6 +413,7 @@
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -411,6 +438,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -427,9 +455,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -452,22 +482,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -507,6 +541,7 @@
# - compute.backendServices.use
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -531,6 +566,8 @@
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -566,6 +603,7 @@
# Only one of routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -590,6 +628,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -606,9 +645,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -631,22 +672,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -680,6 +725,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
# If urlRedirect is specified, service or routeAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -710,6 +756,8 @@
# The description can have a maximum length of 1024 characters.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -733,7 +781,24 @@
"A String",
],
},
- "matchRules": [
+ "httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
# fullPathMatch must be between 1 and 1024 characters.
@@ -745,6 +810,7 @@
"headerName": "A String", # The name of the HTTP header to match.
# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".
# For matching a request's method, use the headerName ":method".
+ # When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.
"invertMatch": True or False, # 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.
# The default setting is false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.
@@ -773,10 +839,12 @@
"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
- "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of 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 provided in the metadata.
+ # Not supported when the URL map is bound to target gRPC proxy.
+ "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.
+ # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.
# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.
# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.
# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.
@@ -799,6 +867,7 @@
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
+ # Not supported when the URL map is bound to target gRPC proxy.
{ # HttpRouteRuleMatch criteria for a request's query parameter.
"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.
# Only one of presentMatch, exactMatch or regexMatch must be set.
@@ -820,7 +889,9 @@
# 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.
"routeAction": { # 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 urlRedirect, service or routeAction.weightedBackendService must be set.
+ # UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -845,6 +916,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -861,9 +933,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -886,22 +960,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -935,6 +1013,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -963,11 +1042,13 @@
"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"tests": [ # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Message for the expected URL mappings.
"description": "A String", # Description of this test case.
- "host": "A String", # Host portion of the URL.
+ "host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.
"path": "A String", # Path portion of the URL.
- "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ "service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ # service cannot be set if expectedRedirectResponseCode is set.
},
],
}</pre>
@@ -993,6 +1074,10 @@
#
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.
#
+ # For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.
+ #
+ # For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.
+ #
# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.
#
# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
@@ -1000,7 +1085,9 @@
"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules 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.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.
+ # defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -1025,6 +1112,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -1041,9 +1129,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -1066,22 +1156,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1113,8 +1207,10 @@
},
"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
+ # defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -1142,6 +1238,8 @@
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here take effect after headerAction specified under pathMatcher.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1169,6 +1267,7 @@
{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ # * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"A String",
],
"pathMatcher": "A 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.
@@ -1183,6 +1282,7 @@
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -1207,6 +1307,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -1223,9 +1324,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -1248,22 +1351,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1303,6 +1410,7 @@
# - compute.backendServices.use
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -1327,6 +1435,8 @@
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1362,6 +1472,7 @@
# Only one of routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -1386,6 +1497,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -1402,9 +1514,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -1427,22 +1541,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1476,6 +1594,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
# If urlRedirect is specified, service or routeAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -1506,6 +1625,8 @@
# The description can have a maximum length of 1024 characters.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1529,7 +1650,24 @@
"A String",
],
},
- "matchRules": [
+ "httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
# fullPathMatch must be between 1 and 1024 characters.
@@ -1541,6 +1679,7 @@
"headerName": "A String", # The name of the HTTP header to match.
# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".
# For matching a request's method, use the headerName ":method".
+ # When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.
"invertMatch": True or False, # 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.
# The default setting is false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.
@@ -1569,10 +1708,12 @@
"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
- "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of 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 provided in the metadata.
+ # Not supported when the URL map is bound to target gRPC proxy.
+ "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.
+ # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.
# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.
# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.
# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.
@@ -1595,6 +1736,7 @@
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
+ # Not supported when the URL map is bound to target gRPC proxy.
{ # HttpRouteRuleMatch criteria for a request's query parameter.
"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.
# Only one of presentMatch, exactMatch or regexMatch must be set.
@@ -1616,7 +1758,9 @@
# 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.
"routeAction": { # 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 urlRedirect, service or routeAction.weightedBackendService must be set.
+ # UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -1641,6 +1785,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -1657,9 +1802,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -1682,22 +1829,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -1731,6 +1882,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -1759,11 +1911,13 @@
"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"tests": [ # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Message for the expected URL mappings.
"description": "A String", # Description of this test case.
- "host": "A String", # Host portion of the URL.
+ "host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.
"path": "A String", # Path portion of the URL.
- "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ "service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ # service cannot be set if expectedRedirectResponseCode is set.
},
],
}
@@ -1915,7 +2069,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Retrieves the list of UrlMap resources available to the specified project in the specified region.
Args:
@@ -1935,6 +2089,7 @@
Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Returns:
An object of the form:
@@ -1952,6 +2107,10 @@
#
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.
#
+ # For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.
+ #
+ # For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.
+ #
# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.
#
# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
@@ -1959,7 +2118,9 @@
"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules 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.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.
+ # defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -1984,6 +2145,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -2000,9 +2162,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -2025,22 +2189,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2072,8 +2240,10 @@
},
"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
+ # defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -2101,6 +2271,8 @@
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here take effect after headerAction specified under pathMatcher.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2128,6 +2300,7 @@
{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ # * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"A String",
],
"pathMatcher": "A 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.
@@ -2142,6 +2315,7 @@
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -2166,6 +2340,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -2182,9 +2357,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -2207,22 +2384,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2262,6 +2443,7 @@
# - compute.backendServices.use
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -2286,6 +2468,8 @@
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2321,6 +2505,7 @@
# Only one of routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -2345,6 +2530,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -2361,9 +2547,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -2386,22 +2574,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2435,6 +2627,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
# If urlRedirect is specified, service or routeAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -2465,6 +2658,8 @@
# The description can have a maximum length of 1024 characters.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2488,7 +2683,24 @@
"A String",
],
},
- "matchRules": [
+ "httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
# fullPathMatch must be between 1 and 1024 characters.
@@ -2500,6 +2712,7 @@
"headerName": "A String", # The name of the HTTP header to match.
# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".
# For matching a request's method, use the headerName ":method".
+ # When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.
"invertMatch": True or False, # 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.
# The default setting is false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.
@@ -2528,10 +2741,12 @@
"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
- "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of 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 provided in the metadata.
+ # Not supported when the URL map is bound to target gRPC proxy.
+ "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.
+ # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.
# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.
# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.
# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.
@@ -2554,6 +2769,7 @@
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
+ # Not supported when the URL map is bound to target gRPC proxy.
{ # HttpRouteRuleMatch criteria for a request's query parameter.
"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.
# Only one of presentMatch, exactMatch or regexMatch must be set.
@@ -2575,7 +2791,9 @@
# 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.
"routeAction": { # 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 urlRedirect, service or routeAction.weightedBackendService must be set.
+ # UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -2600,6 +2818,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -2616,9 +2835,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -2641,22 +2862,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2690,6 +2915,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -2718,11 +2944,13 @@
"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"tests": [ # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Message for the expected URL mappings.
"description": "A String", # Description of this test case.
- "host": "A String", # Host portion of the URL.
+ "host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.
"path": "A String", # Path portion of the URL.
- "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ "service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ # service cannot be set if expectedRedirectResponseCode is set.
},
],
},
@@ -2779,6 +3007,10 @@
#
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.
#
+ # For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.
+ #
+ # For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.
+ #
# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.
#
# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
@@ -2786,7 +3018,9 @@
"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules 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.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.
+ # defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -2811,6 +3045,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -2827,9 +3062,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -2852,22 +3089,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2899,8 +3140,10 @@
},
"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
+ # defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -2928,6 +3171,8 @@
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here take effect after headerAction specified under pathMatcher.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -2955,6 +3200,7 @@
{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ # * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"A String",
],
"pathMatcher": "A 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.
@@ -2969,6 +3215,7 @@
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -2993,6 +3240,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -3009,9 +3257,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -3034,22 +3284,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3089,6 +3343,7 @@
# - compute.backendServices.use
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -3113,6 +3368,8 @@
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3148,6 +3405,7 @@
# Only one of routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -3172,6 +3430,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -3188,9 +3447,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -3213,22 +3474,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3262,6 +3527,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
# If urlRedirect is specified, service or routeAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -3292,6 +3558,8 @@
# The description can have a maximum length of 1024 characters.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3315,7 +3583,24 @@
"A String",
],
},
- "matchRules": [
+ "httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
# fullPathMatch must be between 1 and 1024 characters.
@@ -3327,6 +3612,7 @@
"headerName": "A String", # The name of the HTTP header to match.
# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".
# For matching a request's method, use the headerName ":method".
+ # When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.
"invertMatch": True or False, # 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.
# The default setting is false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.
@@ -3355,10 +3641,12 @@
"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
- "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of 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 provided in the metadata.
+ # Not supported when the URL map is bound to target gRPC proxy.
+ "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.
+ # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.
# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.
# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.
# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.
@@ -3381,6 +3669,7 @@
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
+ # Not supported when the URL map is bound to target gRPC proxy.
{ # HttpRouteRuleMatch criteria for a request's query parameter.
"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.
# Only one of presentMatch, exactMatch or regexMatch must be set.
@@ -3402,7 +3691,9 @@
# 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.
"routeAction": { # 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 urlRedirect, service or routeAction.weightedBackendService must be set.
+ # UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -3427,6 +3718,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -3443,9 +3735,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -3468,22 +3762,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3517,6 +3815,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -3545,11 +3844,13 @@
"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"tests": [ # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Message for the expected URL mappings.
"description": "A String", # Description of this test case.
- "host": "A String", # Host portion of the URL.
+ "host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.
"path": "A String", # Path portion of the URL.
- "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ "service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ # service cannot be set if expectedRedirectResponseCode is set.
},
],
}
@@ -3640,6 +3941,10 @@
#
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.
#
+ # For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.
+ #
+ # For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.
+ #
# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.
#
# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
@@ -3647,7 +3952,9 @@
"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules 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.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.
+ # defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -3672,6 +3979,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -3688,9 +3996,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -3713,22 +4023,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3760,8 +4074,10 @@
},
"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
+ # defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -3789,6 +4105,8 @@
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here take effect after headerAction specified under pathMatcher.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3816,6 +4134,7 @@
{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ # * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"A String",
],
"pathMatcher": "A 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.
@@ -3830,6 +4149,7 @@
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -3854,6 +4174,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -3870,9 +4191,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -3895,22 +4218,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -3950,6 +4277,7 @@
# - compute.backendServices.use
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -3974,6 +4302,8 @@
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4009,6 +4339,7 @@
# Only one of routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -4033,6 +4364,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -4049,9 +4381,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -4074,22 +4408,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4123,6 +4461,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
# If urlRedirect is specified, service or routeAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -4153,6 +4492,8 @@
# The description can have a maximum length of 1024 characters.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4176,7 +4517,24 @@
"A String",
],
},
- "matchRules": [
+ "httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
# fullPathMatch must be between 1 and 1024 characters.
@@ -4188,6 +4546,7 @@
"headerName": "A String", # The name of the HTTP header to match.
# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".
# For matching a request's method, use the headerName ":method".
+ # When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.
"invertMatch": True or False, # 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.
# The default setting is false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.
@@ -4216,10 +4575,12 @@
"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
- "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of 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 provided in the metadata.
+ # Not supported when the URL map is bound to target gRPC proxy.
+ "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.
+ # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.
# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.
# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.
# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.
@@ -4242,6 +4603,7 @@
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
+ # Not supported when the URL map is bound to target gRPC proxy.
{ # HttpRouteRuleMatch criteria for a request's query parameter.
"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.
# Only one of presentMatch, exactMatch or regexMatch must be set.
@@ -4263,7 +4625,9 @@
# 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.
"routeAction": { # 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 urlRedirect, service or routeAction.weightedBackendService must be set.
+ # UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -4288,6 +4652,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -4304,9 +4669,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -4329,22 +4696,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4378,6 +4749,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -4406,11 +4778,13 @@
"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"tests": [ # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Message for the expected URL mappings.
"description": "A String", # Description of this test case.
- "host": "A String", # Host portion of the URL.
+ "host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.
"path": "A String", # Path portion of the URL.
- "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ "service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ # service cannot be set if expectedRedirectResponseCode is set.
},
],
}
@@ -4502,6 +4876,10 @@
#
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.
#
+ # For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.
+ #
+ # For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.
+ #
# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.
#
# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.
@@ -4509,7 +4887,9 @@
"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules 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.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.
+ # defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -4534,6 +4914,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -4550,9 +4931,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -4575,22 +4958,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4622,8 +5009,10 @@
},
"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
+ # defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -4651,6 +5040,8 @@
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here take effect after headerAction specified under pathMatcher.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4678,6 +5069,7 @@
{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ # * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"A String",
],
"pathMatcher": "A 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.
@@ -4692,6 +5084,7 @@
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -4716,6 +5109,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -4732,9 +5126,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -4757,22 +5153,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4812,6 +5212,7 @@
# - compute.backendServices.use
"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -4836,6 +5237,8 @@
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4871,6 +5274,7 @@
# Only one of routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -4895,6 +5299,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -4911,9 +5316,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -4936,22 +5343,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -4985,6 +5396,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
# If urlRedirect is specified, service or routeAction must not be set.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -5015,6 +5427,8 @@
# The description can have a maximum length of 1024 characters.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.
# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -5038,7 +5452,24 @@
"A String",
],
},
- "matchRules": [
+ "httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
+ # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
+ { # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.
+ "config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl
+ "configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct
+ "filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm
+ },
+ ],
+ "matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
# fullPathMatch must be between 1 and 1024 characters.
@@ -5050,6 +5481,7 @@
"headerName": "A String", # The name of the HTTP header to match.
# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".
# For matching a request's method, use the headerName ":method".
+ # When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.
"invertMatch": True or False, # 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.
# The default setting is false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.
@@ -5078,10 +5510,12 @@
"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
- "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of 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 provided in the metadata.
+ # Not supported when the URL map is bound to target gRPC proxy.
+ "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies.
+ # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.
# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.
# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.
# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.
@@ -5104,6 +5538,7 @@
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
+ # Not supported when the URL map is bound to target gRPC proxy.
{ # HttpRouteRuleMatch criteria for a request's query parameter.
"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.
# Only one of presentMatch, exactMatch or regexMatch must be set.
@@ -5125,7 +5560,9 @@
# 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.
"routeAction": { # 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 urlRedirect, service or routeAction.weightedBackendService must be set.
+ # UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.
"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing
+ # Not supported when the URL map is bound to target gRPC proxy.
"allowCredentials": True or False, # 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.
# Default is false.
"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.
@@ -5150,6 +5587,7 @@
},
"faultInjectionPolicy": { # 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. # 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 retry_policy will be ignored by clients that are configured with a fault_injection_policy.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.
"httpStatus": 42, # The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
@@ -5166,9 +5604,11 @@
},
},
"requestMirrorPolicy": { # A policy that specifies 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. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.
},
"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
@@ -5191,22 +5631,26 @@
},
"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"nanos": 42, # 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": "A 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
},
"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.
# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"hostRewrite": "A 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": "A 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.
},
- "weightedBackendServices": [ # 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.
+ "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.
+ # Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.
{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService
"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # 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.
+ # Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.
{ # Specification determining how headers are added to requests or responses.
"headerName": "A String", # The name of the header.
@@ -5240,6 +5684,7 @@
# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
"urlRedirect": { # Specifies settings for an HTTP redirect. # 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.
+ # Not supported when the URL map is bound to target gRPC proxy.
"hostRedirect": "A 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": True or False, # 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.
@@ -5268,11 +5713,13 @@
"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"tests": [ # 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.
+ # Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
{ # Message for the expected URL mappings.
"description": "A String", # Description of this test case.
- "host": "A String", # Host portion of the URL.
+ "host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.
"path": "A String", # Path portion of the URL.
- "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ "service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ # service cannot be set if expectedRedirectResponseCode is set.
},
],
},
@@ -5290,10 +5737,10 @@
"loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
"testFailures": [
{
- "actualService": "A String",
- "expectedService": "A String",
- "host": "A String",
- "path": "A String",
+ "actualService": "A String", # BackendService or BackendBucket returned by load balancer.
+ "expectedService": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.
+ "host": "A String", # Host portion of the URL.
+ "path": "A String", # Path portion including query parameters in the URL.
},
],
"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.