- 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 interface PathMatcherOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDefaultRouteAction()
public abstract 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 Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
| Returns | |
|---|---|
| Type | Description |
HttpRouteAction | The defaultRouteAction. |
getDefaultRouteActionOrBuilder()
public abstract 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 Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
| Returns | |
|---|---|
| Type | Description |
HttpRouteActionOrBuilder | |
getDefaultService()
public abstract 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 | |
|---|---|
| Type | Description |
String | The defaultService. |
getDefaultServiceBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for defaultService. |
getDefaultUrlRedirect()
public abstract 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 | |
|---|---|
| Type | Description |
HttpRedirectAction | The defaultUrlRedirect. |
getDefaultUrlRedirectOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
HttpRedirectActionOrBuilder | |
getDescription()
public abstract String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
getHeaderAction()
public abstract 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 | |
|---|---|
| Type | Description |
HttpHeaderAction | The headerAction. |
getHeaderActionOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
HttpHeaderActionOrBuilder | |
getName()
public abstract String getName()The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getPathRules(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
PathRule | |
getPathRulesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int | |
getPathRulesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<PathRule> | |
getPathRulesOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
PathRuleOrBuilder | |
getPathRulesOrBuilderList()
public abstract 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 | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.PathRuleOrBuilder> | |
getRouteRules(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpRouteRule | |
getRouteRulesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int | |
getRouteRulesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<HttpRouteRule> | |
getRouteRulesOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpRouteRuleOrBuilder | |
getRouteRulesOrBuilderList()
public abstract 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 | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.HttpRouteRuleOrBuilder> | |
hasDefaultRouteAction()
public abstract 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 Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the defaultRouteAction field is set. |
hasDefaultService()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the defaultService field is set. |
hasDefaultUrlRedirect()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the defaultUrlRedirect field is set. |
hasDescription()
public abstract boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the description field is set. |
hasHeaderAction()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the headerAction field is set. |
hasName()
public abstract boolean hasName()The name to which this PathMatcher is referred by the HostRule.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the name field is set. |