Package com.google.cloud.compute.v1

Interface HttpRouteRuleOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDescription()
      The short description conveying the intent of this routeRule.
      com.google.protobuf.ByteString getDescriptionBytes()
      The short description conveying the intent of this routeRule.
      HttpHeaderAction getHeaderAction()
      Specifies changes to request and response headers that need to take effect for the selected backendService.
      HttpHeaderActionOrBuilder getHeaderActionOrBuilder()
      Specifies changes to request and response headers that need to take effect for the selected backendService.
      HttpRouteRuleMatch getMatchRules​(int index)
      The list of criteria for matching attributes of a request to this routeRule.
      int getMatchRulesCount()
      The list of criteria for matching attributes of a request to this routeRule.
      List<HttpRouteRuleMatch> getMatchRulesList()
      The list of criteria for matching attributes of a request to this routeRule.
      HttpRouteRuleMatchOrBuilder getMatchRulesOrBuilder​(int index)
      The list of criteria for matching attributes of a request to this routeRule.
      List<? extends HttpRouteRuleMatchOrBuilder> getMatchRulesOrBuilderList()
      The list of criteria for matching attributes of a request to this routeRule.
      int getPriority()
      For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules.
      HttpRouteAction getRouteAction()
      In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.
      HttpRouteActionOrBuilder getRouteActionOrBuilder()
      In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.
      String getService()
      The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
      com.google.protobuf.ByteString getServiceBytes()
      The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
      HttpRedirectAction getUrlRedirect()
      When this rule is matched, the request is redirected to a URL specified by urlRedirect.
      HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()
      When this rule is matched, the request is redirected to a URL specified by urlRedirect.
      boolean hasDescription()
      The short description conveying the intent of this routeRule.
      boolean hasHeaderAction()
      Specifies changes to request and response headers that need to take effect for the selected backendService.
      boolean hasPriority()
      For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules.
      boolean hasRouteAction()
      In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.
      boolean hasService()
      The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
      boolean hasUrlRedirect()
      When this rule is matched, the request is redirected to a URL specified by urlRedirect.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasDescription

        boolean hasDescription()
         The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.
        optional string description = 422937596;
        Returns:
        Whether the description field is set.

      • getDescription

        String getDescription()
         The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.
        optional string description = 422937596;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.
        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 backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 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 backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 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 backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 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;

      • getMatchRulesList

        List<HttpRouteRuleMatch> getMatchRulesList()
         The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
        repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

      • getMatchRules

        HttpRouteRuleMatch getMatchRules​(int index)
         The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
        repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

      • getMatchRulesCount

        int getMatchRulesCount()
         The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
        repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

      • getMatchRulesOrBuilderList

        List<? extends HttpRouteRuleMatchOrBuilder> getMatchRulesOrBuilderList()
         The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
        repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

      • getMatchRulesOrBuilder

        HttpRouteRuleMatchOrBuilder getMatchRulesOrBuilder​(int index)
         The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.
        repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

      • hasPriority

        boolean hasPriority()
         For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.
        optional int32 priority = 445151652;
        Returns:
        Whether the priority field is set.

      • getPriority

        int getPriority()
         For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.
        optional int32 priority = 445151652;
        Returns:
        The priority.

      • hasRouteAction

        boolean hasRouteAction()
         In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.
        optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
        Returns:
        Whether the routeAction field is set.

      • getRouteAction

        HttpRouteAction getRouteAction()
         In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.
        optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
        Returns:
        The routeAction.

      • getRouteActionOrBuilder

        HttpRouteActionOrBuilder getRouteActionOrBuilder()
         In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.
        optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

      • hasService

        boolean hasService()
         The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
        optional string service = 373540533;
        Returns:
        Whether the service field is set.

      • getService

        String getService()
         The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
        optional string service = 373540533;
        Returns:
        The service.

      • getServiceBytes

        com.google.protobuf.ByteString getServiceBytes()
         The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
        optional string service = 373540533;
        Returns:
        The bytes for service.

      • hasUrlRedirect

        boolean hasUrlRedirect()
         When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.
        optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
        Returns:
        Whether the urlRedirect field is set.

      • getUrlRedirect

        HttpRedirectAction getUrlRedirect()
         When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.
        optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
        Returns:
        The urlRedirect.

      • getUrlRedirectOrBuilder

        HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()
         When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.
        optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;