Struct HttpRouteRule 

#[non_exhaustive]
pub struct HttpRouteRule {
    pub custom_error_response_policy: Option<CustomErrorResponsePolicy>,
    pub description: Option<String>,
    pub header_action: Option<HttpHeaderAction>,
    pub match_rules: Vec<HttpRouteRuleMatch>,
    pub priority: Option<i32>,
    pub route_action: Option<HttpRouteAction>,
    pub service: Option<String>,
    pub url_redirect: Option<HttpRedirectAction>,
    /* private fields */
}

Available on crate features region-url-maps or url-maps only.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

custom_error_response_policy: Option<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: Option<String>

The short description conveying the intent of this routeRule.

The description can have a maximum length of 1024 characters.

header_action: Option<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: Vec<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: Option<i32>

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: Option<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: Option<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: Option<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.

Implementations

impl HttpRouteRule

pub fn new() -> Self

pub fn set_custom_error_response_policy<T>(self, v: T) -> Self

where T: Into<CustomErrorResponsePolicy>,

Sets the value of custom_error_response_policy.

Example

use google_cloud_compute_v1::model::CustomErrorResponsePolicy;
let x = HttpRouteRule::new().set_custom_error_response_policy(CustomErrorResponsePolicy::default()/* use setters */);

pub fn set_or_clear_custom_error_response_policy<T>(self, v: Option<T>) -> Self

where T: Into<CustomErrorResponsePolicy>,

Sets or clears the value of custom_error_response_policy.

Example

use google_cloud_compute_v1::model::CustomErrorResponsePolicy;
let x = HttpRouteRule::new().set_or_clear_custom_error_response_policy(Some(CustomErrorResponsePolicy::default()/* use setters */));
let x = HttpRouteRule::new().set_or_clear_custom_error_response_policy(None::<CustomErrorResponsePolicy>);

pub fn set_description<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of description.

Example

let x = HttpRouteRule::new().set_description("example");

pub fn set_or_clear_description<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of description.

Example

let x = HttpRouteRule::new().set_or_clear_description(Some("example"));
let x = HttpRouteRule::new().set_or_clear_description(None::<String>);

pub fn set_header_action<T>(self, v: T) -> Self

where T: Into<HttpHeaderAction>,

Sets the value of header_action.

Example

use google_cloud_compute_v1::model::HttpHeaderAction;
let x = HttpRouteRule::new().set_header_action(HttpHeaderAction::default()/* use setters */);

pub fn set_or_clear_header_action<T>(self, v: Option<T>) -> Self

where T: Into<HttpHeaderAction>,

Sets or clears the value of header_action.

Example

use google_cloud_compute_v1::model::HttpHeaderAction;
let x = HttpRouteRule::new().set_or_clear_header_action(Some(HttpHeaderAction::default()/* use setters */));
let x = HttpRouteRule::new().set_or_clear_header_action(None::<HttpHeaderAction>);

pub fn set_match_rules<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<HttpRouteRuleMatch>,

Sets the value of match_rules.

Example

use google_cloud_compute_v1::model::HttpRouteRuleMatch;
let x = HttpRouteRule::new()
    .set_match_rules([
        HttpRouteRuleMatch::default()/* use setters */,
        HttpRouteRuleMatch::default()/* use (different) setters */,
    ]);

pub fn set_priority<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of priority.

Example

let x = HttpRouteRule::new().set_priority(42);

pub fn set_or_clear_priority<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of priority.

Example

let x = HttpRouteRule::new().set_or_clear_priority(Some(42));
let x = HttpRouteRule::new().set_or_clear_priority(None::<i32>);

pub fn set_route_action<T>(self, v: T) -> Self

where T: Into<HttpRouteAction>,

Sets the value of route_action.

Example

use google_cloud_compute_v1::model::HttpRouteAction;
let x = HttpRouteRule::new().set_route_action(HttpRouteAction::default()/* use setters */);

pub fn set_or_clear_route_action<T>(self, v: Option<T>) -> Self

where T: Into<HttpRouteAction>,

Sets or clears the value of route_action.

Example

use google_cloud_compute_v1::model::HttpRouteAction;
let x = HttpRouteRule::new().set_or_clear_route_action(Some(HttpRouteAction::default()/* use setters */));
let x = HttpRouteRule::new().set_or_clear_route_action(None::<HttpRouteAction>);

pub fn set_service<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of service.

Example

let x = HttpRouteRule::new().set_service("example");

pub fn set_or_clear_service<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of service.

Example

let x = HttpRouteRule::new().set_or_clear_service(Some("example"));
let x = HttpRouteRule::new().set_or_clear_service(None::<String>);

pub fn set_url_redirect<T>(self, v: T) -> Self

where T: Into<HttpRedirectAction>,

Sets the value of url_redirect.

Example

use google_cloud_compute_v1::model::HttpRedirectAction;
let x = HttpRouteRule::new().set_url_redirect(HttpRedirectAction::default()/* use setters */);

pub fn set_or_clear_url_redirect<T>(self, v: Option<T>) -> Self

where T: Into<HttpRedirectAction>,

Sets or clears the value of url_redirect.

Example

use google_cloud_compute_v1::model::HttpRedirectAction;
let x = HttpRouteRule::new().set_or_clear_url_redirect(Some(HttpRedirectAction::default()/* use setters */));
let x = HttpRouteRule::new().set_or_clear_url_redirect(None::<HttpRedirectAction>);

Trait Implementations

impl Clone for HttpRouteRule

fn clone(&self) -> HttpRouteRule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpRouteRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpRouteRule

fn default() -> HttpRouteRule

Returns the “default value” for a type.

impl Message for HttpRouteRule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HttpRouteRule

fn eq(&self, other: &HttpRouteRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpRouteRule