Compute V1 Client - Class PathRule (1.5.0)

Reference documentation and code samples for the Compute V1 Client class PathRule.

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

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ paths`	`array` 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\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. 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 external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction.
`↳ service`	`string` 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.
`↳ url_redirect`	`Google\Cloud\Compute\V1\HttpRedirectAction` 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.

getPaths

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.

Generated from protobuf field repeated string paths = 106438894;

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

setPaths

Generated from protobuf field repeated string paths = 106438894;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getRouteAction

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 external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction.

Generated from protobuf field optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

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

hasRouteAction

clearRouteAction

setRouteAction

Generated from protobuf field optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

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

Returns
Type	Description
`$this`

getService

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.

Generated from protobuf field optional string service = 373540533;

Returns
Type	Description
`string`

hasService

clearService

setService

Generated from protobuf field optional string service = 373540533;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUrlRedirect

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.

Generated from protobuf field optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

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

hasUrlRedirect

clearUrlRedirect

setUrlRedirect

Generated from protobuf field optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

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

Returns
Type	Description
`$this`