Class PathMatcher (1.64.0)

public final class PathMatcher extends GeneratedMessageV3 implements PathMatcherOrBuilder

A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.

Protobuf type google.cloud.compute.v1.PathMatcher

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PathMatcher

Implements

PathMatcherOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DEFAULT_CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER

public static final int DEFAULT_CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER

Field Value
Type	Description
`int`

DEFAULT_ROUTE_ACTION_FIELD_NUMBER

public static final int DEFAULT_ROUTE_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DEFAULT_SERVICE_FIELD_NUMBER

public static final int DEFAULT_SERVICE_FIELD_NUMBER

Field Value
Type	Description
`int`

DEFAULT_URL_REDIRECT_FIELD_NUMBER

public static final int DEFAULT_URL_REDIRECT_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

HEADER_ACTION_FIELD_NUMBER

public static final int HEADER_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PATH_RULES_FIELD_NUMBER

public static final int PATH_RULES_FIELD_NUMBER

Field Value
Type	Description
`int`

ROUTE_RULES_FIELD_NUMBER

public static final int ROUTE_RULES_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static PathMatcher getDefaultInstance()

Returns
Type	Description
`PathMatcher`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PathMatcher.Builder newBuilder()

Returns
Type	Description
`PathMatcher.Builder`

newBuilder(PathMatcher prototype)

public static PathMatcher.Builder newBuilder(PathMatcher prototype)

Parameter
Name	Description
`prototype`	`PathMatcher`

Returns
Type	Description
`PathMatcher.Builder`

parseDelimitedFrom(InputStream input)

public static PathMatcher parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PathMatcher parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PathMatcher parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PathMatcher parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PathMatcher parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PathMatcher parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PathMatcher parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PathMatcher`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PathMatcher> parser()

Returns
Type	Description
`Parser<PathMatcher>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultCustomErrorResponsePolicy()

public CustomErrorResponsePolicy getDefaultCustomErrorResponsePolicy()

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type	Description
`CustomErrorResponsePolicy`	The defaultCustomErrorResponsePolicy.

getDefaultCustomErrorResponsePolicyOrBuilder()

public CustomErrorResponsePolicyOrBuilder getDefaultCustomErrorResponsePolicyOrBuilder()

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type	Description
`CustomErrorResponsePolicyOrBuilder`

getDefaultInstanceForType()

public PathMatcher getDefaultInstanceForType()

Returns
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. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. 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 HttpRouteActionOrBuilder getDefaultRouteActionOrBuilder()

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

Returns
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. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. 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 ByteString getDefaultServiceBytes()

optional string default_service = 370242231;

Returns
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, then set either defaultService or defaultRouteAction. Don't set both. 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 HttpRedirectActionOrBuilder getDefaultUrlRedirectOrBuilder()

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

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

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

Returns
Type	Description
`ByteString`	The bytes for description.

getHeaderAction()

public HttpHeaderAction getHeaderAction()

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

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

Returns
Type	Description
`HttpHeaderAction`	The headerAction.

getHeaderActionOrBuilder()

public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()

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

Returns
Type	Description
`HttpHeaderActionOrBuilder`

getName()

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

getParserForType()

public Parser<PathMatcher> getParserForType()

Returns
Type	Description
`Parser<PathMatcher>`

Overrides

GeneratedMessageV3.getParserForType()

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
Name	Description
`index`	`int`

Returns
Type	Description
`PathRule`

getPathRulesCount()

public int getPathRulesCount()

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

Returns
Type	Description
`int`

getPathRulesList()

public List<PathRule> getPathRulesList()

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

Returns
Type	Description
`List<PathRule>`

getPathRulesOrBuilder(int index)

public PathRuleOrBuilder getPathRulesOrBuilder(int index)

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`PathRuleOrBuilder`

getPathRulesOrBuilderList()

public List<? extends PathRuleOrBuilder> getPathRulesOrBuilderList()

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

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