com.google.cloud.compute.v1

Class PathMatcher

java.lang.Object

com.google.cloud.compute.v1.PathMatcher

All Implemented Interfaces:

com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class PathMatcher
extends Object
implements com.google.api.gax.httpjson.ApiMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathMatcher.Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
com.google.api.gax.httpjson.ApiMessage	getApiMessageRequestBody()
static PathMatcher	getDefaultInstance()
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.
List<String>	getFieldMask()
Object	getFieldValue(String fieldName)
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.
int	hashCode()
static PathMatcher.Builder	newBuilder()
static PathMatcher.Builder	newBuilder(PathMatcher prototype)
PathMatcher.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFieldValue

public Object getFieldValue(String fieldName)

Specified by:

getFieldValue in interface com.google.api.gax.httpjson.ApiMessage

getApiMessageRequestBody

@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()

Specified by:

getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage

getFieldMask

@Nullable
public List<String> getFieldMask()

Specified by:

getFieldMask in interface com.google.api.gax.httpjson.ApiMessage

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.

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

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.

getDescription

public String getDescription()

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

getName

public String getName()

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.

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.

newBuilder

public static PathMatcher.Builder newBuilder()

newBuilder

public static PathMatcher.Builder newBuilder(PathMatcher prototype)

toBuilder

public PathMatcher.Builder toBuilder()

getDefaultInstance

public static PathMatcher getDefaultInstance()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object