Struct google_api_proto::google::cloud::compute::v1::SecurityPolicyRuleRateLimitOptions

pub struct SecurityPolicyRuleRateLimitOptions {
    pub ban_duration_sec: Option<i32>,
    pub ban_threshold: Option<SecurityPolicyRuleRateLimitOptionsThreshold>,
    pub conform_action: Option<String>,
    pub enforce_on_key: Option<String>,
    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>,
}

Fields

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

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 ban_duration_sec(&self) -> i32

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

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 exceed_action(&self) -> &str

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

pub fn enforce_on_key(&self) -> &str

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

pub fn conform_action(&self) -> &str

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

Trait Implementations

impl Clone for SecurityPolicyRuleRateLimitOptions

fn clone(&self) -> SecurityPolicyRuleRateLimitOptions

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

Returns the “default value” for a type.

impl Message for SecurityPolicyRuleRateLimitOptions

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 SecurityPolicyRuleRateLimitOptions

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