Compute V1 Client - Class PathMatcher (1.13.0)

Reference documentation and code samples for the Compute V1 Client 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.

Generated from protobuf message google.cloud.compute.v1.PathMatcher

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ default_route_action`	`Google\Cloud\Compute\V1\HttpRouteAction` 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 Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
`↳ default_service`	`string` 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
`↳ default_url_redirect`	`Google\Cloud\Compute\V1\HttpRedirectAction` 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.
`↳ description`	`string` An optional description of this resource. Provide this property when you create the resource.
`↳ header_action`	`Google\Cloud\Compute\V1\HttpHeaderAction` 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.
`↳ name`	`string` The name to which this PathMatcher is referred by the HostRule.
`↳ path_rules`	`array<Google\Cloud\Compute\V1\PathRule>` 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.
`↳ route_rules`	`array<Google\Cloud\Compute\V1\HttpRouteRule>` 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.

getDefaultRouteAction

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 Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction.

Returns
Type	Description
`Google\Cloud\Compute\V1\HttpRouteAction\|null`

hasDefaultRouteAction

clearDefaultRouteAction

setDefaultRouteAction

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\HttpRouteAction`

Returns
Type	Description
`$this`

getDefaultService

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

Returns
Type	Description
`string`

hasDefaultService

clearDefaultService

setDefaultService

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDefaultUrlRedirect

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.

Returns
Type	Description
`Google\Cloud\Compute\V1\HttpRedirectAction\|null`

hasDefaultUrlRedirect

clearDefaultUrlRedirect

setDefaultUrlRedirect

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\HttpRedirectAction`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHeaderAction

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.

Returns
Type	Description
`Google\Cloud\Compute\V1\HttpHeaderAction\|null`

hasHeaderAction

clearHeaderAction

setHeaderAction

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\HttpHeaderAction`

Returns
Type	Description
`$this`

getName

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

Returns
Type	Description
`string`

hasName

clearName

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPathRules

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPathRules

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\PathRule>`

Returns
Type	Description
`$this`

getRouteRules

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRouteRules

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\HttpRouteRule>`

Returns
Type	Description
`$this`