PathMatcher (Compute Engine API v1 (Rev. 235) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.PathMatcher

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class PathMatcher
extends com.google.api.client.json.GenericJson
```
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 will be used.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PathMatcher()

Constructors
Constructor and Description
`PathMatcher()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PathMatcher`	`clone()`
`HttpRouteAction`	`getDefaultRouteAction()` defaultRouteAction takes effect when none of the pathRules or routeRules match.
`java.lang.String`	`getDefaultService()` The full or partial URL to the BackendService resource.
`HttpRedirectAction`	`getDefaultUrlRedirect()` When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
`java.lang.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.
`java.lang.String`	`getName()` The name to which this PathMatcher is referred by the HostRule.
`java.util.List<PathRule>`	`getPathRules()` The list of path rules.
`java.util.List<HttpRouteRule>`	`getRouteRules()` The list of HTTP route rules.
`PathMatcher`	`set(java.lang.String fieldName, java.lang.Object value)`
`PathMatcher`	`setDefaultRouteAction(HttpRouteAction defaultRouteAction)` defaultRouteAction takes effect when none of the pathRules or routeRules match.
`PathMatcher`	`setDefaultService(java.lang.String defaultService)` The full or partial URL to the BackendService resource.
`PathMatcher`	`setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect)` When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.
`PathMatcher`	`setDescription(java.lang.String description)` An optional description of this resource.
`PathMatcher`	`setHeaderAction(HttpHeaderAction headerAction)` Specifies changes to request and response headers that need to take effect for the selected backendService.
`PathMatcher`	`setName(java.lang.String name)` The name to which this PathMatcher is referred by the HostRule.
`PathMatcher`	`setPathRules(java.util.List<PathRule> pathRules)` The list of path rules.
`PathMatcher`	`setRouteRules(java.util.List<HttpRouteRule> routeRules)` The list of HTTP route rules.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - PathMatcher
```
public PathMatcher()
```
- Method Detail
  - 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.
    
    Returns:
    
    value or null for none
  - setDefaultRouteAction
```
public PathMatcher 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.
    
    Parameters:
    
    defaultRouteAction - defaultRouteAction or null for none
  - getDefaultService
```
public java.lang.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
    
    Returns:
    
    value or null for none
  - setDefaultService
```
public PathMatcher setDefaultService(java.lang.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
    
    Parameters:
    
    defaultService - defaultService or null for none
  - getDefaultUrlRedirect
```
public HttpRedirectAction 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.
    
    Returns:
    
    value or null for none
  - setDefaultUrlRedirect
```
public PathMatcher setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect)
```
    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.
    
    Parameters:
    
    defaultUrlRedirect - defaultUrlRedirect or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public PathMatcher setDescription(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - 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
    
    Returns:
    
    value or null for none
  - setHeaderAction
```
public PathMatcher 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
    
    Parameters:
    
    headerAction - headerAction or null for none
  - getName
```
public java.lang.String getName()
```
    The name to which this PathMatcher is referred by the HostRule.
    
    Returns:
    
    value or null for none
  - setName
```
public PathMatcher setName(java.lang.String name)
```
    The name to which this PathMatcher is referred by the HostRule.
    
    Parameters:
    
    name - name or null for none
  - getPathRules
```
public java.util.List<PathRule> 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:
    
    value or null for none
  - setPathRules
```
public PathMatcher setPathRules(java.util.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.
    
    Parameters:
    
    pathRules - pathRules or null for none
  - getRouteRules
```
public java.util.List<HttpRouteRule> 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:
    
    value or null for none
  - setRouteRules
```
public PathMatcher setRouteRules(java.util.List<HttpRouteRule> routeRules)
```
    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.
    
    Parameters:
    
    routeRules - routeRules or null for none
  - set
```
public PathMatcher set(java.lang.String fieldName,
                       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public PathMatcher clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 235)

Class PathMatcher

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PathMatcher

Method Detail

getDefaultRouteAction

setDefaultRouteAction

getDefaultService

setDefaultService

getDefaultUrlRedirect

setDefaultUrlRedirect

getDescription

setDescription

getHeaderAction

setHeaderAction

getName

setName

getPathRules

setPathRules

getRouteRules

setRouteRules

set

clone