Class PathMatcher.Builder (1.43.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.PathRule>
Returns
TypeDescription
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;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.HttpRouteRule>
Returns
TypeDescription
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;

Parameter
NameDescription
valuePathRule
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValuePathRule.Builder
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valuePathRule
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValuePathRule.Builder
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
PathRule.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PathMatcher.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Parameter
NameDescription
valueHttpRouteRule
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueHttpRouteRule.Builder
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valueHttpRouteRule
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValueHttpRouteRule.Builder
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
HttpRouteRule.Builder

build()

public PathMatcher build()
Returns
TypeDescription
PathMatcher

buildPartial()

public PathMatcher buildPartial()
Returns
TypeDescription
PathMatcher

clear()

public PathMatcher.Builder clear()
Returns
TypeDescription
PathMatcher.Builder
Overrides

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

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
PathMatcher.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PathMatcher.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Returns
TypeDescription
PathMatcher.Builder

clearName()

public PathMatcher.Builder clearName()

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

optional string name = 3373707;

Returns
TypeDescription
PathMatcher.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PathMatcher.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Returns
TypeDescription
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;

Returns
TypeDescription
PathMatcher.Builder

clone()

public PathMatcher.Builder clone()
Returns
TypeDescription
PathMatcher.Builder
Overrides

getDefaultInstanceForType()

public PathMatcher getDefaultInstanceForType()
Returns
TypeDescription
PathMatcher

getDefaultRouteAction()

public HttpRouteAction getDefaultRouteAction()

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic 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
TypeDescription
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. 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
TypeDescription
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. 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
TypeDescription
HttpRouteActionOrBuilder

getDefaultService()

public String getDefaultService()

The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

optional string default_service = 370242231;

Returns
TypeDescription
String

The defaultService.

getDefaultServiceBytes()

public ByteString getDefaultServiceBytes()

The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

optional string default_service = 370242231;

Returns
TypeDescription
ByteString

The bytes for defaultService.

getDefaultUrlRedirect()

public HttpRedirectAction getDefaultUrlRedirect()

When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

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

Returns
TypeDescription
HttpRedirectAction

The defaultUrlRedirect.

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;

Returns
TypeDescription
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;

Returns
TypeDescription
HttpRedirectActionOrBuilder

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHeaderAction()

public HttpHeaderAction getHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

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

Returns
TypeDescription
HttpHeaderAction

The headerAction.

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;

Returns
TypeDescription
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;

Returns
TypeDescription
HttpHeaderActionOrBuilder

getName()

public String getName()

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

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getPathRules(int index)

public PathRule getPathRules(int index)

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PathRule

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
int

getPathRulesList()

public List<PathRule> getPathRulesList()

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.

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

Returns
TypeDescription
List<PathRule>

getPathRulesOrBuilder(int index)

public PathRuleOrBuilder getPathRulesOrBuilder(int index)

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PathRuleOrBuilder

getPathRulesOrBuilderList()

public List<? extends PathRuleOrBuilder> getPathRulesOrBuilderList()

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.

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

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

getRouteRules(int index)

public HttpRouteRule getRouteRules(int index)

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
HttpRouteRule

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
int

getRouteRulesList()

public List<HttpRouteRule> getRouteRulesList()

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.

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

Returns
TypeDescription
List<HttpRouteRule>

getRouteRulesOrBuilder(int index)

public HttpRouteRuleOrBuilder getRouteRulesOrBuilder(int index)

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
HttpRouteRuleOrBuilder

getRouteRulesOrBuilderList()

public List<? extends HttpRouteRuleOrBuilder> getRouteRulesOrBuilderList()

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.

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

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

hasDefaultRouteAction()

public boolean hasDefaultRouteAction()

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic 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
TypeDescription
boolean

Whether the defaultRouteAction field is set.

hasDefaultService()

public boolean hasDefaultService()

The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

optional string default_service = 370242231;

Returns
TypeDescription
boolean

Whether the defaultService field is set.

hasDefaultUrlRedirect()

public boolean hasDefaultUrlRedirect()

When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

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

Returns
TypeDescription
boolean

Whether the defaultUrlRedirect field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasHeaderAction()

public boolean hasHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

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

Returns
TypeDescription
boolean

Whether the headerAction field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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

Parameter
NameDescription
valueHttpRouteAction
Returns
TypeDescription
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;

Parameter
NameDescription
valueHttpRedirectAction
Returns
TypeDescription
PathMatcher.Builder

mergeFrom(PathMatcher other)

public PathMatcher.Builder mergeFrom(PathMatcher other)
Parameter
NameDescription
otherPathMatcher
Returns
TypeDescription
PathMatcher.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PathMatcher.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathMatcher.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PathMatcher.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Parameter
NameDescription
valueHttpHeaderAction
Returns
TypeDescription
PathMatcher.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PathMatcher.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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. 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;

Parameter
NameDescription
valueHttpRouteAction
Returns
TypeDescription
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. 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;

Parameter
NameDescription
builderForValueHttpRouteAction.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The defaultService to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for defaultService to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueHttpRedirectAction
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueHttpRedirectAction.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
PathMatcher.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PathMatcher.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Parameter
NameDescription
valueHttpHeaderAction
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueHttpHeaderAction.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valuePathRule
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValuePathRule.Builder
Returns
TypeDescription
PathMatcher.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PathMatcher.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PathMatcher.Builder
Overrides

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;

Parameters
NameDescription
indexint
valueHttpRouteRule
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValueHttpRouteRule.Builder
Returns
TypeDescription
PathMatcher.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PathMatcher.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PathMatcher.Builder
Overrides