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 will be 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
DEFAULT_SERVICE_FIELD_NUMBER
public static final int DEFAULT_SERVICE_FIELD_NUMBER
Field Value
DEFAULT_URL_REDIRECT_FIELD_NUMBER
public static final int DEFAULT_URL_REDIRECT_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
public static final int HEADER_ACTION_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PATH_RULES_FIELD_NUMBER
public static final int PATH_RULES_FIELD_NUMBER
Field Value
ROUTE_RULES_FIELD_NUMBER
public static final int ROUTE_RULES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PathMatcher getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PathMatcher.Builder newBuilder()
Returns
newBuilder(PathMatcher prototype)
public static PathMatcher.Builder newBuilder(PathMatcher prototype)
Parameter
Returns
public static PathMatcher parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PathMatcher parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PathMatcher parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PathMatcher parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PathMatcher parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PathMatcher parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PathMatcher parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PathMatcher parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PathMatcher parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PathMatcher parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PathMatcher parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PathMatcher parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PathMatcher> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PathMatcher getDefaultInstanceForType()
Returns
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
getDefaultRouteActionOrBuilder()
public HttpRouteActionOrBuilder getDefaultRouteActionOrBuilder()
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
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
optional string default_service = 370242231;
| Type | Description |
| String | The defaultService.
|
getDefaultServiceBytes()
public ByteString getDefaultServiceBytes()
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
optional string default_service = 370242231;
| Type | Description |
| 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 target gRPC proxy.
optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;
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 target gRPC proxy.
optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for description.
|
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 Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;
public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()
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 Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;
getName()
The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
getParserForType()
public Parser<PathMatcher> getParserForType()
Returns
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;
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;
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;
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;
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;
| Type | Description |
| 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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.HttpRouteRuleOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDefaultRouteAction()
public boolean hasDefaultRouteAction()
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
| Type | Description |
| boolean | Whether the defaultRouteAction field is set.
|
hasDefaultService()
public boolean hasDefaultService()
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
optional string default_service = 370242231;
| Type | Description |
| 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 target gRPC proxy.
optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the description field is set.
|
public boolean hasHeaderAction()
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 Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;
| Type | Description |
| boolean | Whether the headerAction field is set.
|
hasName()
The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
| Type | Description |
| boolean | Whether the name field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PathMatcher.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PathMatcher.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PathMatcher.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
