target.apidocs.com.google.api.services.compute.model.PathMatcher.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20240903-2.0.0

Show newest version







PathMatcher (Compute Engine API v1-rev20240919-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class PathMatcher



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.PathMatcher













All Implemented Interfaces:
Cloneable, Map<String,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 is 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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


PathMatcher() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PathMatcher
clone() 


CustomErrorResponsePolicy
getDefaultCustomErrorResponsePolicy()
defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error.



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 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
 backend service.



String
getName()
The name to which this PathMatcher is referred by the HostRule.



List<PathRule>
getPathRules()
The list of path rules.



List<HttpRouteRule>
getRouteRules()
The list of HTTP route rules.



PathMatcher
set(String fieldName,
   Object value) 


PathMatcher
setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy defaultCustomErrorResponsePolicy)
defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error.



PathMatcher
setDefaultRouteAction(HttpRouteAction defaultRouteAction)
defaultRouteAction takes effect when none of the pathRules or routeRules match.



PathMatcher
setDefaultService(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(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
 backend service.



PathMatcher
setName(String name)
The name to which this PathMatcher is referred by the HostRule.



PathMatcher
setPathRules(List<PathRule> pathRules)
The list of path rules.



PathMatcher
setRouteRules(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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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





getDefaultCustomErrorResponsePolicy
public CustomErrorResponsePolicy getDefaultCustomErrorResponsePolicy()
defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error. This policy takes effect at the
 PathMatcher level and applies only when no policy has been defined for the error code at lower
 levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a
 policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in
 UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the
 following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies
 for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If
 the request is for www.myotherdomain.com and a 404 is encountered, the policy under
 UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the
 request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the
 request for www.example.com/coming_soon/ encounters a 404, the policy in
 RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example
 encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect.
 When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take
 precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is
 applied. While attempting a retry, if load balancer is successful in reaching the service, the
 defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to
 the client. defaultCustomErrorResponsePolicy is supported only for global external Application
 Load Balancers.

Returns:
value or null for none








setDefaultCustomErrorResponsePolicy
public PathMatcher setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy defaultCustomErrorResponsePolicy)
defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error. This policy takes effect at the
 PathMatcher level and applies only when no policy has been defined for the error code at lower
 levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a
 policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in
 UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the
 following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies
 for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If
 the request is for www.myotherdomain.com and a 404 is encountered, the policy under
 UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the
 request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the
 request for www.example.com/coming_soon/ encounters a 404, the policy in
 RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example
 encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect.
 When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take
 precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is
 applied. While attempting a retry, if load balancer is successful in reaching the service, the
 defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to
 the client. defaultCustomErrorResponsePolicy is supported only for global external Application
 Load Balancers.

Parameters:
defaultCustomErrorResponsePolicy - defaultCustomErrorResponsePolicy or null for none








getDefaultRouteAction
public HttpRouteAction 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. If defaultRouteAction is
 specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is
 specified, don't set defaultService. URL maps for classic Application Load Balancers only
 support the urlRewrite action within a path matcher's defaultRouteAction.

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, 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. If defaultRouteAction is
 specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is
 specified, don't set defaultService. URL maps for classic Application Load Balancers only
 support the urlRewrite action within a path matcher's defaultRouteAction.

Parameters:
defaultRouteAction - defaultRouteAction or null for none








getDefaultService
public String 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. If defaultService is specified, then set either defaultUrlRedirect or
 defaultRouteAction.weightedBackendService. Don't set both. 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(String defaultService)
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. If defaultService is specified, then set either defaultUrlRedirect or
 defaultRouteAction.weightedBackendService. Don't set both. 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, then set either
 defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound
 to a target gRPC proxy.

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, then set either
 defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound
 to a target gRPC proxy.

Parameters:
defaultUrlRedirect - defaultUrlRedirect or null for none








getDescription
public 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(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
 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:
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
 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.

Parameters:
headerAction - headerAction or null for none








getName
public String getName()
The name to which this PathMatcher is referred by the HostRule.

Returns:
value or null for none








setName
public PathMatcher setName(String name)
The name to which this PathMatcher is referred by the HostRule.

Parameters:
name - name or null for none








getPathRules
public 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(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 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(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(String fieldName,
                       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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`PathMatcher`	`clone()`
`CustomErrorResponsePolicy`	`getDefaultCustomErrorResponsePolicy()` defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error.
`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 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 backend service.
`String`	`getName()` The name to which this PathMatcher is referred by the HostRule.
`List<PathRule>`	`getPathRules()` The list of path rules.
`List<HttpRouteRule>`	`getRouteRules()` The list of HTTP route rules.
`PathMatcher`	`set(String fieldName, Object value)`
`PathMatcher`	`setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy defaultCustomErrorResponsePolicy)` defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error.
`PathMatcher`	`setDefaultRouteAction(HttpRouteAction defaultRouteAction)` defaultRouteAction takes effect when none of the pathRules or routeRules match.
`PathMatcher`	`setDefaultService(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(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 backend service.
`PathMatcher`	`setName(String name)` The name to which this PathMatcher is referred by the HostRule.
`PathMatcher`	`setPathRules(List<PathRule> pathRules)` The list of path rules.
`PathMatcher`	`setRouteRules(List<HttpRouteRule> routeRules)` The list of HTTP route rules.