Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::HttpRouteRule (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::HttpRouteRule.

The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#custom_error_response_policy

def custom_error_response_policy() -> ::Google::Cloud::Compute::V1::CustomErrorResponsePolicy
Returns
  • (::Google::Cloud::Compute::V1::CustomErrorResponsePolicy) — 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.

#custom_error_response_policy=

def custom_error_response_policy=(value) -> ::Google::Cloud::Compute::V1::CustomErrorResponsePolicy
Parameter
  • value (::Google::Cloud::Compute::V1::CustomErrorResponsePolicy) — 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.

Returns
  • (::Google::Cloud::Compute::V1::CustomErrorResponsePolicy) — 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.

#description

def description() -> ::String
Returns
  • (::String) — The short description conveying the intent of this routeRule.

    The description can have a maximum length of 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — The short description conveying the intent of this routeRule.

    The description can have a maximum length of 1024 characters.

Returns
  • (::String) — The short description conveying the intent of this routeRule.

    The description can have a maximum length of 1024 characters.

#header_action

def header_action() -> ::Google::Cloud::Compute::V1::HttpHeaderAction
Returns
  • (::Google::Cloud::Compute::V1::HttpHeaderAction) — 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.

#header_action=

def header_action=(value) -> ::Google::Cloud::Compute::V1::HttpHeaderAction
Parameter
  • value (::Google::Cloud::Compute::V1::HttpHeaderAction) — 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.

Returns
  • (::Google::Cloud::Compute::V1::HttpHeaderAction) — 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.

#match_rules

def match_rules() -> ::Array<::Google::Cloud::Compute::V1::HttpRouteRuleMatch>
Returns
  • (::Array<::Google::Cloud::Compute::V1::HttpRouteRuleMatch>) — 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.

#match_rules=

def match_rules=(value) -> ::Array<::Google::Cloud::Compute::V1::HttpRouteRuleMatch>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::HttpRouteRuleMatch>) — 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.
Returns
  • (::Array<::Google::Cloud::Compute::V1::HttpRouteRuleMatch>) — 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.

#priority

def priority() -> ::Integer
Returns
  • (::Integer) — 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.

#priority=

def priority=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#route_action

def route_action() -> ::Google::Cloud::Compute::V1::HttpRouteAction
Returns
  • (::Google::Cloud::Compute::V1::HttpRouteAction) — 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.

#route_action=

def route_action=(value) -> ::Google::Cloud::Compute::V1::HttpRouteAction
Parameter
  • value (::Google::Cloud::Compute::V1::HttpRouteAction) — 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.

Returns
  • (::Google::Cloud::Compute::V1::HttpRouteAction) — 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.

#service

def service() -> ::String
Returns
  • (::String) — 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.

#service=

def service=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#url_redirect

def url_redirect() -> ::Google::Cloud::Compute::V1::HttpRedirectAction
Returns
  • (::Google::Cloud::Compute::V1::HttpRedirectAction) — 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.

#url_redirect=

def url_redirect=(value) -> ::Google::Cloud::Compute::V1::HttpRedirectAction
Parameter
  • value (::Google::Cloud::Compute::V1::HttpRedirectAction) — 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.

Returns
  • (::Google::Cloud::Compute::V1::HttpRedirectAction) — 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.