Package com.google.cloud.compute.v1

Class HttpRouteRule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<HttpRouteRule.Builder>
com.google.cloud.compute.v1.HttpRouteRule.Builder
All Implemented Interfaces:
HttpRouteRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
HttpRouteRule
public static final class HttpRouteRule.Builder extends com.google.protobuf.GeneratedMessage.Builder<HttpRouteRule.Builder> 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

  • 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.Builder<HttpRouteRule.Builder>

    • clear

      public HttpRouteRule.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<HttpRouteRule.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HttpRouteRule.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public HttpRouteRule.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpRouteRule.Builder>

    • mergeFrom

      public HttpRouteRule.Builder mergeFrom(HttpRouteRule other)

    • isInitialized

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

    • mergeFrom

      public HttpRouteRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpRouteRule.Builder>
      Throws:
      IOException

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

    • setCustomErrorResponsePolicy

      public HttpRouteRule.Builder setCustomErrorResponsePolicy(CustomErrorResponsePolicy value)
       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;

    • setCustomErrorResponsePolicy

      public HttpRouteRule.Builder setCustomErrorResponsePolicy(CustomErrorResponsePolicy.Builder builderForValue)
       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;

    • mergeCustomErrorResponsePolicy

      public HttpRouteRule.Builder mergeCustomErrorResponsePolicy(CustomErrorResponsePolicy value)
       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;

    • clearCustomErrorResponsePolicy

      public HttpRouteRule.Builder clearCustomErrorResponsePolicy()
       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;

    • getCustomErrorResponsePolicyBuilder

      public CustomErrorResponsePolicy.Builder getCustomErrorResponsePolicyBuilder()
       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;

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

    • setDescription

      public HttpRouteRule.Builder setDescription(String value)
       The short description conveying the intent of this routeRule.


 The description can have a maximum length of 1024 characters.
      optional string description = 422937596;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public HttpRouteRule.Builder clearDescription()
       The short description conveying the intent of this routeRule.


 The description can have a maximum length of 1024 characters.
      optional string description = 422937596;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public HttpRouteRule.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       The short description conveying the intent of this routeRule.


 The description can have a maximum length of 1024 characters.
      optional string description = 422937596;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

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

    • setHeaderAction

      public HttpRouteRule.Builder setHeaderAction(HttpHeaderAction value)
       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;

    • setHeaderAction

      public HttpRouteRule.Builder setHeaderAction(HttpHeaderAction.Builder builderForValue)
       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;

    • mergeHeaderAction

      public HttpRouteRule.Builder mergeHeaderAction(HttpHeaderAction value)
       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;

    • clearHeaderAction

      public HttpRouteRule.Builder clearHeaderAction()
       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;

    • getHeaderActionBuilder

      public HttpHeaderAction.Builder getHeaderActionBuilder()
       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;

    • 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

    • 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

    • setMatchRules

      public HttpRouteRule.Builder setMatchRules(int index, HttpRouteRuleMatch value)
       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;

    • setMatchRules

      public HttpRouteRule.Builder setMatchRules(int index, HttpRouteRuleMatch.Builder builderForValue)
       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;

    • addMatchRules

      public HttpRouteRule.Builder addMatchRules(HttpRouteRuleMatch value)
       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;

    • addMatchRules

      public HttpRouteRule.Builder addMatchRules(int index, HttpRouteRuleMatch value)
       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;

    • addMatchRules

      public HttpRouteRule.Builder addMatchRules(HttpRouteRuleMatch.Builder builderForValue)
       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;

    • addMatchRules

      public HttpRouteRule.Builder addMatchRules(int index, HttpRouteRuleMatch.Builder builderForValue)
       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;

    • addAllMatchRules

      public HttpRouteRule.Builder addAllMatchRules(Iterable<? extends HttpRouteRuleMatch> values)
       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;

    • clearMatchRules

      public HttpRouteRule.Builder clearMatchRules()
       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;

    • removeMatchRules

      public HttpRouteRule.Builder removeMatchRules(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;

    • getMatchRulesBuilder

      public HttpRouteRuleMatch.Builder getMatchRulesBuilder(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;

    • 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

    • 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

    • addMatchRulesBuilder

      public HttpRouteRuleMatch.Builder addMatchRulesBuilder()
       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;

    • addMatchRulesBuilder

      public HttpRouteRuleMatch.Builder addMatchRulesBuilder(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;

    • getMatchRulesBuilderList

      public List<HttpRouteRuleMatch.Builder> getMatchRulesBuilderList()
       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;

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

    • setPriority

      public HttpRouteRule.Builder setPriority(int value)
       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;
      Parameters:
      value - The priority to set.
      Returns:
      This builder for chaining.

    • clearPriority

      public HttpRouteRule.Builder clearPriority()
       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;
      Returns:
      This builder for chaining.

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

    • setRouteAction

      public HttpRouteRule.Builder setRouteAction(HttpRouteAction value)
       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;

    • setRouteAction

      public HttpRouteRule.Builder setRouteAction(HttpRouteAction.Builder builderForValue)
       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;

    • mergeRouteAction

      public HttpRouteRule.Builder mergeRouteAction(HttpRouteAction value)
       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;

    • clearRouteAction

      public HttpRouteRule.Builder clearRouteAction()
       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;

    • getRouteActionBuilder

      public HttpRouteAction.Builder getRouteActionBuilder()
       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;

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

    • setService

      public HttpRouteRule.Builder setService(String value)
       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;
      Parameters:
      value - The service to set.
      Returns:
      This builder for chaining.

    • clearService

      public HttpRouteRule.Builder clearService()
       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;
      Returns:
      This builder for chaining.

    • setServiceBytes

      public HttpRouteRule.Builder setServiceBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for service to set.
      Returns:
      This builder for chaining.

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

    • setUrlRedirect

      public HttpRouteRule.Builder setUrlRedirect(HttpRedirectAction value)
       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;

    • setUrlRedirect

      public HttpRouteRule.Builder setUrlRedirect(HttpRedirectAction.Builder builderForValue)
       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;

    • mergeUrlRedirect

      public HttpRouteRule.Builder mergeUrlRedirect(HttpRedirectAction value)
       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;

    • clearUrlRedirect

      public HttpRouteRule.Builder clearUrlRedirect()
       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;

    • getUrlRedirectBuilder

      public HttpRedirectAction.Builder getUrlRedirectBuilder()
       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;

    • 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