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

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

Modifier and Type	Method and Description
PathRule	clone()
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 like URL rewrites, header transformations, etc.
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	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 like URL rewrites, header transformations, etc.
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

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 like URL rewrites, header transformations, etc. prior to 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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule'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 like URL rewrites, header transformations, etc. prior to 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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule'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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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 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 target gRPC proxy.

Parameters:

urlRedirect - urlRedirect or null for none

set

public PathRule set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public PathRule clone()

Overrides:

clone in class GenericJson