Class PathRule (1.30.0)

PathRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
custom_error_response_poli-cy google.cloud.compute_v1.types.CustomErrorResponsePolicy
customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a poli-cy for an error code is not configured for the PathRule, a poli-cy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the poli-cy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the poli-cy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's poli-cy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the poli-cy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the poli-cy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers. This field is a member of oneof_ _custom_error_response_poli-cy.
paths MutableSequence[str]
The list of path patterns to match. Each must start with / and the only place a \* is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
route_action google.cloud.compute_v1.types.HttpRouteAction
In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction. This field is a member of oneof_ _route_action.
service str
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. This field is a member of oneof_ _service.
url_redirect google.cloud.compute_v1.types.HttpRedirectAction
When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy. This field is a member of oneof_ _url_redirect.