Compute Engine v1 API - Class PathMatcher (2.3.0)

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

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

A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.

Inheritance

Object > PathMatcher

Implements

IMessage<PathMatcher>, IEquatable<PathMatcher>, IDeepCloneable<PathMatcher>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

PathMatcher()

public PathMatcher()

PathMatcher(PathMatcher)

public PathMatcher(PathMatcher other)

Parameter
Name	Description
`other`	`PathMatcher`

Properties

DefaultRouteAction

public HttpRouteAction DefaultRouteAction { get; set; }

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.

Property Value
Type	Description
`HttpRouteAction`

DefaultService

public string DefaultService { get; set; }

The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

Property Value
Type	Description
`String`

DefaultUrlRedirect

public HttpRedirectAction DefaultUrlRedirect { get; set; }

When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

Property Value
Type	Description
`HttpRedirectAction`

Description

public string Description { get; set; }

An optional description of this resource. Provide this property when you create the resource.

Property Value
Type	Description
`String`

HasDefaultService

public bool HasDefaultService { get; }

Gets whether the "default_service" field is set

Property Value
Type	Description
`Boolean`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`Boolean`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`Boolean`

HeaderAction

public HttpHeaderAction HeaderAction { get; set; }

Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Property Value
Type	Description
`HttpHeaderAction`

Name

public string Name { get; set; }

The name to which this PathMatcher is referred by the HostRule.

Property Value
Type	Description
`String`

PathRules

public RepeatedField<PathRule> PathRules { get; }

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.

Property Value
Type	Description
`RepeatedField<PathRule>`

RouteRules

public RepeatedField<HttpRouteRule> RouteRules { get; }

The list of HTTP route rules. Use this list instead of pathRules 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.

Property Value
Type	Description
`RepeatedField<HttpRouteRule>`