- 1.65.0 (latest)
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class PathMatcher.Builder extends GeneratedMessageV3.Builder<PathMatcher.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PathMatcher.BuilderImplements
PathMatcherOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllPathRules(Iterable<? extends PathRule> values)
public PathMatcher.Builder addAllPathRules(Iterable<? extends PathRule> values)
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;
Name | Description |
values | Iterable<? extends com.google.cloud.compute.v1.PathRule> |
Type | Description |
PathMatcher.Builder |
addAllRouteRules(Iterable<? extends HttpRouteRule> values)
public PathMatcher.Builder addAllRouteRules(Iterable<? extends HttpRouteRule> values)
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;
Name | Description |
values | Iterable<? extends com.google.cloud.compute.v1.HttpRouteRule> |
Type | Description |
PathMatcher.Builder |
addPathRules(PathRule value)
public PathMatcher.Builder addPathRules(PathRule value)
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;
Name | Description |
value | PathRule |
Type | Description |
PathMatcher.Builder |
addPathRules(PathRule.Builder builderForValue)
public PathMatcher.Builder addPathRules(PathRule.Builder builderForValue)
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;
Name | Description |
builderForValue | PathRule.Builder |
Type | Description |
PathMatcher.Builder |
addPathRules(int index, PathRule value)
public PathMatcher.Builder addPathRules(int index, PathRule value)
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;
Name | Description |
index | int |
value | PathRule |
Type | Description |
PathMatcher.Builder |
addPathRules(int index, PathRule.Builder builderForValue)
public PathMatcher.Builder addPathRules(int index, PathRule.Builder builderForValue)
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;
Name | Description |
index | int |
builderForValue | PathRule.Builder |
Type | Description |
PathMatcher.Builder |
addPathRulesBuilder()
public PathRule.Builder addPathRulesBuilder()
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 |
PathRule.Builder |
addPathRulesBuilder(int index)
public PathRule.Builder addPathRulesBuilder(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;
Name | Description |
index | int |
Type | Description |
PathRule.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PathMatcher.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
PathMatcher.Builder |
addRouteRules(HttpRouteRule value)
public PathMatcher.Builder addRouteRules(HttpRouteRule value)
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;
Name | Description |
value | HttpRouteRule |
Type | Description |
PathMatcher.Builder |
addRouteRules(HttpRouteRule.Builder builderForValue)
public PathMatcher.Builder addRouteRules(HttpRouteRule.Builder builderForValue)
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;
Name | Description |
builderForValue | HttpRouteRule.Builder |
Type | Description |
PathMatcher.Builder |
addRouteRules(int index, HttpRouteRule value)
public PathMatcher.Builder addRouteRules(int index, HttpRouteRule value)
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;
Name | Description |
index | int |
value | HttpRouteRule |
Type | Description |
PathMatcher.Builder |
addRouteRules(int index, HttpRouteRule.Builder builderForValue)
public PathMatcher.Builder addRouteRules(int index, HttpRouteRule.Builder builderForValue)
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;
Name | Description |
index | int |
builderForValue | HttpRouteRule.Builder |
Type | Description |
PathMatcher.Builder |
addRouteRulesBuilder()
public HttpRouteRule.Builder addRouteRulesBuilder()
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 |
HttpRouteRule.Builder |
addRouteRulesBuilder(int index)
public HttpRouteRule.Builder addRouteRulesBuilder(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;
Name | Description |
index | int |
Type | Description |
HttpRouteRule.Builder |
build()
public PathMatcher build()
Type | Description |
PathMatcher |
buildPartial()
public PathMatcher buildPartial()
Type | Description |
PathMatcher |
clear()
public PathMatcher.Builder clear()
Type | Description |
PathMatcher.Builder |
clearDefaultRouteAction()
public PathMatcher.Builder clearDefaultRouteAction()
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Type | Description |
PathMatcher.Builder |
clearDefaultService()
public PathMatcher.Builder clearDefaultService()
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;
Type | Description |
PathMatcher.Builder | This builder for chaining. |
clearDefaultUrlRedirect()
public PathMatcher.Builder clearDefaultUrlRedirect()
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;
Type | Description |
PathMatcher.Builder |
clearDescription()
public PathMatcher.Builder clearDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Type | Description |
PathMatcher.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PathMatcher.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
PathMatcher.Builder |
clearHeaderAction()
public PathMatcher.Builder clearHeaderAction()
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;
Type | Description |
PathMatcher.Builder |
clearName()
public PathMatcher.Builder clearName()
The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
Type | Description |
PathMatcher.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PathMatcher.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
PathMatcher.Builder |
clearPathRules()
public PathMatcher.Builder clearPathRules()
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 |
PathMatcher.Builder |
clearRouteRules()
public PathMatcher.Builder clearRouteRules()
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 |
PathMatcher.Builder |
clone()
public PathMatcher.Builder clone()
Type | Description |
PathMatcher.Builder |
getDefaultInstanceForType()
public PathMatcher getDefaultInstanceForType()
Type | Description |
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Type | Description |
HttpRouteAction | The defaultRouteAction. |
getDefaultRouteActionBuilder()
public HttpRouteAction.Builder getDefaultRouteActionBuilder()
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Type | Description |
HttpRouteAction.Builder |
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Type | Description |
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;
Type | Description |
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;
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 a target gRPC proxy.
optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;
Type | Description |
HttpRedirectAction | The defaultUrlRedirect. |
getDefaultUrlRedirectBuilder()
public HttpRedirectAction.Builder getDefaultUrlRedirectBuilder()
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;
Type | Description |
HttpRedirectAction.Builder |
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;
Type | Description |
HttpRedirectActionOrBuilder |
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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;
Type | Description |
HttpHeaderAction | The headerAction. |
getHeaderActionBuilder()
public HttpHeaderAction.Builder getHeaderActionBuilder()
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;
Type | Description |
HttpHeaderAction.Builder |
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;
Type | Description |
HttpHeaderActionOrBuilder |
getName()
public String 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;
Type | Description |
ByteString | The bytes for name. |
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;
Name | Description |
index | int |
Type | Description |
PathRule |
getPathRulesBuilder(int index)
public PathRule.Builder getPathRulesBuilder(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;
Name | Description |
index | int |
Type | Description |
PathRule.Builder |
getPathRulesBuilderList()
public List<PathRule.Builder> getPathRulesBuilderList()
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<Builder> |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
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;
Name | Description |
index | int |
Type | Description |
HttpRouteRule |
getRouteRulesBuilder(int index)
public HttpRouteRule.Builder getRouteRulesBuilder(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;
Name | Description |
index | int |
Type | Description |
HttpRouteRule.Builder |
getRouteRulesBuilderList()
public List<HttpRouteRule.Builder> getRouteRulesBuilderList()
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<Builder> |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
List<? extends com.google.cloud.compute.v1.HttpRouteRuleOrBuilder> |
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher'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 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;
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 a 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. |
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;
Type | Description |
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;
Type | Description |
boolean | Whether the name field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeDefaultRouteAction(HttpRouteAction value)
public PathMatcher.Builder mergeDefaultRouteAction(HttpRouteAction value)
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Name | Description |
value | HttpRouteAction |
Type | Description |
PathMatcher.Builder |
mergeDefaultUrlRedirect(HttpRedirectAction value)
public PathMatcher.Builder mergeDefaultUrlRedirect(HttpRedirectAction value)
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;
Name | Description |
value | HttpRedirectAction |
Type | Description |
PathMatcher.Builder |
mergeFrom(PathMatcher other)
public PathMatcher.Builder mergeFrom(PathMatcher other)
Name | Description |
other | PathMatcher |
Type | Description |
PathMatcher.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PathMatcher.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PathMatcher.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public PathMatcher.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
PathMatcher.Builder |
mergeHeaderAction(HttpHeaderAction value)
public PathMatcher.Builder mergeHeaderAction(HttpHeaderAction value)
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;
Name | Description |
value | HttpHeaderAction |
Type | Description |
PathMatcher.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PathMatcher.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
PathMatcher.Builder |
removePathRules(int index)
public PathMatcher.Builder removePathRules(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;
Name | Description |
index | int |
Type | Description |
PathMatcher.Builder |
removeRouteRules(int index)
public PathMatcher.Builder removeRouteRules(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;
Name | Description |
index | int |
Type | Description |
PathMatcher.Builder |
setDefaultRouteAction(HttpRouteAction value)
public PathMatcher.Builder setDefaultRouteAction(HttpRouteAction value)
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Name | Description |
value | HttpRouteAction |
Type | Description |
PathMatcher.Builder |
setDefaultRouteAction(HttpRouteAction.Builder builderForValue)
public PathMatcher.Builder setDefaultRouteAction(HttpRouteAction.Builder builderForValue)
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. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
Name | Description |
builderForValue | HttpRouteAction.Builder |
Type | Description |
PathMatcher.Builder |
setDefaultService(String value)
public PathMatcher.Builder setDefaultService(String value)
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;
Name | Description |
value | String The defaultService to set. |
Type | Description |
PathMatcher.Builder | This builder for chaining. |
setDefaultServiceBytes(ByteString value)
public PathMatcher.Builder setDefaultServiceBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for defaultService to set. |
Type | Description |
PathMatcher.Builder | This builder for chaining. |
setDefaultUrlRedirect(HttpRedirectAction value)
public PathMatcher.Builder setDefaultUrlRedirect(HttpRedirectAction value)
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;
Name | Description |
value | HttpRedirectAction |
Type | Description |
PathMatcher.Builder |
setDefaultUrlRedirect(HttpRedirectAction.Builder builderForValue)
public PathMatcher.Builder setDefaultUrlRedirect(HttpRedirectAction.Builder builderForValue)
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;
Name | Description |
builderForValue | HttpRedirectAction.Builder |
Type | Description |
PathMatcher.Builder |
setDescription(String value)
public PathMatcher.Builder setDescription(String value)
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Name | Description |
value | String The description to set. |
Type | Description |
PathMatcher.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public PathMatcher.Builder setDescriptionBytes(ByteString value)
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Name | Description |
value | ByteString The bytes for description to set. |
Type | Description |
PathMatcher.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PathMatcher.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
PathMatcher.Builder |
setHeaderAction(HttpHeaderAction value)
public PathMatcher.Builder setHeaderAction(HttpHeaderAction value)
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;
Name | Description |
value | HttpHeaderAction |
Type | Description |
PathMatcher.Builder |
setHeaderAction(HttpHeaderAction.Builder builderForValue)
public PathMatcher.Builder setHeaderAction(HttpHeaderAction.Builder builderForValue)
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;
Name | Description |
builderForValue | HttpHeaderAction.Builder |
Type | Description |
PathMatcher.Builder |
setName(String value)
public PathMatcher.Builder setName(String value)
The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
Name | Description |
value | String The name to set. |
Type | Description |
PathMatcher.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public PathMatcher.Builder setNameBytes(ByteString value)
The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
Name | Description |
value | ByteString The bytes for name to set. |
Type | Description |
PathMatcher.Builder | This builder for chaining. |
setPathRules(int index, PathRule value)
public PathMatcher.Builder setPathRules(int index, PathRule value)
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;
Name | Description |
index | int |
value | PathRule |
Type | Description |
PathMatcher.Builder |
setPathRules(int index, PathRule.Builder builderForValue)
public PathMatcher.Builder setPathRules(int index, PathRule.Builder builderForValue)
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;
Name | Description |
index | int |
builderForValue | PathRule.Builder |
Type | Description |
PathMatcher.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PathMatcher.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
PathMatcher.Builder |
setRouteRules(int index, HttpRouteRule value)
public PathMatcher.Builder setRouteRules(int index, HttpRouteRule value)
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;
Name | Description |
index | int |
value | HttpRouteRule |
Type | Description |
PathMatcher.Builder |
setRouteRules(int index, HttpRouteRule.Builder builderForValue)
public PathMatcher.Builder setRouteRules(int index, HttpRouteRule.Builder builderForValue)
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;
Name | Description |
index | int |
builderForValue | HttpRouteRule.Builder |
Type | Description |
PathMatcher.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PathMatcher.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
PathMatcher.Builder |