Struct SecurityPolicyRuleRateLimitOptions 

#[non_exhaustive]
pub struct SecurityPolicyRuleRateLimitOptions {
    pub ban_duration_sec: Option<i32>,
    pub ban_threshold: Option<SecurityPolicyRuleRateLimitOptionsThreshold>,
    pub conform_action: Option<String>,
    pub enforce_on_key: Option<EnforceOnKey>,
    pub enforce_on_key_configs: Vec<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>,
    pub enforce_on_key_name: Option<String>,
    pub exceed_action: Option<String>,
    pub exceed_redirect_options: Option<SecurityPolicyRuleRedirectOptions>,
    pub rate_limit_threshold: Option<SecurityPolicyRuleRateLimitOptionsThreshold>,
    /* private fields */
}

Available on crate features organization-security-policies or region-security-policies or security-policies only.

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.

ban_duration_sec: Option<i32>

Can only be specified if the action for the rule is “rate_based_ban”. If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

ban_threshold: Option<SecurityPolicyRuleRateLimitOptionsThreshold>

Can only be specified if the action for the rule is “rate_based_ban”. If specified, the key will be banned for the configured ‘ban_duration_sec’ when the number of requests that exceed the ‘rate_limit_threshold’ also exceed this ‘ban_threshold’.

conform_action: Option<String>

Action to take for requests that are under the configured rate limit threshold. Valid option is “allow” only.

enforce_on_key: Option<EnforceOnKey>

Determines the key to enforce the rate_limit_threshold on. Possible values are:

• ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if “enforceOnKey” is not configured.

• IP: The source IP address of the request is the key. Each IP has this limit enforced separately.

• HTTP_HEADER: The value of the HTTP header whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults toALL.

• XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.

• HTTP_COOKIE: The value of the HTTP cookie whose name is configured under “enforceOnKeyName”. The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults toALL.

• HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.

• SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.

• REGION_CODE: The country/region from which the request originates.

• TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.

• USER_IP: The IP address of the originating client, which is resolved based on “userIpRequestHeaders” configured with the security policy. If there is no “userIpRequestHeaders” configuration or an IP address cannot be resolved from it, the key type defaults toIP.

• TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For “fairshare” action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.

enforce_on_key_configs: Vec<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>

If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.

enforce_on_key_name: Option<String>

Rate limit key name applicable only for the following key types: HTTP_HEADER – Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE – Name of the HTTP cookie whose value is taken as the key value.

exceed_action: Option<String>

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below. The redirect action is only supported in Global Security Policies of type CLOUD_ARMOR.

exceed_redirect_options: Option<SecurityPolicyRuleRedirectOptions>

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

rate_limit_threshold: Option<SecurityPolicyRuleRateLimitOptionsThreshold>

Threshold at which to begin ratelimiting.

Implementations

impl SecurityPolicyRuleRateLimitOptions

pub fn new() -> Self

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

where T: Into<i32>,

Sets the value of ban_duration_sec.

Example

let x = SecurityPolicyRuleRateLimitOptions::new().set_ban_duration_sec(42);

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

where T: Into<i32>,

Sets or clears the value of ban_duration_sec.

Example

let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_ban_duration_sec(Some(42));
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_ban_duration_sec(None::<i32>);

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

where T: Into<SecurityPolicyRuleRateLimitOptionsThreshold>,

Sets the value of ban_threshold.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRateLimitOptionsThreshold;
let x = SecurityPolicyRuleRateLimitOptions::new().set_ban_threshold(SecurityPolicyRuleRateLimitOptionsThreshold::default()/* use setters */);

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

where T: Into<SecurityPolicyRuleRateLimitOptionsThreshold>,

Sets or clears the value of ban_threshold.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRateLimitOptionsThreshold;
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_ban_threshold(Some(SecurityPolicyRuleRateLimitOptionsThreshold::default()/* use setters */));
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_ban_threshold(None::<SecurityPolicyRuleRateLimitOptionsThreshold>);

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

where T: Into<String>,

Sets the value of conform_action.

Example

let x = SecurityPolicyRuleRateLimitOptions::new().set_conform_action("example");

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

where T: Into<String>,

Sets or clears the value of conform_action.

Example

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

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

where T: Into<EnforceOnKey>,

Sets the value of enforce_on_key.

Example

use google_cloud_compute_v1::model::security_policy_rule_rate_limit_options::EnforceOnKey;
let x0 = SecurityPolicyRuleRateLimitOptions::new().set_enforce_on_key(EnforceOnKey::HttpCookie);
let x1 = SecurityPolicyRuleRateLimitOptions::new().set_enforce_on_key(EnforceOnKey::HttpHeader);
let x2 = SecurityPolicyRuleRateLimitOptions::new().set_enforce_on_key(EnforceOnKey::HttpPath);

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

where T: Into<EnforceOnKey>,

Sets or clears the value of enforce_on_key.

Example

use google_cloud_compute_v1::model::security_policy_rule_rate_limit_options::EnforceOnKey;
let x0 = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_enforce_on_key(Some(EnforceOnKey::HttpCookie));
let x1 = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_enforce_on_key(Some(EnforceOnKey::HttpHeader));
let x2 = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_enforce_on_key(Some(EnforceOnKey::HttpPath));
let x_none = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_enforce_on_key(None::<EnforceOnKey>);

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

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

Sets the value of enforce_on_key_configs.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig;
let x = SecurityPolicyRuleRateLimitOptions::new()
    .set_enforce_on_key_configs([
        SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::default()/* use setters */,
        SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::default()/* use (different) setters */,
    ]);

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

where T: Into<String>,

Sets the value of enforce_on_key_name.

Example

let x = SecurityPolicyRuleRateLimitOptions::new().set_enforce_on_key_name("example");

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

where T: Into<String>,

Sets or clears the value of enforce_on_key_name.

Example

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

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

where T: Into<String>,

Sets the value of exceed_action.

Example

let x = SecurityPolicyRuleRateLimitOptions::new().set_exceed_action("example");

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

where T: Into<String>,

Sets or clears the value of exceed_action.

Example

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

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

where T: Into<SecurityPolicyRuleRedirectOptions>,

Sets the value of exceed_redirect_options.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRedirectOptions;
let x = SecurityPolicyRuleRateLimitOptions::new().set_exceed_redirect_options(SecurityPolicyRuleRedirectOptions::default()/* use setters */);

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

where T: Into<SecurityPolicyRuleRedirectOptions>,

Sets or clears the value of exceed_redirect_options.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRedirectOptions;
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_exceed_redirect_options(Some(SecurityPolicyRuleRedirectOptions::default()/* use setters */));
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_exceed_redirect_options(None::<SecurityPolicyRuleRedirectOptions>);

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

where T: Into<SecurityPolicyRuleRateLimitOptionsThreshold>,

Sets the value of rate_limit_threshold.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRateLimitOptionsThreshold;
let x = SecurityPolicyRuleRateLimitOptions::new().set_rate_limit_threshold(SecurityPolicyRuleRateLimitOptionsThreshold::default()/* use setters */);

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

where T: Into<SecurityPolicyRuleRateLimitOptionsThreshold>,

Sets or clears the value of rate_limit_threshold.

Example

use google_cloud_compute_v1::model::SecurityPolicyRuleRateLimitOptionsThreshold;
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_rate_limit_threshold(Some(SecurityPolicyRuleRateLimitOptionsThreshold::default()/* use setters */));
let x = SecurityPolicyRuleRateLimitOptions::new().set_or_clear_rate_limit_threshold(None::<SecurityPolicyRuleRateLimitOptionsThreshold>);

Trait Implementations

impl Clone for SecurityPolicyRuleRateLimitOptions

fn clone(&self) -> SecurityPolicyRuleRateLimitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityPolicyRuleRateLimitOptions

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

Formats the value using the given formatter.

impl Default for SecurityPolicyRuleRateLimitOptions

fn default() -> SecurityPolicyRuleRateLimitOptions

Returns the “default value” for a type.

impl Message for SecurityPolicyRuleRateLimitOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SecurityPolicyRuleRateLimitOptions

fn eq(&self, other: &SecurityPolicyRuleRateLimitOptions) -> 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 SecurityPolicyRuleRateLimitOptions