Class PathMatcher

  • All Implemented Interfaces:
    PathMatcherOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class PathMatcher
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Field Detail

      • DEFAULT_ROUTE_ACTION_FIELD_NUMBER

        public static final int DEFAULT_ROUTE_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DEFAULT_SERVICE_FIELD_NUMBER

        public static final int DEFAULT_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DEFAULT_URL_REDIRECT_FIELD_NUMBER

        public static final int DEFAULT_URL_REDIRECT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • HEADER_ACTION_FIELD_NUMBER

        public static final int HEADER_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PATH_RULES_FIELD_NUMBER

        public static final int PATH_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ROUTE_RULES_FIELD_NUMBER

        public static final int ROUTE_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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 external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
         
        optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
        Specified by:
        hasDefaultRouteAction in interface PathMatcherOrBuilder
        Returns:
        Whether the defaultRouteAction field is set.
      • 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 external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
         
        optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
        Specified by:
        getDefaultRouteAction in interface PathMatcherOrBuilder
        Returns:
        The defaultRouteAction.
      • 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 external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.
         
        optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;
        Specified by:
        getDefaultRouteActionOrBuilder in interface PathMatcherOrBuilder
      • 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;
        Specified by:
        hasDefaultService in interface PathMatcherOrBuilder
        Returns:
        Whether the defaultService field is set.
      • 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;
        Specified by:
        getDefaultService in interface PathMatcherOrBuilder
        Returns:
        The defaultService.
      • getDefaultServiceBytes

        public com.google.protobuf.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;
        Specified by:
        getDefaultServiceBytes in interface PathMatcherOrBuilder
        Returns:
        The bytes for defaultService.
      • 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;
        Specified by:
        hasDefaultUrlRedirect in interface PathMatcherOrBuilder
        Returns:
        Whether the defaultUrlRedirect field is set.
      • 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;
        Specified by:
        getDefaultUrlRedirect in interface PathMatcherOrBuilder
        Returns:
        The defaultUrlRedirect.
      • 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;
        Specified by:
        getDefaultUrlRedirectOrBuilder in interface PathMatcherOrBuilder
      • hasDescription

        public boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        hasDescription in interface PathMatcherOrBuilder
        Returns:
        Whether the description field is set.
      • getDescription

        public String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescription in interface PathMatcherOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface PathMatcherOrBuilder
        Returns:
        The bytes for description.
      • 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;
        Specified by:
        hasHeaderAction in interface PathMatcherOrBuilder
        Returns:
        Whether the headerAction field is set.
      • 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;
        Specified by:
        getHeaderAction in interface PathMatcherOrBuilder
        Returns:
        The headerAction.
      • 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;
        Specified by:
        getHeaderActionOrBuilder in interface PathMatcherOrBuilder
      • hasName

        public boolean hasName()
         The name to which this PathMatcher is referred by the HostRule.
         
        optional string name = 3373707;
        Specified by:
        hasName in interface PathMatcherOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public String getName()
         The name to which this PathMatcher is referred by the HostRule.
         
        optional string name = 3373707;
        Specified by:
        getName in interface PathMatcherOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name to which this PathMatcher is referred by the HostRule.
         
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface PathMatcherOrBuilder
        Returns:
        The bytes for name.
      • 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;
        Specified by:
        getPathRulesList in interface PathMatcherOrBuilder
      • 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;
        Specified by:
        getPathRulesOrBuilderList in interface PathMatcherOrBuilder
      • 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;
        Specified by:
        getPathRulesCount in interface PathMatcherOrBuilder
      • getPathRules

        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;
        Specified by:
        getPathRules in interface PathMatcherOrBuilder
      • getPathRulesOrBuilder

        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;
        Specified by:
        getPathRulesOrBuilder in interface PathMatcherOrBuilder
      • 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;
        Specified by:
        getRouteRulesList in interface PathMatcherOrBuilder
      • 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;
        Specified by:
        getRouteRulesOrBuilderList in interface PathMatcherOrBuilder
      • 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;
        Specified by:
        getRouteRulesCount in interface PathMatcherOrBuilder
      • getRouteRules

        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;
        Specified by:
        getRouteRules in interface PathMatcherOrBuilder
      • getRouteRulesOrBuilder

        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;
        Specified by:
        getRouteRulesOrBuilder in interface PathMatcherOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static PathMatcher parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PathMatcher parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PathMatcher parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PathMatcher parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PathMatcher parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PathMatcher parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PathMatcher parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException
      • newBuilderForType

        public PathMatcher.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public PathMatcher.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected PathMatcher.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static PathMatcher getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<PathMatcher> parser()
      • getParserForType

        public com.google.protobuf.Parser<PathMatcher> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public PathMatcher getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder