Compute Engine v1 API - Class PathRule (3.1.0)

public sealed class PathRule : IMessage<PathRule>, IEquatable<PathRule>, IDeepCloneable<PathRule>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class PathRule.

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

Inheritance

object > PathRule

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

PathRule()

public PathRule()

PathRule(PathRule)

public PathRule(PathRule other)
Parameter
Name Description
other PathRule

Properties

CustomErrorResponsePolicy

public CustomErrorResponsePolicy CustomErrorResponsePolicy { get; set; }

customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy 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 policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers.

Property Value
Type Description
CustomErrorResponsePolicy

HasService

public bool HasService { get; }

Gets whether the "service" field is set

Property Value
Type Description
bool

Paths

public RepeatedField<string> Paths { get; }

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.

Property Value
Type Description
RepeatedFieldstring

RouteAction

public HttpRouteAction RouteAction { get; set; }

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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.

Property Value
Type Description
HttpRouteAction

Service

public string Service { get; set; }

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. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Property Value
Type Description
string

UrlRedirect

public HttpRedirectAction UrlRedirect { get; set; }

When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

Property Value
Type Description
HttpRedirectAction