target.apidocs.com.google.api.services.compute.model.PathRule.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







PathRule (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 PathRule



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.PathRule













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class PathRule
extends com.google.api.client.json.GenericJson
A path-matching rule for a URL. If matched, will use the specified BackendService to handle the
 traffic arriving at this URL.

  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


PathRule() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PathRule
clone() 


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



List<String>
getPaths()
The list of path patterns to match.



HttpRouteAction
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.



String
getService()
The full or partial URL of the backend service resource to which traffic is directed if this
 rule is matched.



HttpRedirectAction
getUrlRedirect()
When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.



PathRule
set(String fieldName,
   Object value) 


PathRule
setCustomErrorResponsePolicy(CustomErrorResponsePolicy customErrorResponsePolicy)
customErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error.



PathRule
setPaths(List<String> paths)
The list of path patterns to match.



PathRule
setRouteAction(HttpRouteAction routeAction)
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.



PathRule
setService(String service)
The full or partial URL of the backend service resource to which traffic is directed if this
 rule is matched.



PathRule
setUrlRedirect(HttpRedirectAction urlRedirect)
When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.







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





PathRule
public PathRule()









Method Detail





getCustomErrorResponsePolicy
public CustomErrorResponsePolicy getCustomErrorResponsePolicy()
customErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error. If a policy for an error code is not
 configured for the PathRule, a policy for the error code configured in
 pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in
 pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in
 UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the
 following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies
 for 5xx and 4xx errors - A PathRule 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
 PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example
 encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect.
 customErrorResponsePolicy is supported only for global external Application Load Balancers.

Returns:
value or null for none








setCustomErrorResponsePolicy
public PathRule setCustomErrorResponsePolicy(CustomErrorResponsePolicy customErrorResponsePolicy)
customErrorResponsePolicy specifies how the Load Balancer returns error responses when
 BackendServiceor BackendBucket responds with an error. If a policy for an error code is not
 configured for the PathRule, a policy for the error code configured in
 pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in
 pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in
 UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the
 following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies
 for 5xx and 4xx errors - A PathRule 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
 PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example
 encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect.
 customErrorResponsePolicy is supported only for global external Application Load Balancers.

Parameters:
customErrorResponsePolicy - customErrorResponsePolicy or null for none








getPaths
public List<String> 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.

Returns:
value or null for none








setPaths
public PathRule setPaths(List<String> paths)
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.

Parameters:
paths - paths or null for none








getRouteAction
public HttpRouteAction 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 Application Load Balancers only support the
 urlRewrite action within a path rule's routeAction.

Returns:
value or null for none








setRouteAction
public PathRule setRouteAction(HttpRouteAction routeAction)
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 Application Load Balancers only support the
 urlRewrite action within a path rule's routeAction.

Parameters:
routeAction - routeAction or null for none








getService
public String 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.

Returns:
value or null for none








setService
public PathRule setService(String service)
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.

Parameters:
service - service or null for none








getUrlRedirect
public HttpRedirectAction 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.

Returns:
value or null for none








setUrlRedirect
public PathRule setUrlRedirect(HttpRedirectAction urlRedirect)
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.

Parameters:
urlRedirect - urlRedirect or null for none








set
public PathRule set(String fieldName,
                    Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public PathRule 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
`PathRule`	`clone()`
`CustomErrorResponsePolicy`	`getCustomErrorResponsePolicy()` customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error.
`List<String>`	`getPaths()` The list of path patterns to match.
`HttpRouteAction`	`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.
`String`	`getService()` The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
`HttpRedirectAction`	`getUrlRedirect()` When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.
`PathRule`	`set(String fieldName, Object value)`
`PathRule`	`setCustomErrorResponsePolicy(CustomErrorResponsePolicy customErrorResponsePolicy)` customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error.
`PathRule`	`setPaths(List<String> paths)` The list of path patterns to match.
`PathRule`	`setRouteAction(HttpRouteAction routeAction)` 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.
`PathRule`	`setService(String service)` The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
`PathRule`	`setUrlRedirect(HttpRedirectAction urlRedirect)` When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.