Package com.google.cloud.compute.v1

Class HttpRouteRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.HttpRouteRule
All Implemented Interfaces:
HttpRouteRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class HttpRouteRule extends com.google.protobuf.GeneratedMessage implements HttpRouteRuleOrBuilder
 The HttpRouteRule setting specifies how to match an HTTP request
 and the corresponding routing action that load balancing proxies perform.
Protobuf type google.cloud.compute.v1.HttpRouteRule
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HttpRouteRule.Builder
    The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    HEADER_ACTION_FIELD_NUMBER
     
    static final int
    MATCH_RULES_FIELD_NUMBER
     
    static final int
    PRIORITY_FIELD_NUMBER
     
    static final int
    ROUTE_ACTION_FIELD_NUMBER
     
    static final int
    SERVICE_FIELD_NUMBER
     
    static final int
    URL_REDIRECT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    CustomErrorResponsePolicy
    getCustomErrorResponsePolicy()
    customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
    CustomErrorResponsePolicyOrBuilder
    getCustomErrorResponsePolicyOrBuilder()
    customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
    static HttpRouteRule
    getDefaultInstance()
     
    HttpRouteRule
    getDefaultInstanceForType()
     
    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.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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 thisrouteRule.
    int
    getMatchRulesCount()
    The list of criteria for matching attributes of a request to thisrouteRule.
    List<HttpRouteRuleMatch>
    getMatchRulesList()
    The list of criteria for matching attributes of a request to thisrouteRule.
    HttpRouteRuleMatchOrBuilder
    getMatchRulesOrBuilder(int index)
    The list of criteria for matching attributes of a request to thisrouteRule.
    List<? extends HttpRouteRuleMatchOrBuilder>
    getMatchRulesOrBuilderList()
    The list of criteria for matching attributes of a request to thisrouteRule.
    com.google.protobuf.Parser<HttpRouteRule>
    getParserForType()
     
    int
    getPriority()
    For routeRules within a given pathMatcher, priority determines the order in which a load balancer interpretsrouteRules.
    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.
    int
    getSerializedSize()
     
    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
    hasCustomErrorResponsePolicy()
    customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
    boolean
    hasDescription()
    The short description conveying the intent of this routeRule.
    int
    hashCode()
     
    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 interpretsrouteRules.
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static HttpRouteRule.Builder
    newBuilder()
     
    static HttpRouteRule.Builder
    newBuilder(HttpRouteRule prototype)
     
    HttpRouteRule.Builder
    newBuilderForType()
     
    protected HttpRouteRule.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static HttpRouteRule
    parseDelimitedFrom(InputStream input)
     
    static HttpRouteRule
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRouteRule
    parseFrom(byte[] data)
     
    static HttpRouteRule
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRouteRule
    parseFrom(com.google.protobuf.ByteString data)
     
    static HttpRouteRule
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRouteRule
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static HttpRouteRule
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRouteRule
    parseFrom(InputStream input)
     
    static HttpRouteRule
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRouteRule
    parseFrom(ByteBuffer data)
     
    static HttpRouteRule
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<HttpRouteRule>
    parser()
     
    HttpRouteRule.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER

      public static final int CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • HEADER_ACTION_FIELD_NUMBER

      public static final int HEADER_ACTION_FIELD_NUMBER
      See Also:

    • MATCH_RULES_FIELD_NUMBER

      public static final int MATCH_RULES_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

    • ROUTE_ACTION_FIELD_NUMBER

      public static final int ROUTE_ACTION_FIELD_NUMBER
      See Also:

    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:

    • URL_REDIRECT_FIELD_NUMBER

      public static final int URL_REDIRECT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasCustomErrorResponsePolicy

      public boolean hasCustomErrorResponsePolicy()
       customErrorResponsePolicy specifies how the Load
 Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

 If a policy for an
 error code is not configured for the RouteRule, a policy for
 the error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If
 one is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy
 configured in UrlMap.defaultCustomErrorResponsePolicy takes
 effect.

 For example, consider a UrlMap with the following configuration:


 - UrlMap.defaultCustomErrorResponsePolicy are 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 a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy
 takes effect. If however, the request forwww.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 atUrlMap.defaultCustomErrorResponsePolicy takes effect.

 When
 used in conjunction withrouteRules.routeAction.retryPolicy, retries take
 precedence. Only once all retries are exhausted, thecustomErrorResponsePolicy is applied. While attempting
 a retry, if load balancer is successful in reaching the
 service, the customErrorResponsePolicy is ignored and
 the response from the service is returned to the client.

 customErrorResponsePolicy is supported only for
 global external Application Load Balancers.
      optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619;
      Specified by:
      hasCustomErrorResponsePolicy in interface HttpRouteRuleOrBuilder
      Returns:
      Whether the customErrorResponsePolicy field is set.

    • getCustomErrorResponsePolicy

      public CustomErrorResponsePolicy getCustomErrorResponsePolicy()
       customErrorResponsePolicy specifies how the Load
 Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

 If a policy for an
 error code is not configured for the RouteRule, a policy for
 the error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If
 one is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy
 configured in UrlMap.defaultCustomErrorResponsePolicy takes
 effect.

 For example, consider a UrlMap with the following configuration:


 - UrlMap.defaultCustomErrorResponsePolicy are 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 a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy
 takes effect. If however, the request forwww.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 atUrlMap.defaultCustomErrorResponsePolicy takes effect.

 When
 used in conjunction withrouteRules.routeAction.retryPolicy, retries take
 precedence. Only once all retries are exhausted, thecustomErrorResponsePolicy is applied. While attempting
 a retry, if load balancer is successful in reaching the
 service, the customErrorResponsePolicy is ignored and
 the response from the service is returned to the client.

 customErrorResponsePolicy is supported only for
 global external Application Load Balancers.
      optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619;
      Specified by:
      getCustomErrorResponsePolicy in interface HttpRouteRuleOrBuilder
      Returns:
      The customErrorResponsePolicy.

    • getCustomErrorResponsePolicyOrBuilder

      public CustomErrorResponsePolicyOrBuilder getCustomErrorResponsePolicyOrBuilder()
       customErrorResponsePolicy specifies how the Load
 Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

 If a policy for an
 error code is not configured for the RouteRule, a policy for
 the error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If
 one is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy
 configured in UrlMap.defaultCustomErrorResponsePolicy takes
 effect.

 For example, consider a UrlMap with the following configuration:


 - UrlMap.defaultCustomErrorResponsePolicy are 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 a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy
 takes effect. If however, the request forwww.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 atUrlMap.defaultCustomErrorResponsePolicy takes effect.

 When
 used in conjunction withrouteRules.routeAction.retryPolicy, retries take
 precedence. Only once all retries are exhausted, thecustomErrorResponsePolicy is applied. While attempting
 a retry, if load balancer is successful in reaching the
 service, the customErrorResponsePolicy is ignored and
 the response from the service is returned to the client.

 customErrorResponsePolicy is supported only for
 global external Application Load Balancers.
      optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619;
      Specified by:
      getCustomErrorResponsePolicyOrBuilder in interface HttpRouteRuleOrBuilder

    • hasDescription

      public 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;
      Specified by:
      hasDescription in interface HttpRouteRuleOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public 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;
      Specified by:
      getDescription in interface HttpRouteRuleOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public 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;
      Specified by:
      getDescriptionBytes in interface HttpRouteRuleOrBuilder
      Returns:
      The bytes for description.

    • hasHeaderAction

      public 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 afterpathMatchers[].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;
      Specified by:
      hasHeaderAction in interface HttpRouteRuleOrBuilder
      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 backendService.

 The headerAction value specified here is applied before the
 matching pathMatchers[].headerAction and afterpathMatchers[].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;
      Specified by:
      getHeaderAction in interface HttpRouteRuleOrBuilder
      Returns:
      The headerAction.

    • getHeaderActionOrBuilder

      public 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 afterpathMatchers[].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;
      Specified by:
      getHeaderActionOrBuilder in interface HttpRouteRuleOrBuilder

    • getMatchRulesList

      public List<HttpRouteRuleMatch> getMatchRulesList()
       The list of criteria for matching attributes of a request to thisrouteRule. This list has OR semantics: the request matches
 this routeRule when any of thematchRules 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;
      Specified by:
      getMatchRulesList in interface HttpRouteRuleOrBuilder

    • getMatchRulesOrBuilderList

      public List<? extends HttpRouteRuleMatchOrBuilder> getMatchRulesOrBuilderList()
       The list of criteria for matching attributes of a request to thisrouteRule. This list has OR semantics: the request matches
 this routeRule when any of thematchRules 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;
      Specified by:
      getMatchRulesOrBuilderList in interface HttpRouteRuleOrBuilder

    • getMatchRulesCount

      public int getMatchRulesCount()
       The list of criteria for matching attributes of a request to thisrouteRule. This list has OR semantics: the request matches
 this routeRule when any of thematchRules 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;
      Specified by:
      getMatchRulesCount in interface HttpRouteRuleOrBuilder

    • getMatchRules

      public HttpRouteRuleMatch getMatchRules(int index)
       The list of criteria for matching attributes of a request to thisrouteRule. This list has OR semantics: the request matches
 this routeRule when any of thematchRules 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;
      Specified by:
      getMatchRules in interface HttpRouteRuleOrBuilder

    • getMatchRulesOrBuilder

      public HttpRouteRuleMatchOrBuilder getMatchRulesOrBuilder(int index)
       The list of criteria for matching attributes of a request to thisrouteRule. This list has OR semantics: the request matches
 this routeRule when any of thematchRules 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;
      Specified by:
      getMatchRulesOrBuilder in interface HttpRouteRuleOrBuilder

    • hasPriority

      public boolean hasPriority()
       For routeRules within a given pathMatcher,
 priority determines the order in which a load balancer interpretsrouteRules. 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;
      Specified by:
      hasPriority in interface HttpRouteRuleOrBuilder
      Returns:
      Whether the priority field is set.

    • getPriority

      public int getPriority()
       For routeRules within a given pathMatcher,
 priority determines the order in which a load balancer interpretsrouteRules. 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;
      Specified by:
      getPriority in interface HttpRouteRuleOrBuilder
      Returns:
      The priority.

    • hasRouteAction

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


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.


 URL maps for classic Application Load Balancers only support
 the urlRewrite action within a route rule'srouteAction.
      optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
      Specified by:
      hasRouteAction in interface HttpRouteRuleOrBuilder
      Returns:
      Whether the routeAction field is set.

    • getRouteAction

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


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.


 URL maps for classic Application Load Balancers only support
 the urlRewrite action within a route rule'srouteAction.
      optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
      Specified by:
      getRouteAction in interface HttpRouteRuleOrBuilder
      Returns:
      The routeAction.

    • getRouteActionOrBuilder

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


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.


 URL maps for classic Application Load Balancers only support
 the urlRewrite action within a route rule'srouteAction.
      optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
      Specified by:
      getRouteActionOrBuilder in interface HttpRouteRuleOrBuilder

    • hasService

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


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
      optional string service = 373540533;
      Specified by:
      hasService in interface HttpRouteRuleOrBuilder
      Returns:
      Whether the service field is set.

    • getService

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


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
      optional string service = 373540533;
      Specified by:
      getService in interface HttpRouteRuleOrBuilder
      Returns:
      The service.

    • getServiceBytes

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


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
      optional string service = 373540533;
      Specified by:
      getServiceBytes in interface HttpRouteRuleOrBuilder
      Returns:
      The bytes for service.

    • hasUrlRedirect

      public boolean hasUrlRedirect()
       When this rule is matched, the request is redirected to a URL
 specified by urlRedirect.


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.


 Not supported when the URL map is bound to a target gRPC proxy.
      optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
      Specified by:
      hasUrlRedirect in interface HttpRouteRuleOrBuilder
      Returns:
      Whether the urlRedirect field is set.

    • getUrlRedirect

      public HttpRedirectAction getUrlRedirect()
       When this rule is matched, the request is redirected to a URL
 specified by urlRedirect.


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.


 Not supported when the URL map is bound to a target gRPC proxy.
      optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
      Specified by:
      getUrlRedirect in interface HttpRouteRuleOrBuilder
      Returns:
      The urlRedirect.

    • getUrlRedirectOrBuilder

      public HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()
       When this rule is matched, the request is redirected to a URL
 specified by urlRedirect.


 Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.


 Not supported when the URL map is bound to a target gRPC proxy.
      optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
      Specified by:
      getUrlRedirectOrBuilder in interface HttpRouteRuleOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 HttpRouteRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static HttpRouteRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static HttpRouteRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpRouteRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HttpRouteRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HttpRouteRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpRouteRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpRouteRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static HttpRouteRule.Builder newBuilder()

    • newBuilder

      public static HttpRouteRule.Builder newBuilder(HttpRouteRule prototype)

    • toBuilder

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

    • newBuilderForType

      protected HttpRouteRule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static HttpRouteRule getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HttpRouteRule> parser()

    • getParserForType

      public com.google.protobuf.Parser<HttpRouteRule> 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.GeneratedMessage

    • getDefaultInstanceForType

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