PathMatcher.Builder (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.PathMatcher.Builder

Enclosing class:: PathMatcher

public static class PathMatcher.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PathMatcher.Builder`	`addAllPathRules(List<PathRule> pathRules)` The list of path rules.
`PathMatcher.Builder`	`addAllRouteRules(List<HttpRouteRule> routeRules)` The list of ordered HTTP route rules.
`PathMatcher.Builder`	`addPathRules(PathRule pathRules)` The list of path rules.
`PathMatcher.Builder`	`addRouteRules(HttpRouteRule routeRules)` The list of ordered HTTP route rules.
`PathMatcher`	`build()`
`PathMatcher.Builder`	`clone()`
`HttpRouteAction`	`getDefaultRouteAction()` defaultRouteAction takes effect when none of the pathRules or routeRules match.
`String`	`getDefaultService()` The full or partial URL to the BackendService resource.
`HttpRedirectAction`	`getDefaultUrlRedirect()` When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
`String`	`getDescription()` An optional description of this resource.
`HttpHeaderAction`	`getHeaderAction()` Specifies changes to request and response headers that need to take effect for the selected backendService.
`String`	`getName()` The name to which this PathMatcher is referred by the HostRule.
`List<PathRule>`	`getPathRulesList()` The list of path rules.
`List<HttpRouteRule>`	`getRouteRulesList()` The list of ordered HTTP route rules.
`PathMatcher.Builder`	`mergeFrom(PathMatcher other)`
`PathMatcher.Builder`	`setDefaultRouteAction(HttpRouteAction defaultRouteAction)` defaultRouteAction takes effect when none of the pathRules or routeRules match.
`PathMatcher.Builder`	`setDefaultService(String defaultService)` The full or partial URL to the BackendService resource.
`PathMatcher.Builder`	`setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect)` When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
`PathMatcher.Builder`	`setDescription(String description)` An optional description of this resource.
`PathMatcher.Builder`	`setHeaderAction(HttpHeaderAction headerAction)` Specifies changes to request and response headers that need to take effect for the selected backendService.
`PathMatcher.Builder`	`setName(String name)` The name to which this PathMatcher is referred by the HostRule.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - mergeFrom
```
public PathMatcher.Builder mergeFrom(PathMatcher other)
```
  - getDefaultRouteAction
```
public HttpRouteAction getDefaultRouteAction()
```
    defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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.
  - setDefaultRouteAction
```
public PathMatcher.Builder setDefaultRouteAction(HttpRouteAction defaultRouteAction)
```
    defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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.
  - getDefaultService
```
public String getDefaultService()
```
    The full or partial URL to the BackendService resource. This will be 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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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
  - setDefaultService
```
public PathMatcher.Builder setDefaultService(String defaultService)
```
    The full or partial URL to the BackendService resource. This will be 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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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
  - getDefaultUrlRedirect
```
public HttpRedirectAction getDefaultUrlRedirect()
```
    When 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.
  - setDefaultUrlRedirect
```
public PathMatcher.Builder setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect)
```
    When 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.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - setDescription
```
public PathMatcher.Builder setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
  - getHeaderAction
```
public HttpHeaderAction getHeaderAction()
```
    Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
  - setHeaderAction
```
public PathMatcher.Builder setHeaderAction(HttpHeaderAction headerAction)
```
    Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap
  - getName
```
public String getName()
```
    The name to which this PathMatcher is referred by the HostRule.
  - setName
```
public PathMatcher.Builder setName(String name)
```
    The name to which this PathMatcher is referred by the HostRule.
  - getPathRulesList
```
public List<PathRule> getPathRulesList()
```
    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.
  - addAllPathRules
```
public PathMatcher.Builder addAllPathRules(List<PathRule> pathRules)
```
    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.
  - addPathRules
```
public PathMatcher.Builder addPathRules(PathRule pathRules)
```
    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.
  - getRouteRulesList
```
public List<HttpRouteRule> getRouteRulesList()
```
    The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers.
  - addAllRouteRules
```
public PathMatcher.Builder addAllRouteRules(List<HttpRouteRule> routeRules)
```
    The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers.
  - addRouteRules
```
public PathMatcher.Builder addRouteRules(HttpRouteRule routeRules)
```
    The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers.
  - build
```
public PathMatcher build()
```
  - clone
```
public PathMatcher.Builder clone()
```
    Overrides:
    
    clone in class Object

Class PathMatcher.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getDefaultRouteAction

setDefaultRouteAction

getDefaultService

setDefaultService

getDefaultUrlRedirect

setDefaultUrlRedirect

getDescription

setDescription

getHeaderAction

setHeaderAction

getName

setName

getPathRulesList

addAllPathRules

addPathRules

getRouteRulesList

addAllRouteRules

addRouteRules

build

clone