Compute V1 Client - Class EnforceOnKey (2.0.0)

Reference documentation and code samples for the Compute V1 Client class EnforceOnKey.

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. - 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. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.

Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions.EnforceOnKey

A value indicating that the enum field is not set.

Generated from protobuf enum UNDEFINED_ENFORCE_ON_KEY = 0;

Generated from protobuf enum ALL = 64897;

Generated from protobuf enum HTTP_COOKIE = 494981627;

Generated from protobuf enum HTTP_HEADER = 91597348;

Generated from protobuf enum HTTP_PATH = 311503228;

Generated from protobuf enum IP = 2343;

Generated from protobuf enum REGION_CODE = 79559768;

Generated from protobuf enum SNI = 82254;

Generated from protobuf enum TLS_JA3_FINGERPRINT = 327127933;

Generated from protobuf enum TLS_JA4_FINGERPRINT = 33724926;

Generated from protobuf enum USER_IP = 34009627;

Generated from protobuf enum XFF_IP = 438707118;