1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.urlMaps.html">urlMaps</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79<p class="firstline">Retrieves the list of all UrlMap resources, regional and global, available to the specified project.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(project, urlMap, requestId=None)</a></code></p> 85<p class="firstline">Deletes the specified UrlMap resource.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, urlMap)</a></code></p> 88<p class="firstline">Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a UrlMap resource in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#invalidateCache">invalidateCache(project, urlMap, body, requestId=None)</a></code></p> 94<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97<p class="firstline">Retrieves the list of UrlMap resources available to the specified project.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(project, urlMap, body, requestId=None)</a></code></p> 103<p class="firstline">Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 106<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 107<p class="toc_element"> 108 <code><a href="#update">update(project, urlMap, body, requestId=None)</a></code></p> 109<p class="firstline">Updates the specified UrlMap resource with the data included in the request.</p> 110<p class="toc_element"> 111 <code><a href="#validate">validate(project, urlMap, body)</a></code></p> 112<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> 113<h3>Method Details</h3> 114<div class="method"> 115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 116 <pre>Retrieves the list of all UrlMap resources, regional and global, available to the specified project. 117 118Args: 119 project: string, Name of the project scoping this request. (required) 120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 121 122You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 123 124Currently, only sorting by name or creationTimestamp desc is supported. 125 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 126 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. 127 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 128 129For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 130 131You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 132 133To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 134 135Returns: 136 An object of the form: 137 138 { 139 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 140 "kind": "compute#urlMapsAggregatedList", # Type of resource. 141 "items": { # A list of UrlMapsScopedList resources. 142 "a_key": { # Name of the scope containing this set of UrlMaps. 143 "urlMaps": [ # A list of UrlMaps contained in this scope. 144 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. 145 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 146 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 147 "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. 148 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 149 "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. 150 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 151 }, 152 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 153 "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. 154 "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. 155 "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 156 }, 157 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 158 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 159 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 160 # - 161 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 162 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 163 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 164 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 165 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 166 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 167 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 168 "A String", 169 ], 170 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 171 }, 172 "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. 173 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 174 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 175 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 176 # The value must be between 0.0 and 100.0 inclusive. 177 "fixedDelay": { # 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 value of the fixed delay interval. 178 "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. 179 "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 180 }, 181 }, 182 "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. 183 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 184 # The value must be between 0.0 and 100.0 inclusive. 185 "httpStatus": 42, # The HTTP status code used to abort the request. 186 # The value must be between 200 and 599 inclusive. 187 }, 188 }, 189 "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 190 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 191 "A String", 192 ], 193 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 194 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 195 "A String", 196 ], 197 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 198 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 199 "A String", 200 ], 201 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 202 "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. 203 # Default is false. 204 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 205 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 206 "A String", 207 ], 208 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 209 "A String", 210 ], 211 }, 212 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 213 # If not specified, the default value is 15 seconds. 214 "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. 215 "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 216 }, 217 "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. 218 # 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. 219 { # 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 220 "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. 221 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 222 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 223 "A String", 224 ], 225 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 226 "A String", 227 ], 228 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 229 { # Specification determining how headers are added to requests or responses. 230 "headerName": "A String", # The name of the header. 231 "headerValue": "A String", # The value of the header to add. 232 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 233 # The default value is false. 234 }, 235 ], 236 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 237 { # Specification determining how headers are added to requests or responses. 238 "headerName": "A String", # The name of the header. 239 "headerValue": "A String", # The value of the header to add. 240 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 241 # The default value is false. 242 }, 243 ], 244 }, 245 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 246 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 247 # The value must be between 0 and 1000 248 "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. 249 }, 250 ], 251 "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 252 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 253 # The value must be between 1 and 255 characters. 254 "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. 255 # The value must be between 1 and 1024 characters. 256 }, 257 }, 258 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 259 "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. 260 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 261 "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. 262 { # Message for the expected URL mappings. 263 "path": "A String", # Path portion of the URL. 264 "host": "A String", # Host portion of the URL. 265 "description": "A String", # Description of this test case. 266 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 267 }, 268 ], 269 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 270 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 271 # 272 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 273 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 274 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 275 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 276 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 277 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 278 "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. 279 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 280 }, 281 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 282 "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. 283 "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. 284 "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 285 }, 286 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 287 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 288 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 289 # - 290 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 291 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 292 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 293 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 294 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 295 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 296 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 297 "A String", 298 ], 299 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 300 }, 301 "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. 302 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 303 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 304 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 305 # The value must be between 0.0 and 100.0 inclusive. 306 "fixedDelay": { # 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 value of the fixed delay interval. 307 "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. 308 "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 309 }, 310 }, 311 "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. 312 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 313 # The value must be between 0.0 and 100.0 inclusive. 314 "httpStatus": 42, # The HTTP status code used to abort the request. 315 # The value must be between 200 and 599 inclusive. 316 }, 317 }, 318 "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 319 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 320 "A String", 321 ], 322 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 323 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 324 "A String", 325 ], 326 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 327 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 328 "A String", 329 ], 330 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 331 "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. 332 # Default is false. 333 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 334 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 335 "A String", 336 ], 337 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 338 "A String", 339 ], 340 }, 341 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 342 # If not specified, the default value is 15 seconds. 343 "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. 344 "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 345 }, 346 "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. 347 # 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. 348 { # 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 349 "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. 350 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 351 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 352 "A String", 353 ], 354 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 355 "A String", 356 ], 357 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 358 { # Specification determining how headers are added to requests or responses. 359 "headerName": "A String", # The name of the header. 360 "headerValue": "A String", # The value of the header to add. 361 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 362 # The default value is false. 363 }, 364 ], 365 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 366 { # Specification determining how headers are added to requests or responses. 367 "headerName": "A String", # The name of the header. 368 "headerValue": "A String", # The value of the header to add. 369 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 370 # The default value is false. 371 }, 372 ], 373 }, 374 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 375 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 376 # The value must be between 0 and 1000 377 "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. 378 }, 379 ], 380 "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 381 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 382 # The value must be between 1 and 255 characters. 383 "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. 384 # The value must be between 1 and 1024 characters. 385 }, 386 }, 387 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 388 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 389 # - compute/v1/projects/project/global/backendServices/backendService 390 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 391 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 392 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 393 # - compute.backendBuckets.use 394 # - compute.backendServices.use 395 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 396 # Only one of pathRules or routeRules must be set. 397 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 398 "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. 399 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 400 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 401 "A String", 402 ], 403 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 404 "A String", 405 ], 406 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 407 { # Specification determining how headers are added to requests or responses. 408 "headerName": "A String", # The name of the header. 409 "headerValue": "A String", # The value of the header to add. 410 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 411 # The default value is false. 412 }, 413 ], 414 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 415 { # Specification determining how headers are added to requests or responses. 416 "headerName": "A String", # The name of the header. 417 "headerValue": "A String", # The value of the header to add. 418 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 419 # The default value is false. 420 }, 421 ], 422 }, 423 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 424 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 425 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 426 # If urlRedirect is specified, service or routeAction must not be set. 427 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 428 # Only one of pathRedirect or prefixRedirect must be specified. 429 # The value must be between 1 and 1024 characters. 430 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 431 # The default is set to false. 432 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 433 # Supported values are: 434 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 435 # - FOUND, which corresponds to 302. 436 # - SEE_OTHER which corresponds to 303. 437 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 438 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 439 "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. 440 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 441 # The default is set to false. 442 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 443 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 444 # The value must be between 1 and 255 characters. 445 }, 446 "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. 447 # Only one of routeAction or urlRedirect must be set. 448 "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. 449 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 450 }, 451 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 452 "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. 453 "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. 454 "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 455 }, 456 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 457 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 458 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 459 # - 460 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 461 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 462 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 463 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 464 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 465 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 466 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 467 "A String", 468 ], 469 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 470 }, 471 "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. 472 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 473 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 474 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 475 # The value must be between 0.0 and 100.0 inclusive. 476 "fixedDelay": { # 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 value of the fixed delay interval. 477 "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. 478 "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 479 }, 480 }, 481 "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. 482 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 483 # The value must be between 0.0 and 100.0 inclusive. 484 "httpStatus": 42, # The HTTP status code used to abort the request. 485 # The value must be between 200 and 599 inclusive. 486 }, 487 }, 488 "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 489 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 490 "A String", 491 ], 492 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 493 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 494 "A String", 495 ], 496 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 497 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 498 "A String", 499 ], 500 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 501 "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. 502 # Default is false. 503 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 504 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 505 "A String", 506 ], 507 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 508 "A String", 509 ], 510 }, 511 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 512 # If not specified, the default value is 15 seconds. 513 "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. 514 "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 515 }, 516 "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. 517 # 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. 518 { # 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 519 "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. 520 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 521 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 522 "A String", 523 ], 524 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 525 "A String", 526 ], 527 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 528 { # Specification determining how headers are added to requests or responses. 529 "headerName": "A String", # The name of the header. 530 "headerValue": "A String", # The value of the header to add. 531 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 532 # The default value is false. 533 }, 534 ], 535 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 536 { # Specification determining how headers are added to requests or responses. 537 "headerName": "A String", # The name of the header. 538 "headerValue": "A String", # The value of the header to add. 539 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 540 # The default value is false. 541 }, 542 ], 543 }, 544 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 545 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 546 # The value must be between 0 and 1000 547 "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. 548 }, 549 ], 550 "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 551 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 552 # The value must be between 1 and 255 characters. 553 "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. 554 # The value must be between 1 and 1024 characters. 555 }, 556 }, 557 "matchRules": [ 558 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 559 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 560 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 561 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 562 { # matchRule criteria for request header matches. 563 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 564 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 565 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 566 "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. 567 # The default setting is false. 568 "headerName": "A String", # The name of the HTTP header to match. 569 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 570 # For matching a request's method, use the headerName ":method". 571 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 572 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 573 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 574 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 575 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 576 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 577 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 578 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 579 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 580 # For example for a range [-5, 0] 581 # - -3 will match. 582 # - 0 will not match. 583 # - 0.25 will not match. 584 # - -3someString will not match. 585 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 586 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 587 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 588 }, 589 }, 590 ], 591 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 592 # FullPathMatch must be between 1 and 1024 characters. 593 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 594 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 595 # The value must be between 1 and 1024 characters. 596 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 597 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 598 # The default value is false. 599 # caseSensitive must not be used with regexMatch. 600 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 601 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 602 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 603 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 604 { # 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 routing configuration is made available to those proxies. 605 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 606 # 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. 607 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 608 # Supported values are: 609 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 610 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 611 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 612 # This list must not be empty and can have at the most 64 entries. 613 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 614 "name": "A String", # Name of metadata label. 615 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 616 "value": "A String", # The value of the label must match the specified value. 617 # value can have a maximum length of 1024 characters. 618 }, 619 ], 620 }, 621 ], 622 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 623 { # HttpRouteRuleMatch criteria for a request's query parameter. 624 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 625 # Only one of presentMatch, exactMatch and regexMatch must be set. 626 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 627 # Only one of presentMatch, exactMatch and regexMatch must be set. 628 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 629 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 630 # Only one of presentMatch, exactMatch and regexMatch must be set. 631 }, 632 ], 633 }, 634 ], 635 }, 636 ], 637 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 638 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 639 # Only one of pathRules or routeRules must be set. 640 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 641 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 642 "A String", 643 ], 644 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 645 # If urlRedirect is specified, service or routeAction must not be set. 646 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 647 # Only one of pathRedirect or prefixRedirect must be specified. 648 # The value must be between 1 and 1024 characters. 649 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 650 # The default is set to false. 651 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 652 # Supported values are: 653 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 654 # - FOUND, which corresponds to 302. 655 # - SEE_OTHER which corresponds to 303. 656 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 657 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 658 "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. 659 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 660 # The default is set to false. 661 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 662 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 663 # The value must be between 1 and 255 characters. 664 }, 665 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 666 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 667 "routeAction": { # In response to a matching path, 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. 668 # Only one of routeAction or urlRedirect must be set. 669 "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. 670 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 671 }, 672 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 673 "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. 674 "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. 675 "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 676 }, 677 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 678 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 679 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 680 # - 681 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 682 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 683 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 684 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 685 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 686 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 687 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 688 "A String", 689 ], 690 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 691 }, 692 "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. 693 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 694 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 695 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 696 # The value must be between 0.0 and 100.0 inclusive. 697 "fixedDelay": { # 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 value of the fixed delay interval. 698 "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. 699 "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 700 }, 701 }, 702 "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. 703 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 704 # The value must be between 0.0 and 100.0 inclusive. 705 "httpStatus": 42, # The HTTP status code used to abort the request. 706 # The value must be between 200 and 599 inclusive. 707 }, 708 }, 709 "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 710 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 711 "A String", 712 ], 713 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 714 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 715 "A String", 716 ], 717 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 718 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 719 "A String", 720 ], 721 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 722 "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. 723 # Default is false. 724 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 725 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 726 "A String", 727 ], 728 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 729 "A String", 730 ], 731 }, 732 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 733 # If not specified, the default value is 15 seconds. 734 "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. 735 "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 736 }, 737 "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. 738 # 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. 739 { # 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 740 "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. 741 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 742 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 743 "A String", 744 ], 745 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 746 "A String", 747 ], 748 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 749 { # Specification determining how headers are added to requests or responses. 750 "headerName": "A String", # The name of the header. 751 "headerValue": "A String", # The value of the header to add. 752 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 753 # The default value is false. 754 }, 755 ], 756 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 757 { # Specification determining how headers are added to requests or responses. 758 "headerName": "A String", # The name of the header. 759 "headerValue": "A String", # The value of the header to add. 760 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 761 # The default value is false. 762 }, 763 ], 764 }, 765 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 766 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 767 # The value must be between 0 and 1000 768 "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. 769 }, 770 ], 771 "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 772 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 773 # The value must be between 1 and 255 characters. 774 "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. 775 # The value must be between 1 and 1024 characters. 776 }, 777 }, 778 }, 779 ], 780 "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. 781 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 782 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 783 "A String", 784 ], 785 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 786 "A String", 787 ], 788 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 789 { # Specification determining how headers are added to requests or responses. 790 "headerName": "A String", # The name of the header. 791 "headerValue": "A String", # The value of the header to add. 792 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 793 # The default value is false. 794 }, 795 ], 796 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 797 { # Specification determining how headers are added to requests or responses. 798 "headerName": "A String", # The name of the header. 799 "headerValue": "A String", # The value of the header to add. 800 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 801 # The default value is false. 802 }, 803 ], 804 }, 805 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 806 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 807 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 808 # Only one of pathRedirect or prefixRedirect must be specified. 809 # The value must be between 1 and 1024 characters. 810 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 811 # The default is set to false. 812 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 813 # Supported values are: 814 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 815 # - FOUND, which corresponds to 302. 816 # - SEE_OTHER which corresponds to 303. 817 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 818 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 819 "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. 820 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 821 # The default is set to false. 822 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 823 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 824 # The value must be between 1 and 255 characters. 825 }, 826 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 827 }, 828 ], 829 "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. 830 # The headerAction specified here take effect after headerAction specified under pathMatcher. 831 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 832 "A String", 833 ], 834 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 835 "A String", 836 ], 837 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 838 { # Specification determining how headers are added to requests or responses. 839 "headerName": "A String", # The name of the header. 840 "headerValue": "A String", # The value of the header to add. 841 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 842 # The default value is false. 843 }, 844 ], 845 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 846 { # Specification determining how headers are added to requests or responses. 847 "headerName": "A String", # The name of the header. 848 "headerValue": "A String", # The value of the header to add. 849 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 850 # The default value is false. 851 }, 852 ], 853 }, 854 "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. 855 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 856 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 857 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 858 # Only one of pathRedirect or prefixRedirect must be specified. 859 # The value must be between 1 and 1024 characters. 860 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 861 # The default is set to false. 862 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 863 # Supported values are: 864 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 865 # - FOUND, which corresponds to 302. 866 # - SEE_OTHER which corresponds to 303. 867 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 868 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 869 "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. 870 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 871 # The default is set to false. 872 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 873 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 874 # The value must be between 1 and 255 characters. 875 }, 876 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 877 "hostRules": [ # The list of HostRules to use against the URL. 878 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 879 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 880 "A String", 881 ], 882 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 883 "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. 884 }, 885 ], 886 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 887 }, 888 ], 889 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 890 "message": "A String", # [Output Only] A human-readable description of the warning code. 891 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 892 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 893 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 894 { 895 "value": "A String", # [Output Only] A warning data value corresponding to the key. 896 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 897 }, 898 ], 899 }, 900 }, 901 }, 902 "warning": { # [Output Only] Informational warning message. 903 "message": "A String", # [Output Only] A human-readable description of the warning code. 904 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 905 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 906 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 907 { 908 "value": "A String", # [Output Only] A warning data value corresponding to the key. 909 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 910 }, 911 ], 912 }, 913 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 914 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 915 }</pre> 916</div> 917 918<div class="method"> 919 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 920 <pre>Retrieves the next page of results. 921 922Args: 923 previous_request: The request for the previous page. (required) 924 previous_response: The response from the request for the previous page. (required) 925 926Returns: 927 A request object that you can call 'execute()' on to request the next 928 page. Returns None if there are no more items in the collection. 929 </pre> 930</div> 931 932<div class="method"> 933 <code class="details" id="delete">delete(project, urlMap, requestId=None)</code> 934 <pre>Deletes the specified UrlMap resource. 935 936Args: 937 project: string, Project ID for this request. (required) 938 urlMap: string, Name of the UrlMap resource to delete. (required) 939 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 940 941For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 942 943The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 944 945Returns: 946 An object of the form: 947 948 { # Represents an Operation resource. 949 # 950 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 951 # 952 # Operations can be global, regional or zonal. 953 # - For global operations, use the globalOperations resource. 954 # - For regional operations, use the regionOperations resource. 955 # - For zonal operations, use the zonalOperations resource. 956 # 957 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 958 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 959 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 960 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 961 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 962 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 963 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 964 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 965 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 966 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 967 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 968 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 969 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 970 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 971 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 972 { 973 "message": "A String", # [Output Only] A human-readable description of the warning code. 974 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 975 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 976 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 977 { 978 "value": "A String", # [Output Only] A warning data value corresponding to the key. 979 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 980 }, 981 ], 982 }, 983 ], 984 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 985 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 986 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 987 "name": "A String", # [Output Only] Name of the resource. 988 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 989 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 990 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 991 { 992 "message": "A String", # [Output Only] An optional, human-readable error message. 993 "code": "A String", # [Output Only] The error type identifier for this error. 994 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 995 }, 996 ], 997 }, 998 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 999 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1000 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1001 }</pre> 1002</div> 1003 1004<div class="method"> 1005 <code class="details" id="get">get(project, urlMap)</code> 1006 <pre>Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. 1007 1008Args: 1009 project: string, Project ID for this request. (required) 1010 urlMap: string, Name of the UrlMap resource to return. (required) 1011 1012Returns: 1013 An object of the form: 1014 1015 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. 1016 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 1017 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1018 "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. 1019 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 1020 "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. 1021 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 1022 }, 1023 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 1024 "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. 1025 "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. 1026 "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 1027 }, 1028 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 1029 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 1030 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 1031 # - 1032 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 1033 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 1034 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 1035 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 1036 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 1037 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 1038 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 1039 "A String", 1040 ], 1041 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 1042 }, 1043 "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. 1044 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 1045 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 1046 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 1047 # The value must be between 0.0 and 100.0 inclusive. 1048 "fixedDelay": { # 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 value of the fixed delay interval. 1049 "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. 1050 "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 1051 }, 1052 }, 1053 "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. 1054 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 1055 # The value must be between 0.0 and 100.0 inclusive. 1056 "httpStatus": 42, # The HTTP status code used to abort the request. 1057 # The value must be between 200 and 599 inclusive. 1058 }, 1059 }, 1060 "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 1061 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 1062 "A String", 1063 ], 1064 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 1065 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1066 "A String", 1067 ], 1068 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1069 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1070 "A String", 1071 ], 1072 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 1073 "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. 1074 # Default is false. 1075 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 1076 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 1077 "A String", 1078 ], 1079 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 1080 "A String", 1081 ], 1082 }, 1083 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 1084 # If not specified, the default value is 15 seconds. 1085 "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. 1086 "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 1087 }, 1088 "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. 1089 # 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. 1090 { # 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 1091 "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. 1092 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 1093 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1094 "A String", 1095 ], 1096 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1097 "A String", 1098 ], 1099 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1100 { # Specification determining how headers are added to requests or responses. 1101 "headerName": "A String", # The name of the header. 1102 "headerValue": "A String", # The value of the header to add. 1103 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1104 # The default value is false. 1105 }, 1106 ], 1107 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1108 { # Specification determining how headers are added to requests or responses. 1109 "headerName": "A String", # The name of the header. 1110 "headerValue": "A String", # The value of the header to add. 1111 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1112 # The default value is false. 1113 }, 1114 ], 1115 }, 1116 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 1117 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 1118 # The value must be between 0 and 1000 1119 "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. 1120 }, 1121 ], 1122 "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 1123 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 1124 # The value must be between 1 and 255 characters. 1125 "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. 1126 # The value must be between 1 and 1024 characters. 1127 }, 1128 }, 1129 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1130 "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. 1131 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 1132 "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. 1133 { # Message for the expected URL mappings. 1134 "path": "A String", # Path portion of the URL. 1135 "host": "A String", # Host portion of the URL. 1136 "description": "A String", # Description of this test case. 1137 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 1138 }, 1139 ], 1140 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1141 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 1142 # 1143 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 1144 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 1145 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 1146 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1147 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 1148 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 1149 "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. 1150 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 1151 }, 1152 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 1153 "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. 1154 "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. 1155 "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 1156 }, 1157 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 1158 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 1159 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 1160 # - 1161 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 1162 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 1163 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 1164 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 1165 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 1166 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 1167 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 1168 "A String", 1169 ], 1170 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 1171 }, 1172 "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. 1173 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 1174 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 1175 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 1176 # The value must be between 0.0 and 100.0 inclusive. 1177 "fixedDelay": { # 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 value of the fixed delay interval. 1178 "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. 1179 "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 1180 }, 1181 }, 1182 "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. 1183 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 1184 # The value must be between 0.0 and 100.0 inclusive. 1185 "httpStatus": 42, # The HTTP status code used to abort the request. 1186 # The value must be between 200 and 599 inclusive. 1187 }, 1188 }, 1189 "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 1190 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 1191 "A String", 1192 ], 1193 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 1194 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1195 "A String", 1196 ], 1197 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1198 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1199 "A String", 1200 ], 1201 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 1202 "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. 1203 # Default is false. 1204 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 1205 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 1206 "A String", 1207 ], 1208 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 1209 "A String", 1210 ], 1211 }, 1212 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 1213 # If not specified, the default value is 15 seconds. 1214 "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. 1215 "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 1216 }, 1217 "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. 1218 # 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. 1219 { # 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 1220 "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. 1221 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 1222 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1223 "A String", 1224 ], 1225 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1226 "A String", 1227 ], 1228 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1229 { # Specification determining how headers are added to requests or responses. 1230 "headerName": "A String", # The name of the header. 1231 "headerValue": "A String", # The value of the header to add. 1232 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1233 # The default value is false. 1234 }, 1235 ], 1236 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1237 { # Specification determining how headers are added to requests or responses. 1238 "headerName": "A String", # The name of the header. 1239 "headerValue": "A String", # The value of the header to add. 1240 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1241 # The default value is false. 1242 }, 1243 ], 1244 }, 1245 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 1246 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 1247 # The value must be between 0 and 1000 1248 "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. 1249 }, 1250 ], 1251 "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 1252 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 1253 # The value must be between 1 and 255 characters. 1254 "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. 1255 # The value must be between 1 and 1024 characters. 1256 }, 1257 }, 1258 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 1259 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 1260 # - compute/v1/projects/project/global/backendServices/backendService 1261 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 1262 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 1263 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 1264 # - compute.backendBuckets.use 1265 # - compute.backendServices.use 1266 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 1267 # Only one of pathRules or routeRules must be set. 1268 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 1269 "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. 1270 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 1271 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1272 "A String", 1273 ], 1274 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1275 "A String", 1276 ], 1277 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1278 { # Specification determining how headers are added to requests or responses. 1279 "headerName": "A String", # The name of the header. 1280 "headerValue": "A String", # The value of the header to add. 1281 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1282 # The default value is false. 1283 }, 1284 ], 1285 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1286 { # Specification determining how headers are added to requests or responses. 1287 "headerName": "A String", # The name of the header. 1288 "headerValue": "A String", # The value of the header to add. 1289 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1290 # The default value is false. 1291 }, 1292 ], 1293 }, 1294 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 1295 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 1296 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 1297 # If urlRedirect is specified, service or routeAction must not be set. 1298 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 1299 # Only one of pathRedirect or prefixRedirect must be specified. 1300 # The value must be between 1 and 1024 characters. 1301 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 1302 # The default is set to false. 1303 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 1304 # Supported values are: 1305 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 1306 # - FOUND, which corresponds to 302. 1307 # - SEE_OTHER which corresponds to 303. 1308 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 1309 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 1310 "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. 1311 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 1312 # The default is set to false. 1313 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 1314 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 1315 # The value must be between 1 and 255 characters. 1316 }, 1317 "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. 1318 # Only one of routeAction or urlRedirect must be set. 1319 "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. 1320 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 1321 }, 1322 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 1323 "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. 1324 "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. 1325 "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 1326 }, 1327 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 1328 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 1329 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 1330 # - 1331 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 1332 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 1333 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 1334 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 1335 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 1336 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 1337 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 1338 "A String", 1339 ], 1340 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 1341 }, 1342 "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. 1343 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 1344 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 1345 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 1346 # The value must be between 0.0 and 100.0 inclusive. 1347 "fixedDelay": { # 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 value of the fixed delay interval. 1348 "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. 1349 "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 1350 }, 1351 }, 1352 "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. 1353 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 1354 # The value must be between 0.0 and 100.0 inclusive. 1355 "httpStatus": 42, # The HTTP status code used to abort the request. 1356 # The value must be between 200 and 599 inclusive. 1357 }, 1358 }, 1359 "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 1360 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 1361 "A String", 1362 ], 1363 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 1364 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1365 "A String", 1366 ], 1367 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1368 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1369 "A String", 1370 ], 1371 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 1372 "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. 1373 # Default is false. 1374 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 1375 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 1376 "A String", 1377 ], 1378 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 1379 "A String", 1380 ], 1381 }, 1382 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 1383 # If not specified, the default value is 15 seconds. 1384 "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. 1385 "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 1386 }, 1387 "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. 1388 # 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. 1389 { # 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 1390 "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. 1391 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 1392 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1393 "A String", 1394 ], 1395 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1396 "A String", 1397 ], 1398 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1399 { # Specification determining how headers are added to requests or responses. 1400 "headerName": "A String", # The name of the header. 1401 "headerValue": "A String", # The value of the header to add. 1402 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1403 # The default value is false. 1404 }, 1405 ], 1406 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1407 { # Specification determining how headers are added to requests or responses. 1408 "headerName": "A String", # The name of the header. 1409 "headerValue": "A String", # The value of the header to add. 1410 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1411 # The default value is false. 1412 }, 1413 ], 1414 }, 1415 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 1416 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 1417 # The value must be between 0 and 1000 1418 "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. 1419 }, 1420 ], 1421 "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 1422 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 1423 # The value must be between 1 and 255 characters. 1424 "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. 1425 # The value must be between 1 and 1024 characters. 1426 }, 1427 }, 1428 "matchRules": [ 1429 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 1430 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1431 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 1432 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 1433 { # matchRule criteria for request header matches. 1434 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 1435 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 1436 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 1437 "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. 1438 # The default setting is false. 1439 "headerName": "A String", # The name of the HTTP header to match. 1440 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 1441 # For matching a request's method, use the headerName ":method". 1442 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 1443 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 1444 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 1445 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 1446 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 1447 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 1448 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 1449 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 1450 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 1451 # For example for a range [-5, 0] 1452 # - -3 will match. 1453 # - 0 will not match. 1454 # - 0.25 will not match. 1455 # - -3someString will not match. 1456 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 1457 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 1458 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 1459 }, 1460 }, 1461 ], 1462 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 1463 # FullPathMatch must be between 1 and 1024 characters. 1464 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 1465 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 1466 # The value must be between 1 and 1024 characters. 1467 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 1468 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 1469 # The default value is false. 1470 # caseSensitive must not be used with regexMatch. 1471 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 1472 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 1473 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 1474 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 1475 { # 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 routing configuration is made available to those proxies. 1476 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 1477 # 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. 1478 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 1479 # Supported values are: 1480 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 1481 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 1482 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 1483 # This list must not be empty and can have at the most 64 entries. 1484 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 1485 "name": "A String", # Name of metadata label. 1486 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 1487 "value": "A String", # The value of the label must match the specified value. 1488 # value can have a maximum length of 1024 characters. 1489 }, 1490 ], 1491 }, 1492 ], 1493 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 1494 { # HttpRouteRuleMatch criteria for a request's query parameter. 1495 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 1496 # Only one of presentMatch, exactMatch and regexMatch must be set. 1497 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 1498 # Only one of presentMatch, exactMatch and regexMatch must be set. 1499 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 1500 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 1501 # Only one of presentMatch, exactMatch and regexMatch must be set. 1502 }, 1503 ], 1504 }, 1505 ], 1506 }, 1507 ], 1508 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 1509 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 1510 # Only one of pathRules or routeRules must be set. 1511 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 1512 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 1513 "A String", 1514 ], 1515 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 1516 # If urlRedirect is specified, service or routeAction must not be set. 1517 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 1518 # Only one of pathRedirect or prefixRedirect must be specified. 1519 # The value must be between 1 and 1024 characters. 1520 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 1521 # The default is set to false. 1522 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 1523 # Supported values are: 1524 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 1525 # - FOUND, which corresponds to 302. 1526 # - SEE_OTHER which corresponds to 303. 1527 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 1528 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 1529 "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. 1530 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 1531 # The default is set to false. 1532 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 1533 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 1534 # The value must be between 1 and 255 characters. 1535 }, 1536 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 1537 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 1538 "routeAction": { # In response to a matching path, 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. 1539 # Only one of routeAction or urlRedirect must be set. 1540 "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. 1541 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 1542 }, 1543 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 1544 "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. 1545 "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. 1546 "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 1547 }, 1548 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 1549 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 1550 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 1551 # - 1552 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 1553 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 1554 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 1555 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 1556 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 1557 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 1558 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 1559 "A String", 1560 ], 1561 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 1562 }, 1563 "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. 1564 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 1565 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 1566 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 1567 # The value must be between 0.0 and 100.0 inclusive. 1568 "fixedDelay": { # 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 value of the fixed delay interval. 1569 "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. 1570 "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 1571 }, 1572 }, 1573 "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. 1574 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 1575 # The value must be between 0.0 and 100.0 inclusive. 1576 "httpStatus": 42, # The HTTP status code used to abort the request. 1577 # The value must be between 200 and 599 inclusive. 1578 }, 1579 }, 1580 "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 1581 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 1582 "A String", 1583 ], 1584 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 1585 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1586 "A String", 1587 ], 1588 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1589 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1590 "A String", 1591 ], 1592 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 1593 "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. 1594 # Default is false. 1595 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 1596 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 1597 "A String", 1598 ], 1599 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 1600 "A String", 1601 ], 1602 }, 1603 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 1604 # If not specified, the default value is 15 seconds. 1605 "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. 1606 "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 1607 }, 1608 "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. 1609 # 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. 1610 { # 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 1611 "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. 1612 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 1613 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1614 "A String", 1615 ], 1616 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1617 "A String", 1618 ], 1619 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1620 { # Specification determining how headers are added to requests or responses. 1621 "headerName": "A String", # The name of the header. 1622 "headerValue": "A String", # The value of the header to add. 1623 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1624 # The default value is false. 1625 }, 1626 ], 1627 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1628 { # Specification determining how headers are added to requests or responses. 1629 "headerName": "A String", # The name of the header. 1630 "headerValue": "A String", # The value of the header to add. 1631 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1632 # The default value is false. 1633 }, 1634 ], 1635 }, 1636 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 1637 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 1638 # The value must be between 0 and 1000 1639 "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. 1640 }, 1641 ], 1642 "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 1643 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 1644 # The value must be between 1 and 255 characters. 1645 "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. 1646 # The value must be between 1 and 1024 characters. 1647 }, 1648 }, 1649 }, 1650 ], 1651 "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. 1652 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 1653 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1654 "A String", 1655 ], 1656 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1657 "A String", 1658 ], 1659 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1660 { # Specification determining how headers are added to requests or responses. 1661 "headerName": "A String", # The name of the header. 1662 "headerValue": "A String", # The value of the header to add. 1663 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1664 # The default value is false. 1665 }, 1666 ], 1667 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1668 { # Specification determining how headers are added to requests or responses. 1669 "headerName": "A String", # The name of the header. 1670 "headerValue": "A String", # The value of the header to add. 1671 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1672 # The default value is false. 1673 }, 1674 ], 1675 }, 1676 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 1677 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 1678 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 1679 # Only one of pathRedirect or prefixRedirect must be specified. 1680 # The value must be between 1 and 1024 characters. 1681 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 1682 # The default is set to false. 1683 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 1684 # Supported values are: 1685 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 1686 # - FOUND, which corresponds to 302. 1687 # - SEE_OTHER which corresponds to 303. 1688 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 1689 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 1690 "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. 1691 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 1692 # The default is set to false. 1693 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 1694 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 1695 # The value must be between 1 and 255 characters. 1696 }, 1697 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 1698 }, 1699 ], 1700 "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. 1701 # The headerAction specified here take effect after headerAction specified under pathMatcher. 1702 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1703 "A String", 1704 ], 1705 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1706 "A String", 1707 ], 1708 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1709 { # Specification determining how headers are added to requests or responses. 1710 "headerName": "A String", # The name of the header. 1711 "headerValue": "A String", # The value of the header to add. 1712 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1713 # The default value is false. 1714 }, 1715 ], 1716 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1717 { # Specification determining how headers are added to requests or responses. 1718 "headerName": "A String", # The name of the header. 1719 "headerValue": "A String", # The value of the header to add. 1720 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1721 # The default value is false. 1722 }, 1723 ], 1724 }, 1725 "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. 1726 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 1727 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 1728 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 1729 # Only one of pathRedirect or prefixRedirect must be specified. 1730 # The value must be between 1 and 1024 characters. 1731 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 1732 # The default is set to false. 1733 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 1734 # Supported values are: 1735 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 1736 # - FOUND, which corresponds to 302. 1737 # - SEE_OTHER which corresponds to 303. 1738 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 1739 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 1740 "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. 1741 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 1742 # The default is set to false. 1743 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 1744 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 1745 # The value must be between 1 and 255 characters. 1746 }, 1747 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1748 "hostRules": [ # The list of HostRules to use against the URL. 1749 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 1750 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 1751 "A String", 1752 ], 1753 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1754 "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. 1755 }, 1756 ], 1757 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1758 }</pre> 1759</div> 1760 1761<div class="method"> 1762 <code class="details" id="insert">insert(project, body, requestId=None)</code> 1763 <pre>Creates a UrlMap resource in the specified project using the data included in the request. 1764 1765Args: 1766 project: string, Project ID for this request. (required) 1767 body: object, The request body. (required) 1768 The object takes the form of: 1769 1770{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. 1771 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 1772 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1773 "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. 1774 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 1775 "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. 1776 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 1777 }, 1778 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 1779 "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. 1780 "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. 1781 "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 1782 }, 1783 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 1784 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 1785 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 1786 # - 1787 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 1788 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 1789 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 1790 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 1791 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 1792 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 1793 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 1794 "A String", 1795 ], 1796 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 1797 }, 1798 "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. 1799 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 1800 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 1801 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 1802 # The value must be between 0.0 and 100.0 inclusive. 1803 "fixedDelay": { # 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 value of the fixed delay interval. 1804 "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. 1805 "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 1806 }, 1807 }, 1808 "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. 1809 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 1810 # The value must be between 0.0 and 100.0 inclusive. 1811 "httpStatus": 42, # The HTTP status code used to abort the request. 1812 # The value must be between 200 and 599 inclusive. 1813 }, 1814 }, 1815 "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 1816 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 1817 "A String", 1818 ], 1819 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 1820 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1821 "A String", 1822 ], 1823 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1824 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1825 "A String", 1826 ], 1827 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 1828 "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. 1829 # Default is false. 1830 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 1831 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 1832 "A String", 1833 ], 1834 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 1835 "A String", 1836 ], 1837 }, 1838 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 1839 # If not specified, the default value is 15 seconds. 1840 "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. 1841 "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 1842 }, 1843 "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. 1844 # 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. 1845 { # 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 1846 "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. 1847 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 1848 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1849 "A String", 1850 ], 1851 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1852 "A String", 1853 ], 1854 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1855 { # Specification determining how headers are added to requests or responses. 1856 "headerName": "A String", # The name of the header. 1857 "headerValue": "A String", # The value of the header to add. 1858 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1859 # The default value is false. 1860 }, 1861 ], 1862 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1863 { # Specification determining how headers are added to requests or responses. 1864 "headerName": "A String", # The name of the header. 1865 "headerValue": "A String", # The value of the header to add. 1866 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1867 # The default value is false. 1868 }, 1869 ], 1870 }, 1871 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 1872 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 1873 # The value must be between 0 and 1000 1874 "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. 1875 }, 1876 ], 1877 "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 1878 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 1879 # The value must be between 1 and 255 characters. 1880 "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. 1881 # The value must be between 1 and 1024 characters. 1882 }, 1883 }, 1884 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1885 "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. 1886 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 1887 "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. 1888 { # Message for the expected URL mappings. 1889 "path": "A String", # Path portion of the URL. 1890 "host": "A String", # Host portion of the URL. 1891 "description": "A String", # Description of this test case. 1892 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 1893 }, 1894 ], 1895 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1896 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 1897 # 1898 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 1899 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 1900 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 1901 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1902 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 1903 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 1904 "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. 1905 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 1906 }, 1907 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 1908 "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. 1909 "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. 1910 "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 1911 }, 1912 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 1913 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 1914 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 1915 # - 1916 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 1917 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 1918 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 1919 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 1920 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 1921 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 1922 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 1923 "A String", 1924 ], 1925 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 1926 }, 1927 "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. 1928 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 1929 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 1930 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 1931 # The value must be between 0.0 and 100.0 inclusive. 1932 "fixedDelay": { # 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 value of the fixed delay interval. 1933 "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. 1934 "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 1935 }, 1936 }, 1937 "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. 1938 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 1939 # The value must be between 0.0 and 100.0 inclusive. 1940 "httpStatus": 42, # The HTTP status code used to abort the request. 1941 # The value must be between 200 and 599 inclusive. 1942 }, 1943 }, 1944 "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 1945 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 1946 "A String", 1947 ], 1948 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 1949 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1950 "A String", 1951 ], 1952 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 1953 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 1954 "A String", 1955 ], 1956 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 1957 "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. 1958 # Default is false. 1959 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 1960 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 1961 "A String", 1962 ], 1963 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 1964 "A String", 1965 ], 1966 }, 1967 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 1968 # If not specified, the default value is 15 seconds. 1969 "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. 1970 "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 1971 }, 1972 "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. 1973 # 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. 1974 { # 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 1975 "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. 1976 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 1977 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 1978 "A String", 1979 ], 1980 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 1981 "A String", 1982 ], 1983 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 1984 { # Specification determining how headers are added to requests or responses. 1985 "headerName": "A String", # The name of the header. 1986 "headerValue": "A String", # The value of the header to add. 1987 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1988 # The default value is false. 1989 }, 1990 ], 1991 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 1992 { # Specification determining how headers are added to requests or responses. 1993 "headerName": "A String", # The name of the header. 1994 "headerValue": "A String", # The value of the header to add. 1995 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 1996 # The default value is false. 1997 }, 1998 ], 1999 }, 2000 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 2001 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 2002 # The value must be between 0 and 1000 2003 "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. 2004 }, 2005 ], 2006 "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 2007 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 2008 # The value must be between 1 and 255 characters. 2009 "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. 2010 # The value must be between 1 and 1024 characters. 2011 }, 2012 }, 2013 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 2014 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 2015 # - compute/v1/projects/project/global/backendServices/backendService 2016 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 2017 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 2018 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 2019 # - compute.backendBuckets.use 2020 # - compute.backendServices.use 2021 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 2022 # Only one of pathRules or routeRules must be set. 2023 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 2024 "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. 2025 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 2026 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2027 "A String", 2028 ], 2029 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2030 "A String", 2031 ], 2032 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2033 { # Specification determining how headers are added to requests or responses. 2034 "headerName": "A String", # The name of the header. 2035 "headerValue": "A String", # The value of the header to add. 2036 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2037 # The default value is false. 2038 }, 2039 ], 2040 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2041 { # Specification determining how headers are added to requests or responses. 2042 "headerName": "A String", # The name of the header. 2043 "headerValue": "A String", # The value of the header to add. 2044 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2045 # The default value is false. 2046 }, 2047 ], 2048 }, 2049 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 2050 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 2051 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 2052 # If urlRedirect is specified, service or routeAction must not be set. 2053 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 2054 # Only one of pathRedirect or prefixRedirect must be specified. 2055 # The value must be between 1 and 1024 characters. 2056 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 2057 # The default is set to false. 2058 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 2059 # Supported values are: 2060 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 2061 # - FOUND, which corresponds to 302. 2062 # - SEE_OTHER which corresponds to 303. 2063 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 2064 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 2065 "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. 2066 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 2067 # The default is set to false. 2068 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 2069 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 2070 # The value must be between 1 and 255 characters. 2071 }, 2072 "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. 2073 # Only one of routeAction or urlRedirect must be set. 2074 "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. 2075 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 2076 }, 2077 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 2078 "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. 2079 "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. 2080 "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 2081 }, 2082 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 2083 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 2084 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 2085 # - 2086 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 2087 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 2088 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 2089 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 2090 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 2091 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 2092 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 2093 "A String", 2094 ], 2095 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 2096 }, 2097 "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. 2098 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 2099 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 2100 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 2101 # The value must be between 0.0 and 100.0 inclusive. 2102 "fixedDelay": { # 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 value of the fixed delay interval. 2103 "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. 2104 "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 2105 }, 2106 }, 2107 "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. 2108 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 2109 # The value must be between 0.0 and 100.0 inclusive. 2110 "httpStatus": 42, # The HTTP status code used to abort the request. 2111 # The value must be between 200 and 599 inclusive. 2112 }, 2113 }, 2114 "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 2115 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 2116 "A String", 2117 ], 2118 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 2119 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2120 "A String", 2121 ], 2122 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 2123 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2124 "A String", 2125 ], 2126 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 2127 "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. 2128 # Default is false. 2129 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 2130 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 2131 "A String", 2132 ], 2133 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 2134 "A String", 2135 ], 2136 }, 2137 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 2138 # If not specified, the default value is 15 seconds. 2139 "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. 2140 "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 2141 }, 2142 "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. 2143 # 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. 2144 { # 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 2145 "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. 2146 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 2147 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2148 "A String", 2149 ], 2150 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2151 "A String", 2152 ], 2153 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2154 { # Specification determining how headers are added to requests or responses. 2155 "headerName": "A String", # The name of the header. 2156 "headerValue": "A String", # The value of the header to add. 2157 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2158 # The default value is false. 2159 }, 2160 ], 2161 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2162 { # Specification determining how headers are added to requests or responses. 2163 "headerName": "A String", # The name of the header. 2164 "headerValue": "A String", # The value of the header to add. 2165 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2166 # The default value is false. 2167 }, 2168 ], 2169 }, 2170 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 2171 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 2172 # The value must be between 0 and 1000 2173 "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. 2174 }, 2175 ], 2176 "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 2177 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 2178 # The value must be between 1 and 255 characters. 2179 "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. 2180 # The value must be between 1 and 1024 characters. 2181 }, 2182 }, 2183 "matchRules": [ 2184 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 2185 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 2186 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 2187 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 2188 { # matchRule criteria for request header matches. 2189 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 2190 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 2191 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 2192 "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. 2193 # The default setting is false. 2194 "headerName": "A String", # The name of the HTTP header to match. 2195 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 2196 # For matching a request's method, use the headerName ":method". 2197 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 2198 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 2199 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 2200 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 2201 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 2202 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 2203 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 2204 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 2205 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 2206 # For example for a range [-5, 0] 2207 # - -3 will match. 2208 # - 0 will not match. 2209 # - 0.25 will not match. 2210 # - -3someString will not match. 2211 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 2212 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 2213 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 2214 }, 2215 }, 2216 ], 2217 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 2218 # FullPathMatch must be between 1 and 1024 characters. 2219 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 2220 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 2221 # The value must be between 1 and 1024 characters. 2222 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 2223 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 2224 # The default value is false. 2225 # caseSensitive must not be used with regexMatch. 2226 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 2227 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 2228 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 2229 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 2230 { # 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 routing configuration is made available to those proxies. 2231 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 2232 # 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. 2233 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 2234 # Supported values are: 2235 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 2236 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 2237 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 2238 # This list must not be empty and can have at the most 64 entries. 2239 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 2240 "name": "A String", # Name of metadata label. 2241 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 2242 "value": "A String", # The value of the label must match the specified value. 2243 # value can have a maximum length of 1024 characters. 2244 }, 2245 ], 2246 }, 2247 ], 2248 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 2249 { # HttpRouteRuleMatch criteria for a request's query parameter. 2250 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 2251 # Only one of presentMatch, exactMatch and regexMatch must be set. 2252 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 2253 # Only one of presentMatch, exactMatch and regexMatch must be set. 2254 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 2255 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 2256 # Only one of presentMatch, exactMatch and regexMatch must be set. 2257 }, 2258 ], 2259 }, 2260 ], 2261 }, 2262 ], 2263 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 2264 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 2265 # Only one of pathRules or routeRules must be set. 2266 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 2267 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 2268 "A String", 2269 ], 2270 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 2271 # If urlRedirect is specified, service or routeAction must not be set. 2272 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 2273 # Only one of pathRedirect or prefixRedirect must be specified. 2274 # The value must be between 1 and 1024 characters. 2275 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 2276 # The default is set to false. 2277 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 2278 # Supported values are: 2279 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 2280 # - FOUND, which corresponds to 302. 2281 # - SEE_OTHER which corresponds to 303. 2282 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 2283 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 2284 "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. 2285 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 2286 # The default is set to false. 2287 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 2288 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 2289 # The value must be between 1 and 255 characters. 2290 }, 2291 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 2292 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 2293 "routeAction": { # In response to a matching path, 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. 2294 # Only one of routeAction or urlRedirect must be set. 2295 "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. 2296 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 2297 }, 2298 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 2299 "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. 2300 "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. 2301 "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 2302 }, 2303 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 2304 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 2305 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 2306 # - 2307 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 2308 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 2309 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 2310 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 2311 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 2312 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 2313 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 2314 "A String", 2315 ], 2316 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 2317 }, 2318 "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. 2319 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 2320 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 2321 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 2322 # The value must be between 0.0 and 100.0 inclusive. 2323 "fixedDelay": { # 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 value of the fixed delay interval. 2324 "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. 2325 "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 2326 }, 2327 }, 2328 "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. 2329 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 2330 # The value must be between 0.0 and 100.0 inclusive. 2331 "httpStatus": 42, # The HTTP status code used to abort the request. 2332 # The value must be between 200 and 599 inclusive. 2333 }, 2334 }, 2335 "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 2336 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 2337 "A String", 2338 ], 2339 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 2340 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2341 "A String", 2342 ], 2343 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 2344 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2345 "A String", 2346 ], 2347 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 2348 "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. 2349 # Default is false. 2350 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 2351 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 2352 "A String", 2353 ], 2354 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 2355 "A String", 2356 ], 2357 }, 2358 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 2359 # If not specified, the default value is 15 seconds. 2360 "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. 2361 "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 2362 }, 2363 "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. 2364 # 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. 2365 { # 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 2366 "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. 2367 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 2368 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2369 "A String", 2370 ], 2371 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2372 "A String", 2373 ], 2374 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2375 { # Specification determining how headers are added to requests or responses. 2376 "headerName": "A String", # The name of the header. 2377 "headerValue": "A String", # The value of the header to add. 2378 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2379 # The default value is false. 2380 }, 2381 ], 2382 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2383 { # Specification determining how headers are added to requests or responses. 2384 "headerName": "A String", # The name of the header. 2385 "headerValue": "A String", # The value of the header to add. 2386 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2387 # The default value is false. 2388 }, 2389 ], 2390 }, 2391 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 2392 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 2393 # The value must be between 0 and 1000 2394 "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. 2395 }, 2396 ], 2397 "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 2398 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 2399 # The value must be between 1 and 255 characters. 2400 "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. 2401 # The value must be between 1 and 1024 characters. 2402 }, 2403 }, 2404 }, 2405 ], 2406 "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. 2407 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 2408 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2409 "A String", 2410 ], 2411 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2412 "A String", 2413 ], 2414 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2415 { # Specification determining how headers are added to requests or responses. 2416 "headerName": "A String", # The name of the header. 2417 "headerValue": "A String", # The value of the header to add. 2418 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2419 # The default value is false. 2420 }, 2421 ], 2422 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2423 { # Specification determining how headers are added to requests or responses. 2424 "headerName": "A String", # The name of the header. 2425 "headerValue": "A String", # The value of the header to add. 2426 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2427 # The default value is false. 2428 }, 2429 ], 2430 }, 2431 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 2432 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 2433 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 2434 # Only one of pathRedirect or prefixRedirect must be specified. 2435 # The value must be between 1 and 1024 characters. 2436 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 2437 # The default is set to false. 2438 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 2439 # Supported values are: 2440 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 2441 # - FOUND, which corresponds to 302. 2442 # - SEE_OTHER which corresponds to 303. 2443 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 2444 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 2445 "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. 2446 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 2447 # The default is set to false. 2448 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 2449 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 2450 # The value must be between 1 and 255 characters. 2451 }, 2452 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 2453 }, 2454 ], 2455 "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. 2456 # The headerAction specified here take effect after headerAction specified under pathMatcher. 2457 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2458 "A String", 2459 ], 2460 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2461 "A String", 2462 ], 2463 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2464 { # Specification determining how headers are added to requests or responses. 2465 "headerName": "A String", # The name of the header. 2466 "headerValue": "A String", # The value of the header to add. 2467 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2468 # The default value is false. 2469 }, 2470 ], 2471 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2472 { # Specification determining how headers are added to requests or responses. 2473 "headerName": "A String", # The name of the header. 2474 "headerValue": "A String", # The value of the header to add. 2475 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2476 # The default value is false. 2477 }, 2478 ], 2479 }, 2480 "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. 2481 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 2482 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 2483 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 2484 # Only one of pathRedirect or prefixRedirect must be specified. 2485 # The value must be between 1 and 1024 characters. 2486 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 2487 # The default is set to false. 2488 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 2489 # Supported values are: 2490 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 2491 # - FOUND, which corresponds to 302. 2492 # - SEE_OTHER which corresponds to 303. 2493 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 2494 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 2495 "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. 2496 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 2497 # The default is set to false. 2498 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 2499 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 2500 # The value must be between 1 and 255 characters. 2501 }, 2502 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2503 "hostRules": [ # The list of HostRules to use against the URL. 2504 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 2505 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 2506 "A String", 2507 ], 2508 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 2509 "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. 2510 }, 2511 ], 2512 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 2513 } 2514 2515 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 2516 2517For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 2518 2519The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 2520 2521Returns: 2522 An object of the form: 2523 2524 { # Represents an Operation resource. 2525 # 2526 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 2527 # 2528 # Operations can be global, regional or zonal. 2529 # - For global operations, use the globalOperations resource. 2530 # - For regional operations, use the regionOperations resource. 2531 # - For zonal operations, use the zonalOperations resource. 2532 # 2533 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 2534 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2535 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2536 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2537 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2538 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2539 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2540 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2541 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2542 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2543 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 2544 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2545 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2546 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2547 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2548 { 2549 "message": "A String", # [Output Only] A human-readable description of the warning code. 2550 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2551 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2552 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2553 { 2554 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2555 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2556 }, 2557 ], 2558 }, 2559 ], 2560 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 2561 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2562 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2563 "name": "A String", # [Output Only] Name of the resource. 2564 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2565 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2566 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2567 { 2568 "message": "A String", # [Output Only] An optional, human-readable error message. 2569 "code": "A String", # [Output Only] The error type identifier for this error. 2570 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2571 }, 2572 ], 2573 }, 2574 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2575 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2576 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2577 }</pre> 2578</div> 2579 2580<div class="method"> 2581 <code class="details" id="invalidateCache">invalidateCache(project, urlMap, body, requestId=None)</code> 2582 <pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. 2583 2584Args: 2585 project: string, Project ID for this request. (required) 2586 urlMap: string, Name of the UrlMap scoping this request. (required) 2587 body: object, The request body. (required) 2588 The object takes the form of: 2589 2590{ 2591 "path": "A String", 2592 "host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host. 2593 } 2594 2595 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 2596 2597For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 2598 2599The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 2600 2601Returns: 2602 An object of the form: 2603 2604 { # Represents an Operation resource. 2605 # 2606 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 2607 # 2608 # Operations can be global, regional or zonal. 2609 # - For global operations, use the globalOperations resource. 2610 # - For regional operations, use the regionOperations resource. 2611 # - For zonal operations, use the zonalOperations resource. 2612 # 2613 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 2614 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2615 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2616 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2617 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2618 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2619 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2620 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2621 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2622 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 2623 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 2624 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2625 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2626 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2627 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2628 { 2629 "message": "A String", # [Output Only] A human-readable description of the warning code. 2630 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2631 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2632 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2633 { 2634 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2635 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 2636 }, 2637 ], 2638 }, 2639 ], 2640 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 2641 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2642 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2643 "name": "A String", # [Output Only] Name of the resource. 2644 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2645 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2646 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2647 { 2648 "message": "A String", # [Output Only] An optional, human-readable error message. 2649 "code": "A String", # [Output Only] The error type identifier for this error. 2650 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2651 }, 2652 ], 2653 }, 2654 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2655 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2656 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 2657 }</pre> 2658</div> 2659 2660<div class="method"> 2661 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 2662 <pre>Retrieves the list of UrlMap resources available to the specified project. 2663 2664Args: 2665 project: string, Project ID for this request. (required) 2666 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 2667 2668You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 2669 2670Currently, only sorting by name or creationTimestamp desc is supported. 2671 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 2672 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. 2673 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 2674 2675For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 2676 2677You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 2678 2679To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 2680 2681Returns: 2682 An object of the form: 2683 2684 { # Contains a list of UrlMap resources. 2685 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 2686 "kind": "compute#urlMapList", # Type of resource. 2687 "items": [ # A list of UrlMap resources. 2688 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. 2689 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 2690 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 2691 "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. 2692 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 2693 "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. 2694 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 2695 }, 2696 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 2697 "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. 2698 "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. 2699 "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 2700 }, 2701 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 2702 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 2703 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 2704 # - 2705 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 2706 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 2707 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 2708 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 2709 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 2710 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 2711 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 2712 "A String", 2713 ], 2714 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 2715 }, 2716 "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. 2717 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 2718 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 2719 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 2720 # The value must be between 0.0 and 100.0 inclusive. 2721 "fixedDelay": { # 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 value of the fixed delay interval. 2722 "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. 2723 "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 2724 }, 2725 }, 2726 "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. 2727 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 2728 # The value must be between 0.0 and 100.0 inclusive. 2729 "httpStatus": 42, # The HTTP status code used to abort the request. 2730 # The value must be between 200 and 599 inclusive. 2731 }, 2732 }, 2733 "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 2734 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 2735 "A String", 2736 ], 2737 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 2738 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2739 "A String", 2740 ], 2741 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 2742 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2743 "A String", 2744 ], 2745 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 2746 "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. 2747 # Default is false. 2748 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 2749 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 2750 "A String", 2751 ], 2752 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 2753 "A String", 2754 ], 2755 }, 2756 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 2757 # If not specified, the default value is 15 seconds. 2758 "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. 2759 "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 2760 }, 2761 "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. 2762 # 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. 2763 { # 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 2764 "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. 2765 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 2766 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2767 "A String", 2768 ], 2769 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2770 "A String", 2771 ], 2772 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2773 { # Specification determining how headers are added to requests or responses. 2774 "headerName": "A String", # The name of the header. 2775 "headerValue": "A String", # The value of the header to add. 2776 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2777 # The default value is false. 2778 }, 2779 ], 2780 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2781 { # Specification determining how headers are added to requests or responses. 2782 "headerName": "A String", # The name of the header. 2783 "headerValue": "A String", # The value of the header to add. 2784 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2785 # The default value is false. 2786 }, 2787 ], 2788 }, 2789 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 2790 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 2791 # The value must be between 0 and 1000 2792 "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. 2793 }, 2794 ], 2795 "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 2796 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 2797 # The value must be between 1 and 255 characters. 2798 "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. 2799 # The value must be between 1 and 1024 characters. 2800 }, 2801 }, 2802 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 2803 "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. 2804 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 2805 "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. 2806 { # Message for the expected URL mappings. 2807 "path": "A String", # Path portion of the URL. 2808 "host": "A String", # Host portion of the URL. 2809 "description": "A String", # Description of this test case. 2810 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 2811 }, 2812 ], 2813 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2814 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 2815 # 2816 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 2817 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 2818 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 2819 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 2820 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 2821 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 2822 "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. 2823 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 2824 }, 2825 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 2826 "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. 2827 "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. 2828 "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 2829 }, 2830 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 2831 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 2832 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 2833 # - 2834 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 2835 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 2836 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 2837 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 2838 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 2839 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 2840 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 2841 "A String", 2842 ], 2843 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 2844 }, 2845 "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. 2846 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 2847 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 2848 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 2849 # The value must be between 0.0 and 100.0 inclusive. 2850 "fixedDelay": { # 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 value of the fixed delay interval. 2851 "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. 2852 "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 2853 }, 2854 }, 2855 "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. 2856 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 2857 # The value must be between 0.0 and 100.0 inclusive. 2858 "httpStatus": 42, # The HTTP status code used to abort the request. 2859 # The value must be between 200 and 599 inclusive. 2860 }, 2861 }, 2862 "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 2863 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 2864 "A String", 2865 ], 2866 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 2867 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2868 "A String", 2869 ], 2870 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 2871 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 2872 "A String", 2873 ], 2874 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 2875 "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. 2876 # Default is false. 2877 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 2878 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 2879 "A String", 2880 ], 2881 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 2882 "A String", 2883 ], 2884 }, 2885 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 2886 # If not specified, the default value is 15 seconds. 2887 "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. 2888 "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 2889 }, 2890 "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. 2891 # 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. 2892 { # 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 2893 "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. 2894 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 2895 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2896 "A String", 2897 ], 2898 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2899 "A String", 2900 ], 2901 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2902 { # Specification determining how headers are added to requests or responses. 2903 "headerName": "A String", # The name of the header. 2904 "headerValue": "A String", # The value of the header to add. 2905 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2906 # The default value is false. 2907 }, 2908 ], 2909 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2910 { # Specification determining how headers are added to requests or responses. 2911 "headerName": "A String", # The name of the header. 2912 "headerValue": "A String", # The value of the header to add. 2913 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2914 # The default value is false. 2915 }, 2916 ], 2917 }, 2918 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 2919 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 2920 # The value must be between 0 and 1000 2921 "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. 2922 }, 2923 ], 2924 "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 2925 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 2926 # The value must be between 1 and 255 characters. 2927 "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. 2928 # The value must be between 1 and 1024 characters. 2929 }, 2930 }, 2931 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 2932 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 2933 # - compute/v1/projects/project/global/backendServices/backendService 2934 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 2935 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 2936 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 2937 # - compute.backendBuckets.use 2938 # - compute.backendServices.use 2939 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 2940 # Only one of pathRules or routeRules must be set. 2941 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 2942 "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. 2943 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 2944 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 2945 "A String", 2946 ], 2947 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 2948 "A String", 2949 ], 2950 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 2951 { # Specification determining how headers are added to requests or responses. 2952 "headerName": "A String", # The name of the header. 2953 "headerValue": "A String", # The value of the header to add. 2954 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2955 # The default value is false. 2956 }, 2957 ], 2958 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 2959 { # Specification determining how headers are added to requests or responses. 2960 "headerName": "A String", # The name of the header. 2961 "headerValue": "A String", # The value of the header to add. 2962 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 2963 # The default value is false. 2964 }, 2965 ], 2966 }, 2967 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 2968 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 2969 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 2970 # If urlRedirect is specified, service or routeAction must not be set. 2971 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 2972 # Only one of pathRedirect or prefixRedirect must be specified. 2973 # The value must be between 1 and 1024 characters. 2974 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 2975 # The default is set to false. 2976 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 2977 # Supported values are: 2978 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 2979 # - FOUND, which corresponds to 302. 2980 # - SEE_OTHER which corresponds to 303. 2981 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 2982 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 2983 "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. 2984 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 2985 # The default is set to false. 2986 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 2987 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 2988 # The value must be between 1 and 255 characters. 2989 }, 2990 "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. 2991 # Only one of routeAction or urlRedirect must be set. 2992 "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. 2993 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 2994 }, 2995 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 2996 "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. 2997 "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. 2998 "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 2999 }, 3000 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 3001 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 3002 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 3003 # - 3004 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 3005 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 3006 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 3007 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 3008 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 3009 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 3010 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 3011 "A String", 3012 ], 3013 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 3014 }, 3015 "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. 3016 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 3017 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 3018 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 3019 # The value must be between 0.0 and 100.0 inclusive. 3020 "fixedDelay": { # 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 value of the fixed delay interval. 3021 "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. 3022 "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 3023 }, 3024 }, 3025 "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. 3026 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 3027 # The value must be between 0.0 and 100.0 inclusive. 3028 "httpStatus": 42, # The HTTP status code used to abort the request. 3029 # The value must be between 200 and 599 inclusive. 3030 }, 3031 }, 3032 "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 3033 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 3034 "A String", 3035 ], 3036 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 3037 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3038 "A String", 3039 ], 3040 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3041 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3042 "A String", 3043 ], 3044 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 3045 "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. 3046 # Default is false. 3047 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 3048 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 3049 "A String", 3050 ], 3051 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 3052 "A String", 3053 ], 3054 }, 3055 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 3056 # If not specified, the default value is 15 seconds. 3057 "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. 3058 "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 3059 }, 3060 "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. 3061 # 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. 3062 { # 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 3063 "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. 3064 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 3065 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3066 "A String", 3067 ], 3068 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3069 "A String", 3070 ], 3071 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3072 { # Specification determining how headers are added to requests or responses. 3073 "headerName": "A String", # The name of the header. 3074 "headerValue": "A String", # The value of the header to add. 3075 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3076 # The default value is false. 3077 }, 3078 ], 3079 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3080 { # Specification determining how headers are added to requests or responses. 3081 "headerName": "A String", # The name of the header. 3082 "headerValue": "A String", # The value of the header to add. 3083 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3084 # The default value is false. 3085 }, 3086 ], 3087 }, 3088 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 3089 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 3090 # The value must be between 0 and 1000 3091 "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. 3092 }, 3093 ], 3094 "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 3095 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 3096 # The value must be between 1 and 255 characters. 3097 "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. 3098 # The value must be between 1 and 1024 characters. 3099 }, 3100 }, 3101 "matchRules": [ 3102 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 3103 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3104 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 3105 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 3106 { # matchRule criteria for request header matches. 3107 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 3108 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 3109 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3110 "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. 3111 # The default setting is false. 3112 "headerName": "A String", # The name of the HTTP header to match. 3113 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 3114 # For matching a request's method, use the headerName ":method". 3115 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 3116 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3117 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 3118 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3119 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 3120 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3121 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 3122 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3123 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 3124 # For example for a range [-5, 0] 3125 # - -3 will match. 3126 # - 0 will not match. 3127 # - 0.25 will not match. 3128 # - -3someString will not match. 3129 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3130 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 3131 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 3132 }, 3133 }, 3134 ], 3135 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 3136 # FullPathMatch must be between 1 and 1024 characters. 3137 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 3138 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 3139 # The value must be between 1 and 1024 characters. 3140 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 3141 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 3142 # The default value is false. 3143 # caseSensitive must not be used with regexMatch. 3144 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 3145 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 3146 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 3147 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 3148 { # 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 routing configuration is made available to those proxies. 3149 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 3150 # 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. 3151 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 3152 # Supported values are: 3153 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 3154 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 3155 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 3156 # This list must not be empty and can have at the most 64 entries. 3157 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 3158 "name": "A String", # Name of metadata label. 3159 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 3160 "value": "A String", # The value of the label must match the specified value. 3161 # value can have a maximum length of 1024 characters. 3162 }, 3163 ], 3164 }, 3165 ], 3166 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 3167 { # HttpRouteRuleMatch criteria for a request's query parameter. 3168 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 3169 # Only one of presentMatch, exactMatch and regexMatch must be set. 3170 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 3171 # Only one of presentMatch, exactMatch and regexMatch must be set. 3172 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 3173 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 3174 # Only one of presentMatch, exactMatch and regexMatch must be set. 3175 }, 3176 ], 3177 }, 3178 ], 3179 }, 3180 ], 3181 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 3182 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 3183 # Only one of pathRules or routeRules must be set. 3184 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 3185 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 3186 "A String", 3187 ], 3188 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 3189 # If urlRedirect is specified, service or routeAction must not be set. 3190 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 3191 # Only one of pathRedirect or prefixRedirect must be specified. 3192 # The value must be between 1 and 1024 characters. 3193 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 3194 # The default is set to false. 3195 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 3196 # Supported values are: 3197 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 3198 # - FOUND, which corresponds to 302. 3199 # - SEE_OTHER which corresponds to 303. 3200 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 3201 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 3202 "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. 3203 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 3204 # The default is set to false. 3205 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 3206 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 3207 # The value must be between 1 and 255 characters. 3208 }, 3209 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 3210 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 3211 "routeAction": { # In response to a matching path, 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. 3212 # Only one of routeAction or urlRedirect must be set. 3213 "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. 3214 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 3215 }, 3216 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 3217 "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. 3218 "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. 3219 "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 3220 }, 3221 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 3222 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 3223 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 3224 # - 3225 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 3226 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 3227 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 3228 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 3229 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 3230 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 3231 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 3232 "A String", 3233 ], 3234 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 3235 }, 3236 "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. 3237 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 3238 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 3239 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 3240 # The value must be between 0.0 and 100.0 inclusive. 3241 "fixedDelay": { # 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 value of the fixed delay interval. 3242 "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. 3243 "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 3244 }, 3245 }, 3246 "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. 3247 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 3248 # The value must be between 0.0 and 100.0 inclusive. 3249 "httpStatus": 42, # The HTTP status code used to abort the request. 3250 # The value must be between 200 and 599 inclusive. 3251 }, 3252 }, 3253 "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 3254 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 3255 "A String", 3256 ], 3257 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 3258 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3259 "A String", 3260 ], 3261 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3262 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3263 "A String", 3264 ], 3265 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 3266 "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. 3267 # Default is false. 3268 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 3269 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 3270 "A String", 3271 ], 3272 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 3273 "A String", 3274 ], 3275 }, 3276 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 3277 # If not specified, the default value is 15 seconds. 3278 "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. 3279 "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 3280 }, 3281 "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. 3282 # 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. 3283 { # 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 3284 "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. 3285 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 3286 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3287 "A String", 3288 ], 3289 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3290 "A String", 3291 ], 3292 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3293 { # Specification determining how headers are added to requests or responses. 3294 "headerName": "A String", # The name of the header. 3295 "headerValue": "A String", # The value of the header to add. 3296 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3297 # The default value is false. 3298 }, 3299 ], 3300 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3301 { # Specification determining how headers are added to requests or responses. 3302 "headerName": "A String", # The name of the header. 3303 "headerValue": "A String", # The value of the header to add. 3304 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3305 # The default value is false. 3306 }, 3307 ], 3308 }, 3309 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 3310 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 3311 # The value must be between 0 and 1000 3312 "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. 3313 }, 3314 ], 3315 "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 3316 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 3317 # The value must be between 1 and 255 characters. 3318 "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. 3319 # The value must be between 1 and 1024 characters. 3320 }, 3321 }, 3322 }, 3323 ], 3324 "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. 3325 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 3326 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3327 "A String", 3328 ], 3329 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3330 "A String", 3331 ], 3332 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3333 { # Specification determining how headers are added to requests or responses. 3334 "headerName": "A String", # The name of the header. 3335 "headerValue": "A String", # The value of the header to add. 3336 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3337 # The default value is false. 3338 }, 3339 ], 3340 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3341 { # Specification determining how headers are added to requests or responses. 3342 "headerName": "A String", # The name of the header. 3343 "headerValue": "A String", # The value of the header to add. 3344 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3345 # The default value is false. 3346 }, 3347 ], 3348 }, 3349 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 3350 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 3351 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 3352 # Only one of pathRedirect or prefixRedirect must be specified. 3353 # The value must be between 1 and 1024 characters. 3354 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 3355 # The default is set to false. 3356 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 3357 # Supported values are: 3358 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 3359 # - FOUND, which corresponds to 302. 3360 # - SEE_OTHER which corresponds to 303. 3361 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 3362 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 3363 "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. 3364 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 3365 # The default is set to false. 3366 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 3367 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 3368 # The value must be between 1 and 255 characters. 3369 }, 3370 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 3371 }, 3372 ], 3373 "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. 3374 # The headerAction specified here take effect after headerAction specified under pathMatcher. 3375 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3376 "A String", 3377 ], 3378 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3379 "A String", 3380 ], 3381 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3382 { # Specification determining how headers are added to requests or responses. 3383 "headerName": "A String", # The name of the header. 3384 "headerValue": "A String", # The value of the header to add. 3385 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3386 # The default value is false. 3387 }, 3388 ], 3389 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3390 { # Specification determining how headers are added to requests or responses. 3391 "headerName": "A String", # The name of the header. 3392 "headerValue": "A String", # The value of the header to add. 3393 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3394 # The default value is false. 3395 }, 3396 ], 3397 }, 3398 "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. 3399 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 3400 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 3401 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 3402 # Only one of pathRedirect or prefixRedirect must be specified. 3403 # The value must be between 1 and 1024 characters. 3404 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 3405 # The default is set to false. 3406 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 3407 # Supported values are: 3408 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 3409 # - FOUND, which corresponds to 302. 3410 # - SEE_OTHER which corresponds to 303. 3411 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 3412 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 3413 "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. 3414 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 3415 # The default is set to false. 3416 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 3417 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 3418 # The value must be between 1 and 255 characters. 3419 }, 3420 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 3421 "hostRules": [ # The list of HostRules to use against the URL. 3422 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 3423 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 3424 "A String", 3425 ], 3426 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 3427 "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. 3428 }, 3429 ], 3430 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 3431 }, 3432 ], 3433 "warning": { # [Output Only] Informational warning message. 3434 "message": "A String", # [Output Only] A human-readable description of the warning code. 3435 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3436 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 3437 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3438 { 3439 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3440 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 3441 }, 3442 ], 3443 }, 3444 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 3445 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 3446 }</pre> 3447</div> 3448 3449<div class="method"> 3450 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 3451 <pre>Retrieves the next page of results. 3452 3453Args: 3454 previous_request: The request for the previous page. (required) 3455 previous_response: The response from the request for the previous page. (required) 3456 3457Returns: 3458 A request object that you can call 'execute()' on to request the next 3459 page. Returns None if there are no more items in the collection. 3460 </pre> 3461</div> 3462 3463<div class="method"> 3464 <code class="details" id="patch">patch(project, urlMap, body, requestId=None)</code> 3465 <pre>Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. 3466 3467Args: 3468 project: string, Project ID for this request. (required) 3469 urlMap: string, Name of the UrlMap resource to patch. (required) 3470 body: object, The request body. (required) 3471 The object takes the form of: 3472 3473{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. 3474 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 3475 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 3476 "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. 3477 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 3478 "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. 3479 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 3480 }, 3481 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 3482 "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. 3483 "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. 3484 "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 3485 }, 3486 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 3487 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 3488 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 3489 # - 3490 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 3491 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 3492 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 3493 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 3494 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 3495 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 3496 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 3497 "A String", 3498 ], 3499 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 3500 }, 3501 "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. 3502 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 3503 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 3504 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 3505 # The value must be between 0.0 and 100.0 inclusive. 3506 "fixedDelay": { # 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 value of the fixed delay interval. 3507 "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. 3508 "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 3509 }, 3510 }, 3511 "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. 3512 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 3513 # The value must be between 0.0 and 100.0 inclusive. 3514 "httpStatus": 42, # The HTTP status code used to abort the request. 3515 # The value must be between 200 and 599 inclusive. 3516 }, 3517 }, 3518 "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 3519 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 3520 "A String", 3521 ], 3522 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 3523 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3524 "A String", 3525 ], 3526 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3527 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3528 "A String", 3529 ], 3530 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 3531 "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. 3532 # Default is false. 3533 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 3534 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 3535 "A String", 3536 ], 3537 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 3538 "A String", 3539 ], 3540 }, 3541 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 3542 # If not specified, the default value is 15 seconds. 3543 "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. 3544 "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 3545 }, 3546 "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. 3547 # 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. 3548 { # 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 3549 "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. 3550 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 3551 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3552 "A String", 3553 ], 3554 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3555 "A String", 3556 ], 3557 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3558 { # Specification determining how headers are added to requests or responses. 3559 "headerName": "A String", # The name of the header. 3560 "headerValue": "A String", # The value of the header to add. 3561 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3562 # The default value is false. 3563 }, 3564 ], 3565 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3566 { # Specification determining how headers are added to requests or responses. 3567 "headerName": "A String", # The name of the header. 3568 "headerValue": "A String", # The value of the header to add. 3569 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3570 # The default value is false. 3571 }, 3572 ], 3573 }, 3574 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 3575 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 3576 # The value must be between 0 and 1000 3577 "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. 3578 }, 3579 ], 3580 "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 3581 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 3582 # The value must be between 1 and 255 characters. 3583 "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. 3584 # The value must be between 1 and 1024 characters. 3585 }, 3586 }, 3587 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 3588 "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. 3589 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 3590 "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. 3591 { # Message for the expected URL mappings. 3592 "path": "A String", # Path portion of the URL. 3593 "host": "A String", # Host portion of the URL. 3594 "description": "A String", # Description of this test case. 3595 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 3596 }, 3597 ], 3598 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3599 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 3600 # 3601 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 3602 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 3603 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 3604 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 3605 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 3606 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 3607 "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. 3608 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 3609 }, 3610 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 3611 "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. 3612 "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. 3613 "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 3614 }, 3615 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 3616 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 3617 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 3618 # - 3619 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 3620 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 3621 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 3622 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 3623 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 3624 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 3625 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 3626 "A String", 3627 ], 3628 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 3629 }, 3630 "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. 3631 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 3632 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 3633 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 3634 # The value must be between 0.0 and 100.0 inclusive. 3635 "fixedDelay": { # 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 value of the fixed delay interval. 3636 "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. 3637 "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 3638 }, 3639 }, 3640 "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. 3641 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 3642 # The value must be between 0.0 and 100.0 inclusive. 3643 "httpStatus": 42, # The HTTP status code used to abort the request. 3644 # The value must be between 200 and 599 inclusive. 3645 }, 3646 }, 3647 "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 3648 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 3649 "A String", 3650 ], 3651 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 3652 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3653 "A String", 3654 ], 3655 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3656 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3657 "A String", 3658 ], 3659 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 3660 "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. 3661 # Default is false. 3662 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 3663 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 3664 "A String", 3665 ], 3666 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 3667 "A String", 3668 ], 3669 }, 3670 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 3671 # If not specified, the default value is 15 seconds. 3672 "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. 3673 "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 3674 }, 3675 "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. 3676 # 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. 3677 { # 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 3678 "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. 3679 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 3680 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3681 "A String", 3682 ], 3683 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3684 "A String", 3685 ], 3686 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3687 { # Specification determining how headers are added to requests or responses. 3688 "headerName": "A String", # The name of the header. 3689 "headerValue": "A String", # The value of the header to add. 3690 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3691 # The default value is false. 3692 }, 3693 ], 3694 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3695 { # Specification determining how headers are added to requests or responses. 3696 "headerName": "A String", # The name of the header. 3697 "headerValue": "A String", # The value of the header to add. 3698 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3699 # The default value is false. 3700 }, 3701 ], 3702 }, 3703 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 3704 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 3705 # The value must be between 0 and 1000 3706 "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. 3707 }, 3708 ], 3709 "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 3710 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 3711 # The value must be between 1 and 255 characters. 3712 "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. 3713 # The value must be between 1 and 1024 characters. 3714 }, 3715 }, 3716 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 3717 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 3718 # - compute/v1/projects/project/global/backendServices/backendService 3719 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 3720 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 3721 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 3722 # - compute.backendBuckets.use 3723 # - compute.backendServices.use 3724 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 3725 # Only one of pathRules or routeRules must be set. 3726 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 3727 "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. 3728 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 3729 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3730 "A String", 3731 ], 3732 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3733 "A String", 3734 ], 3735 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3736 { # Specification determining how headers are added to requests or responses. 3737 "headerName": "A String", # The name of the header. 3738 "headerValue": "A String", # The value of the header to add. 3739 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3740 # The default value is false. 3741 }, 3742 ], 3743 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3744 { # Specification determining how headers are added to requests or responses. 3745 "headerName": "A String", # The name of the header. 3746 "headerValue": "A String", # The value of the header to add. 3747 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3748 # The default value is false. 3749 }, 3750 ], 3751 }, 3752 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 3753 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 3754 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 3755 # If urlRedirect is specified, service or routeAction must not be set. 3756 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 3757 # Only one of pathRedirect or prefixRedirect must be specified. 3758 # The value must be between 1 and 1024 characters. 3759 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 3760 # The default is set to false. 3761 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 3762 # Supported values are: 3763 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 3764 # - FOUND, which corresponds to 302. 3765 # - SEE_OTHER which corresponds to 303. 3766 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 3767 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 3768 "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. 3769 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 3770 # The default is set to false. 3771 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 3772 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 3773 # The value must be between 1 and 255 characters. 3774 }, 3775 "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. 3776 # Only one of routeAction or urlRedirect must be set. 3777 "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. 3778 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 3779 }, 3780 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 3781 "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. 3782 "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. 3783 "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 3784 }, 3785 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 3786 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 3787 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 3788 # - 3789 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 3790 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 3791 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 3792 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 3793 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 3794 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 3795 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 3796 "A String", 3797 ], 3798 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 3799 }, 3800 "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. 3801 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 3802 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 3803 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 3804 # The value must be between 0.0 and 100.0 inclusive. 3805 "fixedDelay": { # 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 value of the fixed delay interval. 3806 "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. 3807 "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 3808 }, 3809 }, 3810 "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. 3811 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 3812 # The value must be between 0.0 and 100.0 inclusive. 3813 "httpStatus": 42, # The HTTP status code used to abort the request. 3814 # The value must be between 200 and 599 inclusive. 3815 }, 3816 }, 3817 "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 3818 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 3819 "A String", 3820 ], 3821 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 3822 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3823 "A String", 3824 ], 3825 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3826 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 3827 "A String", 3828 ], 3829 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 3830 "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. 3831 # Default is false. 3832 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 3833 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 3834 "A String", 3835 ], 3836 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 3837 "A String", 3838 ], 3839 }, 3840 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 3841 # If not specified, the default value is 15 seconds. 3842 "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. 3843 "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 3844 }, 3845 "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. 3846 # 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. 3847 { # 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 3848 "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. 3849 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 3850 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 3851 "A String", 3852 ], 3853 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 3854 "A String", 3855 ], 3856 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 3857 { # Specification determining how headers are added to requests or responses. 3858 "headerName": "A String", # The name of the header. 3859 "headerValue": "A String", # The value of the header to add. 3860 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3861 # The default value is false. 3862 }, 3863 ], 3864 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 3865 { # Specification determining how headers are added to requests or responses. 3866 "headerName": "A String", # The name of the header. 3867 "headerValue": "A String", # The value of the header to add. 3868 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 3869 # The default value is false. 3870 }, 3871 ], 3872 }, 3873 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 3874 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 3875 # The value must be between 0 and 1000 3876 "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. 3877 }, 3878 ], 3879 "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 3880 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 3881 # The value must be between 1 and 255 characters. 3882 "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. 3883 # The value must be between 1 and 1024 characters. 3884 }, 3885 }, 3886 "matchRules": [ 3887 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 3888 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 3889 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 3890 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 3891 { # matchRule criteria for request header matches. 3892 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 3893 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 3894 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3895 "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. 3896 # The default setting is false. 3897 "headerName": "A String", # The name of the HTTP header to match. 3898 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 3899 # For matching a request's method, use the headerName ":method". 3900 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 3901 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3902 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 3903 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3904 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 3905 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3906 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 3907 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3908 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 3909 # For example for a range [-5, 0] 3910 # - -3 will match. 3911 # - 0 will not match. 3912 # - 0.25 will not match. 3913 # - -3someString will not match. 3914 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 3915 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 3916 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 3917 }, 3918 }, 3919 ], 3920 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 3921 # FullPathMatch must be between 1 and 1024 characters. 3922 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 3923 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 3924 # The value must be between 1 and 1024 characters. 3925 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 3926 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 3927 # The default value is false. 3928 # caseSensitive must not be used with regexMatch. 3929 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 3930 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 3931 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 3932 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 3933 { # 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 routing configuration is made available to those proxies. 3934 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 3935 # 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. 3936 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 3937 # Supported values are: 3938 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 3939 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 3940 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 3941 # This list must not be empty and can have at the most 64 entries. 3942 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 3943 "name": "A String", # Name of metadata label. 3944 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 3945 "value": "A String", # The value of the label must match the specified value. 3946 # value can have a maximum length of 1024 characters. 3947 }, 3948 ], 3949 }, 3950 ], 3951 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 3952 { # HttpRouteRuleMatch criteria for a request's query parameter. 3953 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 3954 # Only one of presentMatch, exactMatch and regexMatch must be set. 3955 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 3956 # Only one of presentMatch, exactMatch and regexMatch must be set. 3957 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 3958 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 3959 # Only one of presentMatch, exactMatch and regexMatch must be set. 3960 }, 3961 ], 3962 }, 3963 ], 3964 }, 3965 ], 3966 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 3967 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 3968 # Only one of pathRules or routeRules must be set. 3969 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 3970 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 3971 "A String", 3972 ], 3973 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 3974 # If urlRedirect is specified, service or routeAction must not be set. 3975 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 3976 # Only one of pathRedirect or prefixRedirect must be specified. 3977 # The value must be between 1 and 1024 characters. 3978 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 3979 # The default is set to false. 3980 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 3981 # Supported values are: 3982 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 3983 # - FOUND, which corresponds to 302. 3984 # - SEE_OTHER which corresponds to 303. 3985 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 3986 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 3987 "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. 3988 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 3989 # The default is set to false. 3990 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 3991 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 3992 # The value must be between 1 and 255 characters. 3993 }, 3994 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 3995 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 3996 "routeAction": { # In response to a matching path, 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. 3997 # Only one of routeAction or urlRedirect must be set. 3998 "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. 3999 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 4000 }, 4001 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 4002 "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. 4003 "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. 4004 "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 4005 }, 4006 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 4007 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 4008 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 4009 # - 4010 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 4011 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 4012 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 4013 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 4014 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 4015 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 4016 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 4017 "A String", 4018 ], 4019 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 4020 }, 4021 "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. 4022 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 4023 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 4024 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 4025 # The value must be between 0.0 and 100.0 inclusive. 4026 "fixedDelay": { # 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 value of the fixed delay interval. 4027 "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. 4028 "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 4029 }, 4030 }, 4031 "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. 4032 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 4033 # The value must be between 0.0 and 100.0 inclusive. 4034 "httpStatus": 42, # The HTTP status code used to abort the request. 4035 # The value must be between 200 and 599 inclusive. 4036 }, 4037 }, 4038 "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 4039 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 4040 "A String", 4041 ], 4042 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 4043 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4044 "A String", 4045 ], 4046 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 4047 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4048 "A String", 4049 ], 4050 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 4051 "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. 4052 # Default is false. 4053 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 4054 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 4055 "A String", 4056 ], 4057 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 4058 "A String", 4059 ], 4060 }, 4061 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 4062 # If not specified, the default value is 15 seconds. 4063 "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. 4064 "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 4065 }, 4066 "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. 4067 # 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. 4068 { # 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 4069 "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. 4070 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 4071 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4072 "A String", 4073 ], 4074 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4075 "A String", 4076 ], 4077 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4078 { # Specification determining how headers are added to requests or responses. 4079 "headerName": "A String", # The name of the header. 4080 "headerValue": "A String", # The value of the header to add. 4081 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4082 # The default value is false. 4083 }, 4084 ], 4085 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4086 { # Specification determining how headers are added to requests or responses. 4087 "headerName": "A String", # The name of the header. 4088 "headerValue": "A String", # The value of the header to add. 4089 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4090 # The default value is false. 4091 }, 4092 ], 4093 }, 4094 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 4095 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 4096 # The value must be between 0 and 1000 4097 "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. 4098 }, 4099 ], 4100 "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 4101 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 4102 # The value must be between 1 and 255 characters. 4103 "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. 4104 # The value must be between 1 and 1024 characters. 4105 }, 4106 }, 4107 }, 4108 ], 4109 "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. 4110 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 4111 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4112 "A String", 4113 ], 4114 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4115 "A String", 4116 ], 4117 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4118 { # Specification determining how headers are added to requests or responses. 4119 "headerName": "A String", # The name of the header. 4120 "headerValue": "A String", # The value of the header to add. 4121 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4122 # The default value is false. 4123 }, 4124 ], 4125 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4126 { # Specification determining how headers are added to requests or responses. 4127 "headerName": "A String", # The name of the header. 4128 "headerValue": "A String", # The value of the header to add. 4129 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4130 # The default value is false. 4131 }, 4132 ], 4133 }, 4134 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 4135 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 4136 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 4137 # Only one of pathRedirect or prefixRedirect must be specified. 4138 # The value must be between 1 and 1024 characters. 4139 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 4140 # The default is set to false. 4141 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 4142 # Supported values are: 4143 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 4144 # - FOUND, which corresponds to 302. 4145 # - SEE_OTHER which corresponds to 303. 4146 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 4147 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 4148 "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. 4149 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 4150 # The default is set to false. 4151 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 4152 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 4153 # The value must be between 1 and 255 characters. 4154 }, 4155 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 4156 }, 4157 ], 4158 "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. 4159 # The headerAction specified here take effect after headerAction specified under pathMatcher. 4160 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4161 "A String", 4162 ], 4163 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4164 "A String", 4165 ], 4166 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4167 { # Specification determining how headers are added to requests or responses. 4168 "headerName": "A String", # The name of the header. 4169 "headerValue": "A String", # The value of the header to add. 4170 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4171 # The default value is false. 4172 }, 4173 ], 4174 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4175 { # Specification determining how headers are added to requests or responses. 4176 "headerName": "A String", # The name of the header. 4177 "headerValue": "A String", # The value of the header to add. 4178 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4179 # The default value is false. 4180 }, 4181 ], 4182 }, 4183 "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. 4184 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 4185 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 4186 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 4187 # Only one of pathRedirect or prefixRedirect must be specified. 4188 # The value must be between 1 and 1024 characters. 4189 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 4190 # The default is set to false. 4191 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 4192 # Supported values are: 4193 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 4194 # - FOUND, which corresponds to 302. 4195 # - SEE_OTHER which corresponds to 303. 4196 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 4197 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 4198 "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. 4199 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 4200 # The default is set to false. 4201 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 4202 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 4203 # The value must be between 1 and 255 characters. 4204 }, 4205 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 4206 "hostRules": [ # The list of HostRules to use against the URL. 4207 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 4208 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 4209 "A String", 4210 ], 4211 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 4212 "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. 4213 }, 4214 ], 4215 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 4216 } 4217 4218 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 4219 4220For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 4221 4222The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 4223 4224Returns: 4225 An object of the form: 4226 4227 { # Represents an Operation resource. 4228 # 4229 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 4230 # 4231 # Operations can be global, regional or zonal. 4232 # - For global operations, use the globalOperations resource. 4233 # - For regional operations, use the regionOperations resource. 4234 # - For zonal operations, use the zonalOperations resource. 4235 # 4236 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 4237 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4238 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4239 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4240 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 4241 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4242 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4243 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 4244 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 4245 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 4246 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 4247 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4248 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 4249 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4250 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4251 { 4252 "message": "A String", # [Output Only] A human-readable description of the warning code. 4253 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4254 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 4255 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4256 { 4257 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4258 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 4259 }, 4260 ], 4261 }, 4262 ], 4263 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 4264 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4265 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 4266 "name": "A String", # [Output Only] Name of the resource. 4267 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4268 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4269 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4270 { 4271 "message": "A String", # [Output Only] An optional, human-readable error message. 4272 "code": "A String", # [Output Only] The error type identifier for this error. 4273 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4274 }, 4275 ], 4276 }, 4277 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4278 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4279 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 4280 }</pre> 4281</div> 4282 4283<div class="method"> 4284 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 4285 <pre>Returns permissions that a caller has on the specified resource. 4286 4287Args: 4288 project: string, Project ID for this request. (required) 4289 resource: string, Name or id of the resource for this request. (required) 4290 body: object, The request body. (required) 4291 The object takes the form of: 4292 4293{ 4294 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 4295 "A String", 4296 ], 4297 } 4298 4299 4300Returns: 4301 An object of the form: 4302 4303 { 4304 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 4305 "A String", 4306 ], 4307 }</pre> 4308</div> 4309 4310<div class="method"> 4311 <code class="details" id="update">update(project, urlMap, body, requestId=None)</code> 4312 <pre>Updates the specified UrlMap resource with the data included in the request. 4313 4314Args: 4315 project: string, Project ID for this request. (required) 4316 urlMap: string, Name of the UrlMap resource to update. (required) 4317 body: object, The request body. (required) 4318 The object takes the form of: 4319 4320{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. 4321 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 4322 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 4323 "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. 4324 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 4325 "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. 4326 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 4327 }, 4328 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 4329 "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. 4330 "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. 4331 "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 4332 }, 4333 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 4334 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 4335 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 4336 # - 4337 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 4338 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 4339 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 4340 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 4341 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 4342 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 4343 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 4344 "A String", 4345 ], 4346 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 4347 }, 4348 "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. 4349 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 4350 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 4351 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 4352 # The value must be between 0.0 and 100.0 inclusive. 4353 "fixedDelay": { # 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 value of the fixed delay interval. 4354 "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. 4355 "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 4356 }, 4357 }, 4358 "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. 4359 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 4360 # The value must be between 0.0 and 100.0 inclusive. 4361 "httpStatus": 42, # The HTTP status code used to abort the request. 4362 # The value must be between 200 and 599 inclusive. 4363 }, 4364 }, 4365 "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 4366 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 4367 "A String", 4368 ], 4369 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 4370 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4371 "A String", 4372 ], 4373 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 4374 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4375 "A String", 4376 ], 4377 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 4378 "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. 4379 # Default is false. 4380 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 4381 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 4382 "A String", 4383 ], 4384 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 4385 "A String", 4386 ], 4387 }, 4388 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 4389 # If not specified, the default value is 15 seconds. 4390 "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. 4391 "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 4392 }, 4393 "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. 4394 # 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. 4395 { # 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 4396 "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. 4397 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 4398 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4399 "A String", 4400 ], 4401 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4402 "A String", 4403 ], 4404 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4405 { # Specification determining how headers are added to requests or responses. 4406 "headerName": "A String", # The name of the header. 4407 "headerValue": "A String", # The value of the header to add. 4408 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4409 # The default value is false. 4410 }, 4411 ], 4412 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4413 { # Specification determining how headers are added to requests or responses. 4414 "headerName": "A String", # The name of the header. 4415 "headerValue": "A String", # The value of the header to add. 4416 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4417 # The default value is false. 4418 }, 4419 ], 4420 }, 4421 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 4422 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 4423 # The value must be between 0 and 1000 4424 "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. 4425 }, 4426 ], 4427 "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 4428 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 4429 # The value must be between 1 and 255 characters. 4430 "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. 4431 # The value must be between 1 and 1024 characters. 4432 }, 4433 }, 4434 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 4435 "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. 4436 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 4437 "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. 4438 { # Message for the expected URL mappings. 4439 "path": "A String", # Path portion of the URL. 4440 "host": "A String", # Host portion of the URL. 4441 "description": "A String", # Description of this test case. 4442 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 4443 }, 4444 ], 4445 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4446 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 4447 # 4448 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 4449 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 4450 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 4451 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 4452 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 4453 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 4454 "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. 4455 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 4456 }, 4457 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 4458 "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. 4459 "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. 4460 "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 4461 }, 4462 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 4463 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 4464 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 4465 # - 4466 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 4467 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 4468 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 4469 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 4470 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 4471 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 4472 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 4473 "A String", 4474 ], 4475 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 4476 }, 4477 "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. 4478 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 4479 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 4480 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 4481 # The value must be between 0.0 and 100.0 inclusive. 4482 "fixedDelay": { # 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 value of the fixed delay interval. 4483 "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. 4484 "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 4485 }, 4486 }, 4487 "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. 4488 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 4489 # The value must be between 0.0 and 100.0 inclusive. 4490 "httpStatus": 42, # The HTTP status code used to abort the request. 4491 # The value must be between 200 and 599 inclusive. 4492 }, 4493 }, 4494 "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 4495 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 4496 "A String", 4497 ], 4498 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 4499 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4500 "A String", 4501 ], 4502 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 4503 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4504 "A String", 4505 ], 4506 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 4507 "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. 4508 # Default is false. 4509 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 4510 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 4511 "A String", 4512 ], 4513 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 4514 "A String", 4515 ], 4516 }, 4517 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 4518 # If not specified, the default value is 15 seconds. 4519 "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. 4520 "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 4521 }, 4522 "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. 4523 # 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. 4524 { # 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 4525 "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. 4526 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 4527 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4528 "A String", 4529 ], 4530 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4531 "A String", 4532 ], 4533 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4534 { # Specification determining how headers are added to requests or responses. 4535 "headerName": "A String", # The name of the header. 4536 "headerValue": "A String", # The value of the header to add. 4537 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4538 # The default value is false. 4539 }, 4540 ], 4541 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4542 { # Specification determining how headers are added to requests or responses. 4543 "headerName": "A String", # The name of the header. 4544 "headerValue": "A String", # The value of the header to add. 4545 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4546 # The default value is false. 4547 }, 4548 ], 4549 }, 4550 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 4551 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 4552 # The value must be between 0 and 1000 4553 "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. 4554 }, 4555 ], 4556 "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 4557 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 4558 # The value must be between 1 and 255 characters. 4559 "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. 4560 # The value must be between 1 and 1024 characters. 4561 }, 4562 }, 4563 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 4564 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 4565 # - compute/v1/projects/project/global/backendServices/backendService 4566 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 4567 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 4568 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 4569 # - compute.backendBuckets.use 4570 # - compute.backendServices.use 4571 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 4572 # Only one of pathRules or routeRules must be set. 4573 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 4574 "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. 4575 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 4576 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4577 "A String", 4578 ], 4579 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4580 "A String", 4581 ], 4582 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4583 { # Specification determining how headers are added to requests or responses. 4584 "headerName": "A String", # The name of the header. 4585 "headerValue": "A String", # The value of the header to add. 4586 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4587 # The default value is false. 4588 }, 4589 ], 4590 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4591 { # Specification determining how headers are added to requests or responses. 4592 "headerName": "A String", # The name of the header. 4593 "headerValue": "A String", # The value of the header to add. 4594 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4595 # The default value is false. 4596 }, 4597 ], 4598 }, 4599 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 4600 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 4601 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 4602 # If urlRedirect is specified, service or routeAction must not be set. 4603 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 4604 # Only one of pathRedirect or prefixRedirect must be specified. 4605 # The value must be between 1 and 1024 characters. 4606 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 4607 # The default is set to false. 4608 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 4609 # Supported values are: 4610 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 4611 # - FOUND, which corresponds to 302. 4612 # - SEE_OTHER which corresponds to 303. 4613 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 4614 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 4615 "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. 4616 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 4617 # The default is set to false. 4618 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 4619 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 4620 # The value must be between 1 and 255 characters. 4621 }, 4622 "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. 4623 # Only one of routeAction or urlRedirect must be set. 4624 "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. 4625 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 4626 }, 4627 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 4628 "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. 4629 "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. 4630 "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 4631 }, 4632 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 4633 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 4634 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 4635 # - 4636 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 4637 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 4638 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 4639 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 4640 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 4641 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 4642 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 4643 "A String", 4644 ], 4645 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 4646 }, 4647 "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. 4648 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 4649 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 4650 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 4651 # The value must be between 0.0 and 100.0 inclusive. 4652 "fixedDelay": { # 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 value of the fixed delay interval. 4653 "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. 4654 "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 4655 }, 4656 }, 4657 "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. 4658 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 4659 # The value must be between 0.0 and 100.0 inclusive. 4660 "httpStatus": 42, # The HTTP status code used to abort the request. 4661 # The value must be between 200 and 599 inclusive. 4662 }, 4663 }, 4664 "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 4665 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 4666 "A String", 4667 ], 4668 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 4669 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4670 "A String", 4671 ], 4672 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 4673 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4674 "A String", 4675 ], 4676 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 4677 "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. 4678 # Default is false. 4679 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 4680 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 4681 "A String", 4682 ], 4683 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 4684 "A String", 4685 ], 4686 }, 4687 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 4688 # If not specified, the default value is 15 seconds. 4689 "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. 4690 "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 4691 }, 4692 "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. 4693 # 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. 4694 { # 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 4695 "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. 4696 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 4697 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4698 "A String", 4699 ], 4700 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4701 "A String", 4702 ], 4703 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4704 { # Specification determining how headers are added to requests or responses. 4705 "headerName": "A String", # The name of the header. 4706 "headerValue": "A String", # The value of the header to add. 4707 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4708 # The default value is false. 4709 }, 4710 ], 4711 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4712 { # Specification determining how headers are added to requests or responses. 4713 "headerName": "A String", # The name of the header. 4714 "headerValue": "A String", # The value of the header to add. 4715 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4716 # The default value is false. 4717 }, 4718 ], 4719 }, 4720 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 4721 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 4722 # The value must be between 0 and 1000 4723 "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. 4724 }, 4725 ], 4726 "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 4727 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 4728 # The value must be between 1 and 255 characters. 4729 "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. 4730 # The value must be between 1 and 1024 characters. 4731 }, 4732 }, 4733 "matchRules": [ 4734 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 4735 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 4736 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 4737 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 4738 { # matchRule criteria for request header matches. 4739 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 4740 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 4741 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 4742 "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. 4743 # The default setting is false. 4744 "headerName": "A String", # The name of the HTTP header to match. 4745 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 4746 # For matching a request's method, use the headerName ":method". 4747 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 4748 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 4749 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 4750 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 4751 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 4752 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 4753 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 4754 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 4755 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 4756 # For example for a range [-5, 0] 4757 # - -3 will match. 4758 # - 0 will not match. 4759 # - 0.25 will not match. 4760 # - -3someString will not match. 4761 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 4762 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 4763 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 4764 }, 4765 }, 4766 ], 4767 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 4768 # FullPathMatch must be between 1 and 1024 characters. 4769 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 4770 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 4771 # The value must be between 1 and 1024 characters. 4772 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 4773 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 4774 # The default value is false. 4775 # caseSensitive must not be used with regexMatch. 4776 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 4777 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 4778 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 4779 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 4780 { # 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 routing configuration is made available to those proxies. 4781 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 4782 # 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. 4783 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 4784 # Supported values are: 4785 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 4786 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 4787 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 4788 # This list must not be empty and can have at the most 64 entries. 4789 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 4790 "name": "A String", # Name of metadata label. 4791 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 4792 "value": "A String", # The value of the label must match the specified value. 4793 # value can have a maximum length of 1024 characters. 4794 }, 4795 ], 4796 }, 4797 ], 4798 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 4799 { # HttpRouteRuleMatch criteria for a request's query parameter. 4800 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 4801 # Only one of presentMatch, exactMatch and regexMatch must be set. 4802 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 4803 # Only one of presentMatch, exactMatch and regexMatch must be set. 4804 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 4805 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 4806 # Only one of presentMatch, exactMatch and regexMatch must be set. 4807 }, 4808 ], 4809 }, 4810 ], 4811 }, 4812 ], 4813 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 4814 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 4815 # Only one of pathRules or routeRules must be set. 4816 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 4817 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 4818 "A String", 4819 ], 4820 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 4821 # If urlRedirect is specified, service or routeAction must not be set. 4822 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 4823 # Only one of pathRedirect or prefixRedirect must be specified. 4824 # The value must be between 1 and 1024 characters. 4825 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 4826 # The default is set to false. 4827 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 4828 # Supported values are: 4829 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 4830 # - FOUND, which corresponds to 302. 4831 # - SEE_OTHER which corresponds to 303. 4832 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 4833 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 4834 "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. 4835 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 4836 # The default is set to false. 4837 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 4838 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 4839 # The value must be between 1 and 255 characters. 4840 }, 4841 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 4842 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 4843 "routeAction": { # In response to a matching path, 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. 4844 # Only one of routeAction or urlRedirect must be set. 4845 "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. 4846 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 4847 }, 4848 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 4849 "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. 4850 "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. 4851 "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 4852 }, 4853 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 4854 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 4855 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 4856 # - 4857 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 4858 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 4859 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 4860 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 4861 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 4862 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 4863 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 4864 "A String", 4865 ], 4866 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 4867 }, 4868 "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. 4869 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 4870 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 4871 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 4872 # The value must be between 0.0 and 100.0 inclusive. 4873 "fixedDelay": { # 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 value of the fixed delay interval. 4874 "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. 4875 "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 4876 }, 4877 }, 4878 "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. 4879 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 4880 # The value must be between 0.0 and 100.0 inclusive. 4881 "httpStatus": 42, # The HTTP status code used to abort the request. 4882 # The value must be between 200 and 599 inclusive. 4883 }, 4884 }, 4885 "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 4886 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 4887 "A String", 4888 ], 4889 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 4890 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4891 "A String", 4892 ], 4893 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 4894 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 4895 "A String", 4896 ], 4897 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 4898 "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. 4899 # Default is false. 4900 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 4901 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 4902 "A String", 4903 ], 4904 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 4905 "A String", 4906 ], 4907 }, 4908 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 4909 # If not specified, the default value is 15 seconds. 4910 "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. 4911 "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 4912 }, 4913 "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. 4914 # 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. 4915 { # 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 4916 "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. 4917 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 4918 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4919 "A String", 4920 ], 4921 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4922 "A String", 4923 ], 4924 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4925 { # Specification determining how headers are added to requests or responses. 4926 "headerName": "A String", # The name of the header. 4927 "headerValue": "A String", # The value of the header to add. 4928 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4929 # The default value is false. 4930 }, 4931 ], 4932 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4933 { # Specification determining how headers are added to requests or responses. 4934 "headerName": "A String", # The name of the header. 4935 "headerValue": "A String", # The value of the header to add. 4936 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4937 # The default value is false. 4938 }, 4939 ], 4940 }, 4941 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 4942 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 4943 # The value must be between 0 and 1000 4944 "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. 4945 }, 4946 ], 4947 "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 4948 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 4949 # The value must be between 1 and 255 characters. 4950 "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. 4951 # The value must be between 1 and 1024 characters. 4952 }, 4953 }, 4954 }, 4955 ], 4956 "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. 4957 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 4958 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 4959 "A String", 4960 ], 4961 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 4962 "A String", 4963 ], 4964 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 4965 { # Specification determining how headers are added to requests or responses. 4966 "headerName": "A String", # The name of the header. 4967 "headerValue": "A String", # The value of the header to add. 4968 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4969 # The default value is false. 4970 }, 4971 ], 4972 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 4973 { # Specification determining how headers are added to requests or responses. 4974 "headerName": "A String", # The name of the header. 4975 "headerValue": "A String", # The value of the header to add. 4976 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 4977 # The default value is false. 4978 }, 4979 ], 4980 }, 4981 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 4982 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 4983 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 4984 # Only one of pathRedirect or prefixRedirect must be specified. 4985 # The value must be between 1 and 1024 characters. 4986 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 4987 # The default is set to false. 4988 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 4989 # Supported values are: 4990 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 4991 # - FOUND, which corresponds to 302. 4992 # - SEE_OTHER which corresponds to 303. 4993 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 4994 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 4995 "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. 4996 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 4997 # The default is set to false. 4998 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 4999 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 5000 # The value must be between 1 and 255 characters. 5001 }, 5002 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 5003 }, 5004 ], 5005 "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. 5006 # The headerAction specified here take effect after headerAction specified under pathMatcher. 5007 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5008 "A String", 5009 ], 5010 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5011 "A String", 5012 ], 5013 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5014 { # Specification determining how headers are added to requests or responses. 5015 "headerName": "A String", # The name of the header. 5016 "headerValue": "A String", # The value of the header to add. 5017 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5018 # The default value is false. 5019 }, 5020 ], 5021 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5022 { # Specification determining how headers are added to requests or responses. 5023 "headerName": "A String", # The name of the header. 5024 "headerValue": "A String", # The value of the header to add. 5025 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5026 # The default value is false. 5027 }, 5028 ], 5029 }, 5030 "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. 5031 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 5032 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 5033 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 5034 # Only one of pathRedirect or prefixRedirect must be specified. 5035 # The value must be between 1 and 1024 characters. 5036 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 5037 # The default is set to false. 5038 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 5039 # Supported values are: 5040 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 5041 # - FOUND, which corresponds to 302. 5042 # - SEE_OTHER which corresponds to 303. 5043 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 5044 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 5045 "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. 5046 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 5047 # The default is set to false. 5048 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 5049 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 5050 # The value must be between 1 and 255 characters. 5051 }, 5052 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 5053 "hostRules": [ # The list of HostRules to use against the URL. 5054 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 5055 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 5056 "A String", 5057 ], 5058 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 5059 "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. 5060 }, 5061 ], 5062 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 5063 } 5064 5065 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 5066 5067For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 5068 5069The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 5070 5071Returns: 5072 An object of the form: 5073 5074 { # Represents an Operation resource. 5075 # 5076 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 5077 # 5078 # Operations can be global, regional or zonal. 5079 # - For global operations, use the globalOperations resource. 5080 # - For regional operations, use the regionOperations resource. 5081 # - For zonal operations, use the zonalOperations resource. 5082 # 5083 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 5084 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5085 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 5086 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 5087 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 5088 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5089 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5090 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 5091 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 5092 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 5093 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 5094 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5095 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 5096 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 5097 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5098 { 5099 "message": "A String", # [Output Only] A human-readable description of the warning code. 5100 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5101 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 5102 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5103 { 5104 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5105 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 5106 }, 5107 ], 5108 }, 5109 ], 5110 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 5111 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5112 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 5113 "name": "A String", # [Output Only] Name of the resource. 5114 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5115 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 5116 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 5117 { 5118 "message": "A String", # [Output Only] An optional, human-readable error message. 5119 "code": "A String", # [Output Only] The error type identifier for this error. 5120 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 5121 }, 5122 ], 5123 }, 5124 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 5125 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5126 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 5127 }</pre> 5128</div> 5129 5130<div class="method"> 5131 <code class="details" id="validate">validate(project, urlMap, body)</code> 5132 <pre>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. 5133 5134Args: 5135 project: string, Project ID for this request. (required) 5136 urlMap: string, Name of the UrlMap resource to be validated as. (required) 5137 body: object, The request body. (required) 5138 The object takes the form of: 5139 5140{ 5141 "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated. 5142 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps. 5143 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 5144 "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. 5145 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 5146 "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. 5147 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 5148 }, 5149 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 5150 "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. 5151 "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. 5152 "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 5153 }, 5154 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 5155 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 5156 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 5157 # - 5158 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 5159 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 5160 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 5161 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 5162 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 5163 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 5164 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 5165 "A String", 5166 ], 5167 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 5168 }, 5169 "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. 5170 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 5171 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 5172 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 5173 # The value must be between 0.0 and 100.0 inclusive. 5174 "fixedDelay": { # 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 value of the fixed delay interval. 5175 "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. 5176 "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 5177 }, 5178 }, 5179 "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. 5180 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 5181 # The value must be between 0.0 and 100.0 inclusive. 5182 "httpStatus": 42, # The HTTP status code used to abort the request. 5183 # The value must be between 200 and 599 inclusive. 5184 }, 5185 }, 5186 "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 5187 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 5188 "A String", 5189 ], 5190 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 5191 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5192 "A String", 5193 ], 5194 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 5195 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5196 "A String", 5197 ], 5198 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 5199 "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. 5200 # Default is false. 5201 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 5202 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 5203 "A String", 5204 ], 5205 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 5206 "A String", 5207 ], 5208 }, 5209 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 5210 # If not specified, the default value is 15 seconds. 5211 "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. 5212 "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 5213 }, 5214 "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. 5215 # 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. 5216 { # 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 5217 "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. 5218 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 5219 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5220 "A String", 5221 ], 5222 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5223 "A String", 5224 ], 5225 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5226 { # Specification determining how headers are added to requests or responses. 5227 "headerName": "A String", # The name of the header. 5228 "headerValue": "A String", # The value of the header to add. 5229 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5230 # The default value is false. 5231 }, 5232 ], 5233 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5234 { # Specification determining how headers are added to requests or responses. 5235 "headerName": "A String", # The name of the header. 5236 "headerValue": "A String", # The value of the header to add. 5237 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5238 # The default value is false. 5239 }, 5240 ], 5241 }, 5242 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 5243 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 5244 # The value must be between 0 and 1000 5245 "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. 5246 }, 5247 ], 5248 "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 5249 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 5250 # The value must be between 1 and 255 characters. 5251 "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. 5252 # The value must be between 1 and 1024 characters. 5253 }, 5254 }, 5255 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 5256 "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. 5257 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 5258 "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. 5259 { # Message for the expected URL mappings. 5260 "path": "A String", # Path portion of the URL. 5261 "host": "A String", # Host portion of the URL. 5262 "description": "A String", # Description of this test case. 5263 "service": "A String", # Expected BackendService resource the given URL should be mapped to. 5264 }, 5265 ], 5266 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5267 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. 5268 # 5269 # To see the latest fingerprint, make a get() request to retrieve a UrlMap. 5270 "pathMatchers": [ # The list of named PathMatchers to use against the URL. 5271 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. 5272 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 5273 "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. 5274 # Only one of defaultRouteAction or defaultUrlRedirect must be set. 5275 "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. 5276 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 5277 }, 5278 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 5279 "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. 5280 "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. 5281 "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 5282 }, 5283 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 5284 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 5285 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 5286 # - 5287 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 5288 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 5289 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 5290 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 5291 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 5292 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 5293 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 5294 "A String", 5295 ], 5296 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 5297 }, 5298 "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. 5299 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 5300 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 5301 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 5302 # The value must be between 0.0 and 100.0 inclusive. 5303 "fixedDelay": { # 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 value of the fixed delay interval. 5304 "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. 5305 "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 5306 }, 5307 }, 5308 "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. 5309 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 5310 # The value must be between 0.0 and 100.0 inclusive. 5311 "httpStatus": 42, # The HTTP status code used to abort the request. 5312 # The value must be between 200 and 599 inclusive. 5313 }, 5314 }, 5315 "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 5316 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 5317 "A String", 5318 ], 5319 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 5320 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5321 "A String", 5322 ], 5323 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 5324 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5325 "A String", 5326 ], 5327 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 5328 "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. 5329 # Default is false. 5330 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 5331 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 5332 "A String", 5333 ], 5334 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 5335 "A String", 5336 ], 5337 }, 5338 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 5339 # If not specified, the default value is 15 seconds. 5340 "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. 5341 "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 5342 }, 5343 "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. 5344 # 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. 5345 { # 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 5346 "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. 5347 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 5348 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5349 "A String", 5350 ], 5351 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5352 "A String", 5353 ], 5354 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5355 { # Specification determining how headers are added to requests or responses. 5356 "headerName": "A String", # The name of the header. 5357 "headerValue": "A String", # The value of the header to add. 5358 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5359 # The default value is false. 5360 }, 5361 ], 5362 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5363 { # Specification determining how headers are added to requests or responses. 5364 "headerName": "A String", # The name of the header. 5365 "headerValue": "A String", # The value of the header to add. 5366 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5367 # The default value is false. 5368 }, 5369 ], 5370 }, 5371 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 5372 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 5373 # The value must be between 0 and 1000 5374 "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. 5375 }, 5376 ], 5377 "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 5378 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 5379 # The value must be between 1 and 255 characters. 5380 "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. 5381 # The value must be between 1 and 1024 characters. 5382 }, 5383 }, 5384 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: 5385 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService 5386 # - compute/v1/projects/project/global/backendServices/backendService 5387 # - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. 5388 # Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. 5389 # Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: 5390 # - compute.backendBuckets.use 5391 # - compute.backendServices.use 5392 "routeRules": [ # The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. 5393 # Only one of pathRules or routeRules must be set. 5394 { # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. 5395 "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. 5396 # The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 5397 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5398 "A String", 5399 ], 5400 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5401 "A String", 5402 ], 5403 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5404 { # Specification determining how headers are added to requests or responses. 5405 "headerName": "A String", # The name of the header. 5406 "headerValue": "A String", # The value of the header to add. 5407 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5408 # The default value is false. 5409 }, 5410 ], 5411 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5412 { # Specification determining how headers are added to requests or responses. 5413 "headerName": "A String", # The name of the header. 5414 "headerValue": "A String", # The value of the header to add. 5415 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5416 # The default value is false. 5417 }, 5418 ], 5419 }, 5420 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 5421 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 5422 "urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. 5423 # If urlRedirect is specified, service or routeAction must not be set. 5424 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 5425 # Only one of pathRedirect or prefixRedirect must be specified. 5426 # The value must be between 1 and 1024 characters. 5427 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 5428 # The default is set to false. 5429 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 5430 # Supported values are: 5431 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 5432 # - FOUND, which corresponds to 302. 5433 # - SEE_OTHER which corresponds to 303. 5434 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 5435 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 5436 "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. 5437 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 5438 # The default is set to false. 5439 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 5440 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 5441 # The value must be between 1 and 255 characters. 5442 }, 5443 "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. 5444 # Only one of routeAction or urlRedirect must be set. 5445 "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. 5446 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 5447 }, 5448 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 5449 "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. 5450 "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. 5451 "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 5452 }, 5453 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 5454 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 5455 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 5456 # - 5457 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 5458 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 5459 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 5460 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 5461 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 5462 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 5463 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 5464 "A String", 5465 ], 5466 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 5467 }, 5468 "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. 5469 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 5470 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 5471 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 5472 # The value must be between 0.0 and 100.0 inclusive. 5473 "fixedDelay": { # 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 value of the fixed delay interval. 5474 "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. 5475 "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 5476 }, 5477 }, 5478 "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. 5479 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 5480 # The value must be between 0.0 and 100.0 inclusive. 5481 "httpStatus": 42, # The HTTP status code used to abort the request. 5482 # The value must be between 200 and 599 inclusive. 5483 }, 5484 }, 5485 "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 5486 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 5487 "A String", 5488 ], 5489 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 5490 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5491 "A String", 5492 ], 5493 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 5494 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5495 "A String", 5496 ], 5497 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 5498 "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. 5499 # Default is false. 5500 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 5501 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 5502 "A String", 5503 ], 5504 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 5505 "A String", 5506 ], 5507 }, 5508 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 5509 # If not specified, the default value is 15 seconds. 5510 "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. 5511 "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 5512 }, 5513 "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. 5514 # 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. 5515 { # 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 5516 "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. 5517 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 5518 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5519 "A String", 5520 ], 5521 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5522 "A String", 5523 ], 5524 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5525 { # Specification determining how headers are added to requests or responses. 5526 "headerName": "A String", # The name of the header. 5527 "headerValue": "A String", # The value of the header to add. 5528 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5529 # The default value is false. 5530 }, 5531 ], 5532 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5533 { # Specification determining how headers are added to requests or responses. 5534 "headerName": "A String", # The name of the header. 5535 "headerValue": "A String", # The value of the header to add. 5536 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5537 # The default value is false. 5538 }, 5539 ], 5540 }, 5541 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 5542 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 5543 # The value must be between 0 and 1000 5544 "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. 5545 }, 5546 ], 5547 "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 5548 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 5549 # The value must be between 1 and 255 characters. 5550 "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. 5551 # The value must be between 1 and 1024 characters. 5552 }, 5553 }, 5554 "matchRules": [ 5555 { # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. 5556 "regexMatch": "A String", # For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 5557 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 5558 "headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request. 5559 { # matchRule criteria for request header matches. 5560 "regexMatch": "A String", # The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript 5561 # For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. 5562 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 5563 "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. 5564 # The default setting is false. 5565 "headerName": "A String", # The name of the HTTP header to match. 5566 # For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". 5567 # For matching a request's method, use the headerName ":method". 5568 "prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. 5569 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 5570 "suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. 5571 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 5572 "exactMatch": "A String", # The value should exactly match contents of exactMatch. 5573 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 5574 "presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. 5575 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 5576 "rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. 5577 # For example for a range [-5, 0] 5578 # - -3 will match. 5579 # - 0 will not match. 5580 # - 0.25 will not match. 5581 # - -3someString will not match. 5582 # Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 5583 "rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format. 5584 "rangeStart": "A String", # The start of the range (inclusive) in signed long integer format. 5585 }, 5586 }, 5587 ], 5588 "fullPathMatch": "A String", # For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. 5589 # FullPathMatch must be between 1 and 1024 characters. 5590 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 5591 "prefixMatch": "A String", # For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. 5592 # The value must be between 1 and 1024 characters. 5593 # Only one of prefixMatch, fullPathMatch or regexMatch must be specified. 5594 "ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. 5595 # The default value is false. 5596 # caseSensitive must not be used with regexMatch. 5597 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 5598 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 5599 # metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. 5600 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 5601 { # 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 routing configuration is made available to those proxies. 5602 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 5603 # 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. 5604 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 5605 # Supported values are: 5606 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 5607 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 5608 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 5609 # This list must not be empty and can have at the most 64 entries. 5610 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 5611 "name": "A String", # Name of metadata label. 5612 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 5613 "value": "A String", # The value of the label must match the specified value. 5614 # value can have a maximum length of 1024 characters. 5615 }, 5616 ], 5617 }, 5618 ], 5619 "queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. 5620 { # HttpRouteRuleMatch criteria for a request's query parameter. 5621 "presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. 5622 # Only one of presentMatch, exactMatch and regexMatch must be set. 5623 "regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript 5624 # Only one of presentMatch, exactMatch and regexMatch must be set. 5625 "name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. 5626 "exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. 5627 # Only one of presentMatch, exactMatch and regexMatch must be set. 5628 }, 5629 ], 5630 }, 5631 ], 5632 }, 5633 ], 5634 "pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. 5635 # For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. 5636 # Only one of pathRules or routeRules must be set. 5637 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. 5638 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. 5639 "A String", 5640 ], 5641 "urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. 5642 # If urlRedirect is specified, service or routeAction must not be set. 5643 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 5644 # Only one of pathRedirect or prefixRedirect must be specified. 5645 # The value must be between 1 and 1024 characters. 5646 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 5647 # The default is set to false. 5648 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 5649 # Supported values are: 5650 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 5651 # - FOUND, which corresponds to 302. 5652 # - SEE_OTHER which corresponds to 303. 5653 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 5654 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 5655 "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. 5656 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 5657 # The default is set to false. 5658 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 5659 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 5660 # The value must be between 1 and 255 characters. 5661 }, 5662 "service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. 5663 # Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 5664 "routeAction": { # In response to a matching path, 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. 5665 # Only one of routeAction or urlRedirect must be set. 5666 "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. 5667 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. 5668 }, 5669 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. 5670 "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. 5671 "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. 5672 "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 5673 }, 5674 "retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are: 5675 # - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. 5676 # - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. 5677 # - 5678 # - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. 5679 # - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. 5680 # - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. 5681 # - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled 5682 # - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded 5683 # - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted 5684 # - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable 5685 "A String", 5686 ], 5687 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. 5688 }, 5689 "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. 5690 # timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. 5691 "delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. 5692 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. 5693 # The value must be between 0.0 and 100.0 inclusive. 5694 "fixedDelay": { # 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 value of the fixed delay interval. 5695 "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. 5696 "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 5697 }, 5698 }, 5699 "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. 5700 "percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. 5701 # The value must be between 0.0 and 100.0 inclusive. 5702 "httpStatus": 42, # The HTTP status code used to abort the request. 5703 # The value must be between 200 and 599 inclusive. 5704 }, 5705 }, 5706 "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 5707 "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header. 5708 "A String", 5709 ], 5710 "allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. 5711 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5712 "A String", 5713 ], 5714 "allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript 5715 # An origin is allowed if it matches either allow_origins or allow_origin_regex. 5716 "A String", 5717 ], 5718 "maxAge": 42, # Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. 5719 "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. 5720 # Default is false. 5721 "disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. 5722 "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. 5723 "A String", 5724 ], 5725 "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header. 5726 "A String", 5727 ], 5728 }, 5729 "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 is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. 5730 # If not specified, the default value is 15 seconds. 5731 "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. 5732 "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 5733 }, 5734 "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. 5735 # 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. 5736 { # 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 5737 "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. 5738 # headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. 5739 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5740 "A String", 5741 ], 5742 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5743 "A String", 5744 ], 5745 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5746 { # Specification determining how headers are added to requests or responses. 5747 "headerName": "A String", # The name of the header. 5748 "headerValue": "A String", # The value of the header to add. 5749 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5750 # The default value is false. 5751 }, 5752 ], 5753 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5754 { # Specification determining how headers are added to requests or responses. 5755 "headerName": "A String", # The name of the header. 5756 "headerValue": "A String", # The value of the header to add. 5757 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5758 # The default value is false. 5759 }, 5760 ], 5761 }, 5762 "weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 5763 # The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. 5764 # The value must be between 0 and 1000 5765 "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. 5766 }, 5767 ], 5768 "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 5769 "hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. 5770 # The value must be between 1 and 255 characters. 5771 "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. 5772 # The value must be between 1 and 1024 characters. 5773 }, 5774 }, 5775 }, 5776 ], 5777 "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. 5778 # HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 5779 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5780 "A String", 5781 ], 5782 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5783 "A String", 5784 ], 5785 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5786 { # Specification determining how headers are added to requests or responses. 5787 "headerName": "A String", # The name of the header. 5788 "headerValue": "A String", # The value of the header to add. 5789 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5790 # The default value is false. 5791 }, 5792 ], 5793 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5794 { # Specification determining how headers are added to requests or responses. 5795 "headerName": "A String", # The name of the header. 5796 "headerValue": "A String", # The value of the header to add. 5797 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5798 # The default value is false. 5799 }, 5800 ], 5801 }, 5802 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. 5803 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 5804 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 5805 # Only one of pathRedirect or prefixRedirect must be specified. 5806 # The value must be between 1 and 1024 characters. 5807 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 5808 # The default is set to false. 5809 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 5810 # Supported values are: 5811 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 5812 # - FOUND, which corresponds to 302. 5813 # - SEE_OTHER which corresponds to 303. 5814 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 5815 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 5816 "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. 5817 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 5818 # The default is set to false. 5819 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 5820 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 5821 # The value must be between 1 and 255 characters. 5822 }, 5823 "name": "A String", # The name to which this PathMatcher is referred by the HostRule. 5824 }, 5825 ], 5826 "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. 5827 # The headerAction specified here take effect after headerAction specified under pathMatcher. 5828 "requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. 5829 "A String", 5830 ], 5831 "responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client. 5832 "A String", 5833 ], 5834 "requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService. 5835 { # Specification determining how headers are added to requests or responses. 5836 "headerName": "A String", # The name of the header. 5837 "headerValue": "A String", # The value of the header to add. 5838 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5839 # The default value is false. 5840 }, 5841 ], 5842 "responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client. 5843 { # Specification determining how headers are added to requests or responses. 5844 "headerName": "A String", # The name of the header. 5845 "headerValue": "A String", # The value of the header to add. 5846 "replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. 5847 # The default value is false. 5848 }, 5849 ], 5850 }, 5851 "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. 5852 "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. 5853 # If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. 5854 "pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 5855 # Only one of pathRedirect or prefixRedirect must be specified. 5856 # The value must be between 1 and 1024 characters. 5857 "stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. 5858 # The default is set to false. 5859 "redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. 5860 # Supported values are: 5861 # - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. 5862 # - FOUND, which corresponds to 302. 5863 # - SEE_OTHER which corresponds to 303. 5864 # - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. 5865 # - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. 5866 "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. 5867 # This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. 5868 # The default is set to false. 5869 "prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 5870 "hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. 5871 # The value must be between 1 and 255 characters. 5872 }, 5873 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 5874 "hostRules": [ # The list of HostRules to use against the URL. 5875 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. 5876 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. 5877 "A String", 5878 ], 5879 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 5880 "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. 5881 }, 5882 ], 5883 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 5884 }, 5885 } 5886 5887 5888Returns: 5889 An object of the form: 5890 5891 { 5892 "result": { # Message representing the validation result for a UrlMap. 5893 "testFailures": [ 5894 { 5895 "path": "A String", 5896 "actualService": "A String", 5897 "host": "A String", 5898 "expectedService": "A String", 5899 }, 5900 ], 5901 "loadErrors": [ 5902 "A String", 5903 ], 5904 "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. 5905 "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. 5906 }, 5907 }</pre> 5908</div> 5909 5910</body></html>