Enum SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType (1.58.0)

public enum SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType extends Enum<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType> implements ProtocolMessageEnum

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.

Protobuf enum google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType

Implements

ProtocolMessageEnum

Static Fields

Name Description
ALL

ALL = 64897;

ALL_VALUE

ALL = 64897;

HTTP_COOKIE = 494981627;

HTTP_COOKIE = 494981627;

HTTP_HEADER

HTTP_HEADER = 91597348;

HTTP_HEADER_VALUE

HTTP_HEADER = 91597348;

HTTP_PATH

HTTP_PATH = 311503228;

HTTP_PATH_VALUE

HTTP_PATH = 311503228;

IP

IP = 2343;

IP_VALUE

IP = 2343;

REGION_CODE

REGION_CODE = 79559768;

REGION_CODE_VALUE

REGION_CODE = 79559768;

SNI

SNI = 82254;

SNI_VALUE

SNI = 82254;

TLS_JA3_FINGERPRINT

TLS_JA3_FINGERPRINT = 327127933;

TLS_JA3_FINGERPRINT_VALUE

TLS_JA3_FINGERPRINT = 327127933;

UNDEFINED_ENFORCE_ON_KEY_TYPE

A value indicating that the enum field is not set.

UNDEFINED_ENFORCE_ON_KEY_TYPE = 0;

UNDEFINED_ENFORCE_ON_KEY_TYPE_VALUE

A value indicating that the enum field is not set.

UNDEFINED_ENFORCE_ON_KEY_TYPE = 0;

UNRECOGNIZED
USER_IP

USER_IP = 34009627;

USER_IP_VALUE

USER_IP = 34009627;

XFF_IP

XFF_IP = 438707118;

XFF_IP_VALUE

XFF_IP = 438707118;

Static Methods

Name Description
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.

valueOf(String name)
values()

Methods

Name Description
getDescriptorForType()
getNumber()
getValueDescriptor()