Package com.google.cloud.compute.v1

Interface PathMatcherOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PathMatcher, PathMatcher.Builder
    public interface PathMatcherOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasDefaultRouteAction

        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;
        Returns:
        Whether the defaultRouteAction field is set.

      • getDefaultRouteAction

        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;
        Returns:
        The defaultRouteAction.

      • getDefaultRouteActionOrBuilder

        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;

      • hasDefaultService

        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:
        Whether the defaultService field is set.

      • getDefaultService

        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:
        The defaultService.

      • getDefaultServiceBytes

        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;
        Returns:
        The bytes for defaultService.

      • hasDefaultUrlRedirect

        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:
        Whether the defaultUrlRedirect field is set.

      • getDefaultUrlRedirect

        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:
        The defaultUrlRedirect.

      • getDefaultUrlRedirectOrBuilder

        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;

      • hasDescription

        boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        Whether the description field is set.

      • getDescription

        String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The bytes for description.

      • hasHeaderAction

        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:
        Whether the headerAction field is set.

      • getHeaderAction

        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:
        The headerAction.

      • getHeaderActionOrBuilder

        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;

      • hasName

        boolean hasName()
         The name to which this PathMatcher is referred by the HostRule.
        optional string name = 3373707;
        Returns:
        Whether the name field is set.

      • getName

        String getName()
         The name to which this PathMatcher is referred by the HostRule.
        optional string name = 3373707;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name to which this PathMatcher is referred by the HostRule.
        optional string name = 3373707;
        Returns:
        The bytes for name.

      • getPathRulesList

        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;

      • getPathRules

        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;

      • getPathRulesCount

        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;

      • getPathRulesOrBuilderList

        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;

      • getPathRulesOrBuilder

        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;

      • getRouteRulesList

        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;

      • getRouteRules

        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;

      • getRouteRulesCount

        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;

      • getRouteRulesOrBuilderList

        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;

      • getRouteRulesOrBuilder

        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;