Struct SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig 

#[non_exhaustive]
pub struct SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig {
    pub enforce_on_key_name: Option<String>,
    pub enforce_on_key_type: Option<EnforceOnKeyType>,
    /* 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.

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.

enforce_on_key_type: Option<EnforceOnKeyType>

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 “enforceOnKeyConfigs” 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.

Implementations

impl SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

pub fn new() -> Self

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 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::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 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_or_clear_enforce_on_key_name(Some("example"));
let x = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_or_clear_enforce_on_key_name(None::<String>);

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

where T: Into<EnforceOnKeyType>,

Sets the value of enforce_on_key_type.

Example

use google_cloud_compute_v1::model::security_policy_rule_rate_limit_options_enforce_on_key_config::EnforceOnKeyType;
let x0 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_enforce_on_key_type(EnforceOnKeyType::HttpCookie);
let x1 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_enforce_on_key_type(EnforceOnKeyType::HttpHeader);
let x2 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_enforce_on_key_type(EnforceOnKeyType::HttpPath);

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

where T: Into<EnforceOnKeyType>,

Sets or clears the value of enforce_on_key_type.

Example

use google_cloud_compute_v1::model::security_policy_rule_rate_limit_options_enforce_on_key_config::EnforceOnKeyType;
let x0 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_or_clear_enforce_on_key_type(Some(EnforceOnKeyType::HttpCookie));
let x1 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_or_clear_enforce_on_key_type(Some(EnforceOnKeyType::HttpHeader));
let x2 = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_or_clear_enforce_on_key_type(Some(EnforceOnKeyType::HttpPath));
let x_none = SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig::new().set_or_clear_enforce_on_key_type(None::<EnforceOnKeyType>);

Trait Implementations

impl Clone for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn clone(&self) -> SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

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

Formats the value using the given formatter.

impl Default for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn default() -> SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

Returns the “default value” for a type.

impl Message for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

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