services/google/compute/beta/url

# Copyright 2025 Google LLC. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. info: title: Compute/UrlMap description: The Compute UrlMap resource x-dcl-struct-name: UrlMap x-dcl-has-iam: false paths: get: description: The function used to get information about a UrlMap parameters: - name: urlMap required: true description: A full instance of a UrlMap apply: description: The function used to apply information about a UrlMap parameters: - name: urlMap required: true description: A full instance of a UrlMap delete: description: The function used to delete a UrlMap parameters: - name: urlMap required: true description: A full instance of a UrlMap deleteAll: description: The function used to delete all UrlMap parameters: - name: project required: true schema: type: string - name: location required: true schema: type: string list: description: The function used to list information about many UrlMap parameters: - name: project required: true schema: type: string - name: location required: true schema: type: string components: schemas: UrlMap: title: UrlMap x-dcl-id: projects/{{project}}/global/urlMaps/{{name}} x-dcl-locations: - region - global x-dcl-parent-container: project x-dcl-has-create: true x-dcl-has-iam: false x-dcl-read-timeout: 0 x-dcl-apply-timeout: 0 x-dcl-delete-timeout: 0 type: object properties: defaultRouteAction: type: object x-dcl-go-name: DefaultRouteAction x-dcl-go-type: UrlMapDefaultRouteAction description: |- `defaultRouteAction` takes effect when none of the `hostRule`s 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 `weightedBackendService`s, `defaultService` must not be set. Conversely if `defaultService` is set, `defaultRouteAction` cannot contain any weightedBackendServices. Only one of `defaultRouteAction` or `defaultUrlRedirect` must be set. properties: corsPolicy: type: object x-dcl-go-name: CorsPolicy x-dcl-go-type: UrlMapDefaultRouteActionCorsPolicy description: The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) properties: allowCredentials: type: boolean x-dcl-go-name: AllowCredentials description: |- In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the `Access-Control-Allow-Credentials` header. Default is false. allowHeader: type: array x-dcl-go-name: AllowHeader description: Specifies the content for the `Access-Control-Allow-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowMethod: type: array x-dcl-go-name: AllowMethod description: Specifies the content for the `Access-Control-Allow-Methods` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOrigin: type: array x-dcl-go-name: AllowOrigin description: |- Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOriginRegex: type: array x-dcl-go-name: AllowOriginRegex description: |- Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see [en.cppreference.com/w/cpp/regex/ecmascript](https://en.cppreference.com/w/cpp/regex/ecmascript) An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string disabled: type: boolean x-dcl-go-name: Disabled description: If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. exposeHeader: type: array x-dcl-go-name: ExposeHeader description: Specifies the content for the `Access-Control-Expose-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string maxAge: type: integer format: int64 x-dcl-go-name: MaxAge description: Specifies how long results of a preflight request can be cached in seconds. This translates to the `Access-Control-Max-Age` header. faultInjectionPolicy: type: object x-dcl-go-name: FaultInjectionPolicy x-dcl-go-type: UrlMapDefaultRouteActionFaultInjectionPolicy description: |- The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. `timeout` and `retry_policy` will be ignored by clients that are configured with a `fault_injection_policy`. properties: abort: type: object x-dcl-go-name: Abort x-dcl-go-type: UrlMapDefaultRouteActionFaultInjectionPolicyAbort description: The specification for how client requests are aborted as part of fault injection. properties: httpStatus: type: integer format: int64 x-dcl-go-name: HttpStatus description: |- The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. delay: type: object x-dcl-go-name: Delay x-dcl-go-type: UrlMapDefaultRouteActionFaultInjectionPolicyDelay description: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. properties: fixedDelay: type: object x-dcl-go-name: FixedDelay x-dcl-go-type: UrlMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelay description: Specifies the value of the fixed delay interval. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. requestMirrorPolicy: type: object x-dcl-go-name: RequestMirrorPolicy x-dcl-go-type: UrlMapDefaultRouteActionRequestMirrorPolicy description: 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`. properties: backendService: type: string x-dcl-go-name: BackendService description: The full or partial URL to the BackendService resource being mirrored to. retryPolicy: type: object x-dcl-go-name: RetryPolicy x-dcl-go-type: UrlMapDefaultRouteActionRetryPolicy description: Specifies the retry policy associated with this route. properties: numRetries: type: integer format: int64 x-dcl-go-name: NumRetries description: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. perTryTimeout: type: object x-dcl-go-name: PerTryTimeout x-dcl-go-type: UrlMapDefaultRouteActionRetryPolicyPerTryTimeout description: |- Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' retryCondition: type: array x-dcl-go-name: RetryCondition description: |- Specfies one or more conditions when this retry rule applies. Valid values are: * `5xx`: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. * `gateway-error`: Similar to 5xx, but only applies to response codes 502, 503 or 504. * `connect-failure`: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. * `retriable-4xx`: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. * `refused-stream`:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. * `cancelled`Loadbalancer will retry if the gRPC status code in the response header is set to `cancelled` * `deadline-exceeded`: Loadbalancer will retry if the gRPC status code in the response header is set to `deadline-exceeded` * `resource-exhausted`: Loadbalancer will retry if the gRPC status code in the response header is set to `resource-exhausted` * `unavailable`: Loadbalancer will retry if the gRPC status code in the response header is set to `unavailable` x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string timeout: type: object x-dcl-go-name: Timeout x-dcl-go-type: UrlMapDefaultRouteActionTimeout description: |- Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: 'Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years' urlRewrite: type: object x-dcl-go-name: UrlRewrite x-dcl-go-type: UrlMapDefaultRouteActionUrlRewrite description: The spec to modify the URL of the request, prior to forwarding the request to the matched service. properties: hostRewrite: type: string x-dcl-go-name: HostRewrite description: |- Prior to forwarding the request to the selected service, the request's host header is replaced with contents of `hostRewrite`. The value must be between 1 and 255 characters. pathPrefixRewrite: type: string x-dcl-go-name: PathPrefixRewrite description: |- Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by `pathPrefixRewrite`. The value must be between 1 and 1024 characters. weightedBackendService: type: array x-dcl-go-name: WeightedBackendService description: |- A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding `backend service`. If all traffic needs to go to a single backend service, there must be one `weightedBackendService` with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this `HttpRouteAction`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapDefaultRouteActionWeightedBackendService properties: backendService: type: string x-dcl-go-name: BackendService description: 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`. x-dcl-references: - resource: Compute/BackendBucket field: selfLink - resource: Compute/BackendService field: selfLink headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapDefaultRouteActionWeightedBackendServiceHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected `backendService`. `headerAction` specified here take effect before `headerAction` in the enclosing `HttpRouteRule`, `PathMatcher` and `UrlMap`. properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string weight: type: integer format: int64 x-dcl-go-name: Weight description: |- Specifies the fraction of traffic sent to backendService, computed as `weight / (sum of all weightedBackendService weights in routeAction)` . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a `backendService`, subsequent requests will be sent to the same `backendService` as determined by the `BackendService`'s session affinity policy. The value must be between 0 and 1000 defaultService: type: string x-dcl-go-name: DefaultService description: |- The full or partial URL of the `defaultService` resource to which traffic is directed if none of the `hostRule`s 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 `weightedBackendService`s. Conversely, if `routeAction` specifies any `weightedBackendService`s, `service` must not be specified. Only one of `defaultService`, `defaultUrlRedirect` or `defaultRouteAction.weightedBackendService` must be set. defaultUrlRedirect: type: object x-dcl-go-name: DefaultUrlRedirect x-dcl-go-type: UrlMapDefaultUrlRedirect description: |- When none of the specified `hostRule`s match, the request is redirected to a URL specified by `defaultUrlRedirect`. If `defaultUrlRedirect` is specified, `defaultService` or `defaultRouteAction` must not be set. properties: hostRedirect: type: string x-dcl-go-name: HostRedirect description: |- The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. httpsRedirect: type: boolean x-dcl-go-name: HttpsRedirect description: |- If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for `UrlMap`s used in `TargetHttpProxy`s. Setting this true for `TargetHttpsProxy` is not permitted. The default is set to false. pathRedirect: type: string x-dcl-go-name: PathRedirect description: |- The path that will be used in the redirect response instead of the one that was supplied in the request. `pathRedirect` cannot be supplied together with `prefixRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. prefixRedirect: type: string x-dcl-go-name: PrefixRedirect description: |- The prefix that replaces the `prefixMatch` specified in the `HttpRouteRuleMatch`, retaining the remaining portion of the URL before redirecting the request. `prefixRedirect` cannot be supplied together with `pathRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. redirectResponseCode: type: string x-dcl-go-name: RedirectResponseCode x-dcl-go-type: UrlMapDefaultUrlRedirectRedirectResponseCodeEnum description: |- The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. * FOUND, which corresponds to 302. * SEE_OTHER which corresponds to 303. * TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. * PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. enum: - MOVED_PERMANENTLY_DEFAULT - FOUND - SEE_OTHER - TEMPORARY_REDIRECT - PERMANENT_REDIRECT stripQuery: type: boolean x-dcl-go-name: StripQuery description: |- If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. description: type: string x-dcl-go-name: Description description: An optional description of this resource. Provide this property when you create the resource. headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected `backendService`. The `headerAction` specified here take effect after `headerAction` specified under `pathMatcher`. properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string hostRule: type: array x-dcl-go-name: HostRule description: The list of HostRules to use against the URL. x-dcl-send-empty: true x-dcl-list-type: set items: type: object x-dcl-go-type: UrlMapHostRule properties: description: type: string x-dcl-go-name: Description description: An optional description of this resource. Provide this property when you create the resource. host: type: array x-dcl-go-name: Host description: The list of host patterns to match. They must be valid hostnames with optional port numbers in the format `host`:`port`. `*` matches any string of `([a-z0-9-.]*)`. In that case, `*` must be the first character and must be followed in the pattern by either `-` or `.`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string pathMatcher: type: string x-dcl-go-name: PathMatcher description: The name of the PathMatcher to use to match the path portion of the URL if the `hostRule` matches the URL's host portion. location: type: string x-dcl-go-name: Location description: The location this URL Map resides in. x-kubernetes-immutable: true x-dcl-parameter: true name: type: string x-dcl-go-name: Name description: 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](https://www.ietf.org/rfc/rfc1035.txt). 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. pathMatcher: type: array x-dcl-go-name: PathMatcher description: The list of named PathMatchers to use against the URL. x-dcl-send-empty: true x-dcl-list-type: set items: type: object x-dcl-go-type: UrlMapPathMatcher properties: defaultRouteAction: type: object x-dcl-go-name: DefaultRouteAction x-dcl-go-type: UrlMapPathMatcherDefaultRouteAction description: |- `defaultRouteAction` takes effect when none of the `pathRule`s or `routeRule`s 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 `weightedBackendService`s, `defaultService` must not be set. Conversely if `defaultService` is set, `defaultRouteAction` cannot contain any weightedBackendServices. Only one of `defaultRouteAction` or `defaultUrlRedirect` must be set. properties: corsPolicy: type: object x-dcl-go-name: CorsPolicy x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionCorsPolicy description: The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) properties: allowCredentials: type: boolean x-dcl-go-name: AllowCredentials description: |- In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the `Access-Control-Allow-Credentials` header. Default is false. allowHeader: type: array x-dcl-go-name: AllowHeader description: Specifies the content for the `Access-Control-Allow-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowMethod: type: array x-dcl-go-name: AllowMethod description: Specifies the content for the `Access-Control-Allow-Methods` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOrigin: type: array x-dcl-go-name: AllowOrigin description: |- Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOriginRegex: type: array x-dcl-go-name: AllowOriginRegex description: |- Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see [en.cppreference.com/w/cpp/regex/ecmascript](https://en.cppreference.com/w/cpp/regex/ecmascript) An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string disabled: type: boolean x-dcl-go-name: Disabled description: If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. exposeHeader: type: array x-dcl-go-name: ExposeHeader description: Specifies the content for the `Access-Control-Expose-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string maxAge: type: integer format: int64 x-dcl-go-name: MaxAge description: Specifies how long results of a preflight request can be cached in seconds. This translates to the `Access-Control-Max-Age` header. faultInjectionPolicy: type: object x-dcl-go-name: FaultInjectionPolicy x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionFaultInjectionPolicy description: |- The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. `timeout` and `retry_policy` will be ignored by clients that are configured with a `fault_injection_policy`. properties: abort: type: object x-dcl-go-name: Abort x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbort description: The specification for how client requests are aborted as part of fault injection. properties: httpStatus: type: integer format: int64 x-dcl-go-name: HttpStatus description: |- The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. delay: type: object x-dcl-go-name: Delay x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelay description: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. properties: fixedDelay: type: object x-dcl-go-name: FixedDelay x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelay description: Specifies the value of the fixed delay interval. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. requestMirrorPolicy: type: object x-dcl-go-name: RequestMirrorPolicy x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionRequestMirrorPolicy description: 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`. properties: backendService: type: string x-dcl-go-name: BackendService description: The full or partial URL to the BackendService resource being mirrored to. retryPolicy: type: object x-dcl-go-name: RetryPolicy x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionRetryPolicy description: Specifies the retry policy associated with this route. properties: numRetries: type: integer format: int64 x-dcl-go-name: NumRetries description: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. perTryTimeout: type: object x-dcl-go-name: PerTryTimeout x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeout description: |- Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' retryCondition: type: array x-dcl-go-name: RetryCondition description: |- Specfies one or more conditions when this retry rule applies. Valid values are: * `5xx`: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. * `gateway-error`: Similar to 5xx, but only applies to response codes 502, 503 or 504. * `connect-failure`: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. * `retriable-4xx`: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. * `refused-stream`:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. * `cancelled`Loadbalancer will retry if the gRPC status code in the response header is set to `cancelled` * `deadline-exceeded`: Loadbalancer will retry if the gRPC status code in the response header is set to `deadline-exceeded` * `resource-exhausted`: Loadbalancer will retry if the gRPC status code in the response header is set to `resource-exhausted` * `unavailable`: Loadbalancer will retry if the gRPC status code in the response header is set to `unavailable` x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string timeout: type: object x-dcl-go-name: Timeout x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionTimeout description: |- Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: 'Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years' urlRewrite: type: object x-dcl-go-name: UrlRewrite x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionUrlRewrite description: The spec to modify the URL of the request, prior to forwarding the request to the matched service. properties: hostRewrite: type: string x-dcl-go-name: HostRewrite description: |- Prior to forwarding the request to the selected service, the request's host header is replaced with contents of `hostRewrite`. The value must be between 1 and 255 characters. pathPrefixRewrite: type: string x-dcl-go-name: PathPrefixRewrite description: |- Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by `pathPrefixRewrite`. The value must be between 1 and 1024 characters. weightedBackendService: type: array x-dcl-go-name: WeightedBackendService description: |- A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding `backend service`. If all traffic needs to go to a single backend service, there must be one `weightedBackendService` with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this `HttpRouteAction`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionWeightedBackendService properties: backendService: type: string x-dcl-go-name: BackendService description: 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`. x-dcl-references: - resource: Compute/BackendBucket field: selfLink - resource: Compute/BackendService field: selfLink headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected `backendService`. `headerAction` specified here take effect before `headerAction` in the enclosing `HttpRouteRule`, `PathMatcher` and `UrlMap`. properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string weight: type: integer format: int64 x-dcl-go-name: Weight description: |- Specifies the fraction of traffic sent to backendService, computed as `weight / (sum of all weightedBackendService weights in routeAction)` . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a `backendService`, subsequent requests will be sent to the same `backendService` as determined by the `BackendService`'s session affinity policy. The value must be between 0 and 1000 defaultService: type: string x-dcl-go-name: DefaultService description: |- The full or partial URL to the BackendService resource. This will be used if none of the `pathRule`s or `routeRule`s defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: * `https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService` * `compute/v1/projects/project/global/backendServices/backendService` * `global/backendServices/backendService` 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 `weightedBackendService`s. Conversely, if `defaultRouteAction` specifies any `weightedBackendService`s, `defaultService` must not be specified. Only one of `defaultService`, `defaultUrlRedirect` or `defaultRouteAction.weightedBackendService` must be set. Authorization requires one or more of the following [Google IAM](https://cloud.google.com/iam) permissions on the specified resource default_service: * compute.backendBuckets.use * compute.backendServices.use defaultUrlRedirect: type: object x-dcl-go-name: DefaultUrlRedirect x-dcl-go-type: UrlMapPathMatcherDefaultUrlRedirect description: |- When none of the specified `pathRule`s or `routeRule`s match, the request is redirected to a URL specified by `defaultUrlRedirect`. If `defaultUrlRedirect` is specified, `defaultService` or `defaultRouteAction` must not be set. properties: hostRedirect: type: string x-dcl-go-name: HostRedirect description: |- The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. httpsRedirect: type: boolean x-dcl-go-name: HttpsRedirect description: |- If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for `UrlMap`s used in `TargetHttpProxy`s. Setting this true for `TargetHttpsProxy` is not permitted. The default is set to false. pathRedirect: type: string x-dcl-go-name: PathRedirect description: |- The path that will be used in the redirect response instead of the one that was supplied in the request. `pathRedirect` cannot be supplied together with `prefixRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. prefixRedirect: type: string x-dcl-go-name: PrefixRedirect description: |- The prefix that replaces the `prefixMatch` specified in the `HttpRouteRuleMatch`, retaining the remaining portion of the URL before redirecting the request. `prefixRedirect` cannot be supplied together with `pathRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. redirectResponseCode: type: string x-dcl-go-name: RedirectResponseCode x-dcl-go-type: UrlMapPathMatcherDefaultUrlRedirectRedirectResponseCodeEnum description: |- The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. * FOUND, which corresponds to 302. * SEE_OTHER which corresponds to 303. * TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. * PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. enum: - MOVED_PERMANENTLY_DEFAULT - FOUND - SEE_OTHER - TEMPORARY_REDIRECT - PERMANENT_REDIRECT stripQuery: type: boolean x-dcl-go-name: StripQuery description: |- If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. description: type: string x-dcl-go-name: Description description: An optional description of this resource. Provide this property when you create the resource. headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapPathMatcherHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching `HttpRouteRule` `HeaderAction` and before the `HeaderAction` in the `UrlMap` properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string name: type: string x-dcl-go-name: Name description: The name to which this PathMatcher is referred by the HostRule. pathRule: type: array x-dcl-go-name: PathRule description: |- The list of path rules. Use this list instead of `routeRules` when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a `pathRule` with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given `pathMatcher`, only one of `pathRules` or routeRules must be set. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherPathRule properties: backendService: type: string x-dcl-go-name: BackendService description: |- 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 `weightedBackendService`s, `service` must not be specified. Only one of `urlRedirect`, `service` or `routeAction.weightedBackendService` must be set. path: type: array x-dcl-go-name: Path description: 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. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string routeAction: type: object x-dcl-go-name: RouteAction x-dcl-go-type: UrlMapPathMatcherPathRuleRouteAction description: |- 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 `weightedBackendService`s, `service` must not be set. Conversely if `service` is set, `routeAction` cannot contain any weightedBackendServices. Only one of `routeAction` or `urlRedirect` must be set. properties: corsPolicy: type: object x-dcl-go-name: CorsPolicy x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionCorsPolicy description: The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) properties: allowCredentials: type: boolean x-dcl-go-name: AllowCredentials description: |- In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the `Access-Control-Allow-Credentials` header. Default is false. allowHeader: type: array x-dcl-go-name: AllowHeader description: Specifies the content for the `Access-Control-Allow-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowMethod: type: array x-dcl-go-name: AllowMethod description: Specifies the content for the `Access-Control-Allow-Methods` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOrigin: type: array x-dcl-go-name: AllowOrigin description: |- Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOriginRegex: type: array x-dcl-go-name: AllowOriginRegex description: |- Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see [en.cppreference.com/w/cpp/regex/ecmascript](https://en.cppreference.com/w/cpp/regex/ecmascript) An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string disabled: type: boolean x-dcl-go-name: Disabled description: If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. exposeHeader: type: array x-dcl-go-name: ExposeHeader description: Specifies the content for the `Access-Control-Expose-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string maxAge: type: integer format: int64 x-dcl-go-name: MaxAge description: Specifies how long results of a preflight request can be cached in seconds. This translates to the `Access-Control-Max-Age` header. faultInjectionPolicy: type: object x-dcl-go-name: FaultInjectionPolicy x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy description: |- The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. `timeout` and `retry_policy` will be ignored by clients that are configured with a `fault_injection_policy`. properties: abort: type: object x-dcl-go-name: Abort x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort description: The specification for how client requests are aborted as part of fault injection. properties: httpStatus: type: integer format: int64 x-dcl-go-name: HttpStatus description: |- The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. delay: type: object x-dcl-go-name: Delay x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay description: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. properties: fixedDelay: type: object x-dcl-go-name: FixedDelay x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay description: Specifies the value of the fixed delay interval. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. requestMirrorPolicy: type: object x-dcl-go-name: RequestMirrorPolicy x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy description: 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`. properties: backendService: type: string x-dcl-go-name: BackendService description: The full or partial URL to the BackendService resource being mirrored to. retryPolicy: type: object x-dcl-go-name: RetryPolicy x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionRetryPolicy description: Specifies the retry policy associated with this route. properties: numRetries: type: integer format: int64 x-dcl-go-name: NumRetries description: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. perTryTimeout: type: object x-dcl-go-name: PerTryTimeout x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout description: |- Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' retryCondition: type: array x-dcl-go-name: RetryCondition description: |- Specfies one or more conditions when this retry rule applies. Valid values are: * `5xx`: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. * `gateway-error`: Similar to 5xx, but only applies to response codes 502, 503 or 504. * `connect-failure`: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. * `retriable-4xx`: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. * `refused-stream`:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. * `cancelled`Loadbalancer will retry if the gRPC status code in the response header is set to `cancelled` * `deadline-exceeded`: Loadbalancer will retry if the gRPC status code in the response header is set to `deadline-exceeded` * `resource-exhausted`: Loadbalancer will retry if the gRPC status code in the response header is set to `resource-exhausted` * `unavailable`: Loadbalancer will retry if the gRPC status code in the response header is set to `unavailable` x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string timeout: type: object x-dcl-go-name: Timeout x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionTimeout description: |- Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: 'Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years' urlRewrite: type: object x-dcl-go-name: UrlRewrite x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionUrlRewrite description: The spec to modify the URL of the request, prior to forwarding the request to the matched service. properties: hostRewrite: type: string x-dcl-go-name: HostRewrite description: |- Prior to forwarding the request to the selected service, the request's host header is replaced with contents of `hostRewrite`. The value must be between 1 and 255 characters. pathPrefixRewrite: type: string x-dcl-go-name: PathPrefixRewrite description: |- Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by `pathPrefixRewrite`. The value must be between 1 and 1024 characters. weightedBackendService: type: array x-dcl-go-name: WeightedBackendService description: |- A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding `backend service`. If all traffic needs to go to a single backend service, there must be one `weightedBackendService` with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this `HttpRouteAction`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionWeightedBackendService properties: backendService: type: string x-dcl-go-name: BackendService description: The full or partial URL to the default BackendService resource. Before forwarding the request to `backendService`, the loadbalancer applies any relevant `headerActions` specified as part of this `backendServiceWeight`. headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected `backendService`. `headerAction` specified here take effect before `headerAction` in the enclosing `HttpRouteRule`, `PathMatcher` and `UrlMap`. properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string weight: type: integer format: int64 x-dcl-go-name: Weight description: |- Specifies the fraction of traffic sent to backendService, computed as `weight / (sum of all weightedBackendService weights in routeAction)` . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a `backendService`, subsequent requests will be sent to the same `backendService` as determined by the `BackendService`'s session affinity policy. The value must be between 0 and 1000 urlRedirect: type: object x-dcl-go-name: UrlRedirect x-dcl-go-type: UrlMapPathMatcherPathRuleUrlRedirect description: |- When a path pattern is matched, the request is redirected to a URL specified by `urlRedirect`. If `urlRedirect` is specified, `service` or `routeAction` must not be set. properties: hostRedirect: type: string x-dcl-go-name: HostRedirect description: |- The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. httpsRedirect: type: boolean x-dcl-go-name: HttpsRedirect description: |- If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for `UrlMap`s used in `TargetHttpProxy`s. Setting this true for `TargetHttpsProxy` is not permitted. The default is set to false. pathRedirect: type: string x-dcl-go-name: PathRedirect description: |- The path that will be used in the redirect response instead of the one that was supplied in the request. `pathRedirect` cannot be supplied together with `prefixRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. prefixRedirect: type: string x-dcl-go-name: PrefixRedirect description: |- The prefix that replaces the `prefixMatch` specified in the `HttpRouteRuleMatch`, retaining the remaining portion of the URL before redirecting the request. `prefixRedirect` cannot be supplied together with `pathRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. redirectResponseCode: type: string x-dcl-go-name: RedirectResponseCode x-dcl-go-type: UrlMapPathMatcherPathRuleUrlRedirectRedirectResponseCodeEnum description: |- The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. * FOUND, which corresponds to 302. * SEE_OTHER which corresponds to 303. * TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. * PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. enum: - MOVED_PERMANENTLY_DEFAULT - FOUND - SEE_OTHER - TEMPORARY_REDIRECT - PERMANENT_REDIRECT stripQuery: type: boolean x-dcl-go-name: StripQuery description: |- If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. routeRule: type: array x-dcl-go-name: RouteRule description: |- The list of HTTP route rules. Use this list instead of `pathRule`s when advanced route matching and routing actions are desired. `routeRules` are evaluated in order of priority, from the lowest to highest number. Within a given `pathMatcher`, you can set only one of `pathRules` or routeRules. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRule properties: backendService: type: string x-dcl-go-name: BackendService description: |- 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 `weightedBackendService`s, `service` must not be specified. Only one of `urlRedirect`, `service` or `routeAction.weightedBackendService` must be set. description: type: string x-dcl-go-name: Description description: |- The short description conveying the intent of this `routeRule`. The description can have a maximum length of 1024 characters. headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapPathMatcherRouteRuleHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string matchRule: type: array x-dcl-go-name: MatchRule description: NO DESCRIPTION FOUND. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRule properties: fullPathMatch: type: string x-dcl-go-name: FullPathMatch description: |- For satisfying the `matchRule` condition, the path of the request must exactly match the value specified in `fullPathMatch` after removing any query parameters and anchor that may be part of the original URL. `fullPathMatch` must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. headerMatch: type: array x-dcl-go-name: HeaderMatch description: Specifies a list of header match criteria, all of which must match corresponding headers in the request. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRuleHeaderMatch properties: exactMatch: type: string x-dcl-go-name: ExactMatch description: |- The value should exactly match contents of `exactMatch`. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. headerName: type: string x-dcl-go-name: HeaderName description: |- The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". invertMatch: type: boolean x-dcl-go-name: InvertMatch description: |- If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. prefixMatch: type: string x-dcl-go-name: PrefixMatch description: |- The value of the header must start with the contents of `prefixMatch`. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. presentMatch: type: boolean x-dcl-go-name: PresentMatch description: |- A header with the contents of `headerName` must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch: type: object x-dcl-go-name: RangeMatch x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch description: |- The header value must be an integer and its value must be in the range specified in `rangeMatch`. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] * -3 will match. * 0 will not match. * 0.25 will not match. * -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to `EXTERNAL`. properties: rangeEnd: type: integer format: int64 x-dcl-go-name: RangeEnd description: The end of the range (exclusive) in signed long integer format. rangeStart: type: integer format: int64 x-dcl-go-name: RangeStart description: The start of the range (inclusive) in signed long integer format. regexMatch: type: string x-dcl-go-name: RegexMatch description: |- The value of the header must match the regular expression specified in `regexMatch`. For regular expression grammar, please see: [en.cppreference.com/w/cpp/regex/ecmascript](https://en.cppreference.com/w/cpp/regex/ecmascript) For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`. suffixMatch: type: string x-dcl-go-name: SuffixMatch description: |- The value of the header must end with the contents of `suffixMatch`. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. ignoreCase: type: boolean x-dcl-go-name: IgnoreCase description: |- Specifies that `prefixMatch` and `fullPathMatch` matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. metadataFilter: type: array x-dcl-go-name: MetadataFilter description: |- Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of [xDS](https://github.com/envoyproxy/data-plane-api/blob/master/XDS_PROTOCOL.md) compliant clients. In their xDS requests to Loadbalancer, xDS clients present [node metadata](https://github.com/envoyproxy/data-plane-api/search?q=%22message+Node%22+in%3A%2Fenvoy%2Fapi%2Fv2%2Fcore%2Fbase.proto&). If a match takes place, the relevant routing configuration is made available to those proxies. For each `metadataFilter` in this list, if its `filterMatchCriteria` is set to MATCH_ANY, at least one of the `filterLabel`s must match the corresponding label provided in the metadata. If its `filterMatchCriteria` is set to MATCH_ALL, then all of its `filterLabel`s must match with corresponding labels provided in the metadata. `metadataFilters` specified here will be applied after those specified in `ForwardingRule` that refers to the `UrlMap` this ``HttpRouteRuleMatch `belongs to.` `` ``` `` `metadataFilters` only applies to Loadbalancers that have their`` loadBalancingScheme``` set to `INTERNAL_SELF_MANAGED`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRuleMetadataFilter properties: filterLabel: type: array x-dcl-go-name: FilterLabel description: |- The list of label value pairs that must match labels in the provided metadata based on `filterMatchCriteria` This list must not be empty and can have at the most 64 entries. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel properties: name: type: string x-dcl-go-name: Name description: |- Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. value: type: string x-dcl-go-name: Value description: |- The value of the label must match the specified value. value can have a maximum length of 1024 characters. filterMatchCriteria: type: string x-dcl-go-name: FilterMatchCriteria x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterMatchCriteriaEnum description: |- Specifies how individual `filterLabel` matches within the list of `filterLabel`s contribute towards the overall `metadataFilter` match. Supported values are: * MATCH_ANY: At least one of the `filterLabels` must have a matching label in the provided metadata. * MATCH_ALL: All `filterLabels` must have matching labels in the provided metadata. Possible values: NOT_SET, MATCH_ALL, MATCH_ANY enum: - NOT_SET - MATCH_ALL - MATCH_ANY prefixMatch: type: string x-dcl-go-name: PrefixMatch description: |- For satisfying the `matchRule` condition, the request's path must begin with the specified `prefixMatch`. `prefixMatch` must begin with a `/`. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. queryParameterMatch: type: array x-dcl-go-name: QueryParameterMatch description: Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleMatchRuleQueryParameterMatch properties: exactMatch: type: string x-dcl-go-name: ExactMatch description: |- The `queryParameterMatch` matches if the value of the parameter exactly matches the contents of `exactMatch`. Only one of presentMatch, exactMatch or regexMatch must be set. name: type: string x-dcl-go-name: Name description: 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. presentMatch: type: boolean x-dcl-go-name: PresentMatch description: |- Specifies that the `queryParameterMatch` matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch or regexMatch must be set. regexMatch: type: string x-dcl-go-name: RegexMatch description: |- 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](https://en.cppreference.com/w/cpp/regex/ecmascript) Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to `INTERNAL_SELF_MANAGED`. regexMatch: type: string x-dcl-go-name: RegexMatch description: |- For satisfying the `matchRule` condition, the path of the request must satisfy the regular expression specified in `regexMatch` after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see [en.cppreference.com/w/cpp/regex/ecmascript](https://en.cppreference.com/w/cpp/regex/ecmascript) Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`. priority: type: integer format: int64 x-dcl-go-name: Priority description: |- For `routeRules` within a given `pathMatcher`, priority determines the order in which load balancer will interpret `routeRules`. `RouteRules` are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. routeAction: type: object x-dcl-go-name: RouteAction x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteAction description: |- 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 `weightedBackendService`s, `service` must not be set. Conversely if `service` is set, `routeAction` cannot contain any weightedBackendServices. Only one of `urlRedirect`, `service` or `routeAction.weightedBackendService` must be set. properties: corsPolicy: type: object x-dcl-go-name: CorsPolicy x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionCorsPolicy description: The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) properties: allowCredentials: type: boolean x-dcl-go-name: AllowCredentials description: |- In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the `Access-Control-Allow-Credentials` header. Default is false. allowHeader: type: array x-dcl-go-name: AllowHeader description: Specifies the content for the `Access-Control-Allow-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowMethod: type: array x-dcl-go-name: AllowMethod description: Specifies the content for the `Access-Control-Allow-Methods` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOrigin: type: array x-dcl-go-name: AllowOrigin description: |- Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string allowOriginRegex: type: array x-dcl-go-name: AllowOriginRegex description: |- Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see [en.cppreference.com/w/cpp/regex/ecmascript](https://en.cppreference.com/w/cpp/regex/ecmascript) An origin is allowed if it matches either an item in `allowOrigins` or an item in `allowOriginRegexes`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string disabled: type: boolean x-dcl-go-name: Disabled description: If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. exposeHeader: type: array x-dcl-go-name: ExposeHeader description: Specifies the content for the `Access-Control-Expose-Headers` header. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string maxAge: type: integer format: int64 x-dcl-go-name: MaxAge description: Specifies how long results of a preflight request can be cached in seconds. This translates to the `Access-Control-Max-Age` header. faultInjectionPolicy: type: object x-dcl-go-name: FaultInjectionPolicy x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy description: |- The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. `timeout` and `retry_policy` will be ignored by clients that are configured with a `fault_injection_policy`. properties: abort: type: object x-dcl-go-name: Abort x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort description: The specification for how client requests are aborted as part of fault injection. properties: httpStatus: type: integer format: int64 x-dcl-go-name: HttpStatus description: |- The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. delay: type: object x-dcl-go-name: Delay x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay description: The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. properties: fixedDelay: type: object x-dcl-go-name: FixedDelay x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay description: Specifies the value of the fixed delay interval. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' percentage: type: number format: double x-dcl-go-name: Percentage description: |- The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. requestMirrorPolicy: type: object x-dcl-go-name: RequestMirrorPolicy x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy description: 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`. properties: backendService: type: string x-dcl-go-name: BackendService description: The full or partial URL to the BackendService resource being mirrored to. retryPolicy: type: object x-dcl-go-name: RetryPolicy x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionRetryPolicy description: Specifies the retry policy associated with this route. properties: numRetries: type: integer format: int64 x-dcl-go-name: NumRetries description: Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. perTryTimeout: type: object x-dcl-go-name: PerTryTimeout x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout description: |- Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: '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' retryCondition: type: array x-dcl-go-name: RetryCondition description: |- Specfies one or more conditions when this retry rule applies. Valid values are: * `5xx`: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. * `gateway-error`: Similar to 5xx, but only applies to response codes 502, 503 or 504. * `connect-failure`: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. * `retriable-4xx`: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. * `refused-stream`:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. * `cancelled`Loadbalancer will retry if the gRPC status code in the response header is set to `cancelled` * `deadline-exceeded`: Loadbalancer will retry if the gRPC status code in the response header is set to `deadline-exceeded` * `resource-exhausted`: Loadbalancer will retry if the gRPC status code in the response header is set to `resource-exhausted` * `unavailable`: Loadbalancer will retry if the gRPC status code in the response header is set to `unavailable` x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string timeout: type: object x-dcl-go-name: Timeout x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionTimeout description: |- Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. properties: nanos: type: integer format: int64 x-dcl-go-name: Nanos description: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. seconds: type: integer format: int64 x-dcl-go-name: Seconds description: 'Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years' urlRewrite: type: object x-dcl-go-name: UrlRewrite x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionUrlRewrite description: The spec to modify the URL of the request, prior to forwarding the request to the matched service. properties: hostRewrite: type: string x-dcl-go-name: HostRewrite description: |- Prior to forwarding the request to the selected service, the request's host header is replaced with contents of `hostRewrite`. The value must be between 1 and 255 characters. pathPrefixRewrite: type: string x-dcl-go-name: PathPrefixRewrite description: |- Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by `pathPrefixRewrite`. The value must be between 1 and 1024 characters. weightedBackendService: type: array x-dcl-go-name: WeightedBackendService description: |- A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding `backend service`. If all traffic needs to go to a single backend service, there must be one `weightedBackendService` with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this `HttpRouteAction`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionWeightedBackendService properties: backendService: type: string x-dcl-go-name: BackendService description: The full or partial URL to the default BackendService resource. Before forwarding the request to `backendService`, the loadbalancer applies any relevant `headerActions` specified as part of this `backendServiceWeight`. headerAction: type: object x-dcl-go-name: HeaderAction x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction description: |- Specifies changes to request and response headers that need to take effect for the selected `backendService`. `headerAction` specified here take effect before `headerAction` in the enclosing `HttpRouteRule`, `PathMatcher` and `UrlMap`. properties: requestHeadersToAdd: type: array x-dcl-go-name: RequestHeadersToAdd description: Headers to add to a matching request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. requestHeadersToRemove: type: array x-dcl-go-name: RequestHeadersToRemove description: A list of header names for headers that need to be removed from the request prior to forwarding the request to the `backendService`. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string responseHeadersToAdd: type: array x-dcl-go-name: ResponseHeadersToAdd description: Headers to add the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd properties: headerName: type: string x-dcl-go-name: HeaderName description: The name of the header. headerValue: type: string x-dcl-go-name: HeaderValue description: The value of the header to add. replace: type: boolean x-dcl-go-name: Replace description: |- If false, `headerValue` is appended to any values that already exist for the header. If true, `headerValue` is set for the header, discarding any values that were set for that header. The default value is false. responseHeadersToRemove: type: array x-dcl-go-name: ResponseHeadersToRemove description: A list of header names for headers that need to be removed from the response prior to sending the response back to the client. x-dcl-send-empty: true x-dcl-list-type: list items: type: string x-dcl-go-type: string weight: type: integer format: int64 x-dcl-go-name: Weight description: |- Specifies the fraction of traffic sent to backendService, computed as `weight / (sum of all weightedBackendService weights in routeAction)` . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a `backendService`, subsequent requests will be sent to the same `backendService` as determined by the `BackendService`'s session affinity policy. The value must be between 0 and 1000 urlRedirect: type: object x-dcl-go-name: UrlRedirect x-dcl-go-type: UrlMapPathMatcherRouteRuleUrlRedirect description: |- When this rule is matched, the request is redirected to a URL specified by `urlRedirect`. If `urlRedirect` is specified, `service` or `routeAction` must not be set. properties: hostRedirect: type: string x-dcl-go-name: HostRedirect description: |- The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. httpsRedirect: type: boolean x-dcl-go-name: HttpsRedirect description: |- If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for `UrlMap`s used in `TargetHttpProxy`s. Setting this true for `TargetHttpsProxy` is not permitted. The default is set to false. pathRedirect: type: string x-dcl-go-name: PathRedirect description: |- The path that will be used in the redirect response instead of the one that was supplied in the request. `pathRedirect` cannot be supplied together with `prefixRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. prefixRedirect: type: string x-dcl-go-name: PrefixRedirect description: |- The prefix that replaces the `prefixMatch` specified in the `HttpRouteRuleMatch`, retaining the remaining portion of the URL before redirecting the request. `prefixRedirect` cannot be supplied together with `pathRedirect`. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. redirectResponseCode: type: string x-dcl-go-name: RedirectResponseCode x-dcl-go-type: UrlMapPathMatcherRouteRuleUrlRedirectRedirectResponseCodeEnum description: |- The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. * FOUND, which corresponds to 302. * SEE_OTHER which corresponds to 303. * TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. * PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. enum: - MOVED_PERMANENTLY_DEFAULT - FOUND - SEE_OTHER - TEMPORARY_REDIRECT - PERMANENT_REDIRECT stripQuery: type: boolean x-dcl-go-name: StripQuery description: |- If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. project: type: string x-dcl-go-name: Project description: The project this URL Map resides in. x-kubernetes-immutable: true x-dcl-references: - resource: Cloudresourcemanager/Project field: name parent: true x-dcl-parameter: true region: type: string x-dcl-go-name: Region readOnly: true description: '[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.' x-kubernetes-immutable: true selfLink: type: string x-dcl-go-name: SelfLink readOnly: true description: Server-defined URL for the resource. x-kubernetes-immutable: true test: type: array x-dcl-go-name: Test description: 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. x-dcl-send-empty: true x-dcl-list-type: list items: type: object x-dcl-go-type: UrlMapTest properties: description: type: string x-dcl-go-name: Description description: Description of this test case. expectedBackendService: type: string x-dcl-go-name: ExpectedBackendService description: Expected BackendService resource the given URL should be mapped to. host: type: string x-dcl-go-name: Host description: Host portion of the URL. path: type: string x-dcl-go-name: Path description: Path portion of the URL.

services/google/compute/beta/url_map.yaml (2,446 lines of code) (raw):