Enum google_api_proto::google::cloud::compute::v1::security_policy_rule_rate_limit_options::EnforceOnKey

#[repr(i32)]
pub enum EnforceOnKey {
    UndefinedEnforceOnKey = 0,
    All = 64_897,
    HttpCookie = 494_981_627,
    HttpHeader = 91_597_348,
    HttpPath = 311_503_228,
    Ip = 2_343,
    RegionCode = 79_559_768,
    Sni = 82_254,
    TlsJa3Fingerprint = 327_127_933,
    UserIp = 34_009_627,
    XffIp = 438_707_118,
}

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 to ALL. - 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 to ALL. - 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 to IP.

Variants

UndefinedEnforceOnKey = 0

A value indicating that the enum field is not set.

All = 64_897

HttpCookie = 494_981_627

HttpHeader = 91_597_348

HttpPath = 311_503_228

Ip = 2_343

RegionCode = 79_559_768

Sni = 82_254

TlsJa3Fingerprint = 327_127_933

UserIp = 34_009_627

XffIp = 438_707_118

Implementations

impl EnforceOnKey

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of EnforceOnKey.

pub fn from_i32(value: i32) -> Option<EnforceOnKey>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a EnforceOnKey, or None if value is not a valid variant.

impl EnforceOnKey

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for EnforceOnKey

fn clone(&self) -> EnforceOnKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnforceOnKey

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

Formats the value using the given formatter.

impl Default for EnforceOnKey

fn default() -> EnforceOnKey

Returns the “default value” for a type.

impl From<EnforceOnKey> for i32

fn from(value: EnforceOnKey) -> i32

Converts to this type from the input type.

impl Hash for EnforceOnKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EnforceOnKey

fn cmp(&self, other: &EnforceOnKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EnforceOnKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for EnforceOnKey

fn partial_cmp(&self, other: &EnforceOnKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for EnforceOnKey

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<EnforceOnKey, DecodeError>

Performs the conversion.

impl Copy for EnforceOnKey

impl Eq for EnforceOnKey

impl StructuralPartialEq for EnforceOnKey