Class PathMatcher (1.38.0)

public final class PathMatcher extends GeneratedMessageV3 implements PathMatcherOrBuilder

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.

Protobuf type google.cloud.compute.v1.PathMatcher

Static Fields

DEFAULT_ROUTE_ACTION_FIELD_NUMBER

public static final int DEFAULT_ROUTE_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_SERVICE_FIELD_NUMBER

public static final int DEFAULT_SERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_URL_REDIRECT_FIELD_NUMBER

public static final int DEFAULT_URL_REDIRECT_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

HEADER_ACTION_FIELD_NUMBER

public static final int HEADER_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_RULES_FIELD_NUMBER

public static final int PATH_RULES_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTE_RULES_FIELD_NUMBER

public static final int ROUTE_RULES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PathMatcher getDefaultInstance()
Returns
TypeDescription
PathMatcher

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PathMatcher.Builder newBuilder()
Returns
TypeDescription
PathMatcher.Builder

newBuilder(PathMatcher prototype)

public static PathMatcher.Builder newBuilder(PathMatcher prototype)
Parameter
NameDescription
prototypePathMatcher
Returns
TypeDescription
PathMatcher.Builder

parseDelimitedFrom(InputStream input)

public static PathMatcher parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PathMatcher parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PathMatcher parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PathMatcher parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PathMatcher parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PathMatcher parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PathMatcher> parser()
Returns
TypeDescription
Parser<PathMatcher>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PathMatcher getDefaultInstanceForType()
Returns
TypeDescription
PathMatcher

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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
TypeDescription
HttpRouteAction

The defaultRouteAction.

getDefaultRouteActionOrBuilder()

public HttpRouteActionOrBuilder getDefaultRouteActionOrBuilder()

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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
TypeDescription
HttpRouteActionOrBuilder

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

optional string default_service = 370242231;

Returns
TypeDescription
String

The defaultService.

getDefaultServiceBytes()

public ByteString getDefaultServiceBytes()

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

optional string default_service = 370242231;

Returns
TypeDescription
ByteString

The bytes for defaultService.

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. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
TypeDescription
HttpRedirectAction

The defaultUrlRedirect.

getDefaultUrlRedirectOrBuilder()

public HttpRedirectActionOrBuilder getDefaultUrlRedirectOrBuilder()

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. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
TypeDescription
HttpRedirectActionOrBuilder

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

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.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
TypeDescription
HttpHeaderAction

The headerAction.

getHeaderActionOrBuilder()

public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()

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.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
TypeDescription
HttpHeaderActionOrBuilder

getName()

public String getName()

The name to which this PathMatcher is referred by the HostRule.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name to which this PathMatcher is referred by the HostRule.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<PathMatcher> getParserForType()
Returns
TypeDescription
Parser<PathMatcher>
Overrides

getPathRules(int index)

public PathRule getPathRules(int index)

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.

repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;

Parameter
NameDescription
indexint
Returns
TypeDescription
PathRule

getPathRulesCount()

public int getPathRulesCount()

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.

repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;

Returns
TypeDescription
int

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.

repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;

Returns
TypeDescription
List<PathRule>

getPathRulesOrBuilder(int index)

public PathRuleOrBuilder getPathRulesOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;

Parameter
NameDescription
indexint
Returns
TypeDescription
PathRuleOrBuilder

getPathRulesOrBuilderList()

public List<? extends PathRuleOrBuilder> getPathRulesOrBuilderList()

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.

repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.PathRuleOrBuilder>

getRouteRules(int index)

public HttpRouteRule getRouteRules(int index)

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.

repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;

Parameter
NameDescription
indexint
Returns
TypeDescription
HttpRouteRule

getRouteRulesCount()

public int getRouteRulesCount()

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.

repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;

Returns
TypeDescription
int

getRouteRulesList()

public List<HttpRouteRule> getRouteRulesList()

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.

repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;

Returns
TypeDescription
List<HttpRouteRule>

getRouteRulesOrBuilder(int index)

public HttpRouteRuleOrBuilder getRouteRulesOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;

Parameter
NameDescription
indexint
Returns
TypeDescription
HttpRouteRuleOrBuilder

getRouteRulesOrBuilderList()

public List<? extends HttpRouteRuleOrBuilder> getRouteRulesOrBuilderList()

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.

repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.HttpRouteRuleOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDefaultRouteAction()

public boolean hasDefaultRouteAction()

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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
TypeDescription
boolean

Whether the defaultRouteAction field is set.

hasDefaultService()

public boolean hasDefaultService()

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

optional string default_service = 370242231;

Returns
TypeDescription
boolean

Whether the defaultService field is set.

hasDefaultUrlRedirect()

public boolean hasDefaultUrlRedirect()

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. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
TypeDescription
boolean

Whether the defaultUrlRedirect field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasHeaderAction()

public boolean hasHeaderAction()

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.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
TypeDescription
boolean

Whether the headerAction field is set.

hasName()

public boolean hasName()

The name to which this PathMatcher is referred by the HostRule.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PathMatcher.Builder newBuilderForType()
Returns
TypeDescription
PathMatcher.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PathMatcher.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PathMatcher.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PathMatcher.Builder toBuilder()
Returns
TypeDescription
PathMatcher.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException