Struct google_api_proto::google::cloud::compute::v1::SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

pub struct SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig {
    pub enforce_on_key_name: Option<String>,
    pub enforce_on_key_type: Option<String>,
}

Fields

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<String>

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 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. Check the EnforceOnKeyType enum for the list of possible values.

Implementations

impl SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

pub fn enforce_on_key_name(&self) -> &str

Returns the value of enforce_on_key_name, or the default value if enforce_on_key_name is unset.

pub fn enforce_on_key_type(&self) -> &str

Returns the value of enforce_on_key_type, or the default value if enforce_on_key_type is unset.

Trait Implementations

impl Clone for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn clone(&self) -> SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

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