Package com.google.cloud.compute.v1
Enum SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType
java.lang.Object
java.lang.Enum<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType>
com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType>
- Enclosing class:
- SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
public static enum SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType
extends Enum<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType>
implements com.google.protobuf.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 toALL. - 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 toALL. - 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 toIP. - 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.Protobuf enum
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionALL = 64897;HTTP_COOKIE = 494981627;HTTP_HEADER = 91597348;HTTP_PATH = 311503228;IP = 2343;REGION_CODE = 79559768;SNI = 82254;TLS_JA3_FINGERPRINT = 327127933;TLS_JA4_FINGERPRINT = 33724926;A value indicating that the enum field is not set.USER_IP = 34009627;XFF_IP = 438707118; -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intALL = 64897;static final intHTTP_COOKIE = 494981627;static final intHTTP_HEADER = 91597348;static final intHTTP_PATH = 311503228;static final intIP = 2343;static final intREGION_CODE = 79559768;static final intSNI = 82254;static final intTLS_JA3_FINGERPRINT = 327127933;static final intTLS_JA4_FINGERPRINT = 33724926;static final intA value indicating that the enum field is not set.static final intUSER_IP = 34009627;static final intXFF_IP = 438707118; -
Method Summary
Modifier and TypeMethodDescriptionforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType>valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.Returns the enum constant of this type with the specified name.values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
UNDEFINED_ENFORCE_ON_KEY_TYPE
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType UNDEFINED_ENFORCE_ON_KEY_TYPEA value indicating that the enum field is not set.
UNDEFINED_ENFORCE_ON_KEY_TYPE = 0; -
ALL
ALL = 64897; -
HTTP_COOKIE
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType HTTP_COOKIEHTTP_COOKIE = 494981627; -
HTTP_HEADER
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType HTTP_HEADERHTTP_HEADER = 91597348; -
HTTP_PATH
HTTP_PATH = 311503228; -
IP
IP = 2343; -
REGION_CODE
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType REGION_CODEREGION_CODE = 79559768; -
SNI
SNI = 82254; -
TLS_JA3_FINGERPRINT
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType TLS_JA3_FINGERPRINTTLS_JA3_FINGERPRINT = 327127933; -
TLS_JA4_FINGERPRINT
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType TLS_JA4_FINGERPRINTTLS_JA4_FINGERPRINT = 33724926; -
USER_IP
USER_IP = 34009627; -
XFF_IP
XFF_IP = 438707118; -
UNRECOGNIZED
public static final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType UNRECOGNIZED
-
-
Field Details
-
UNDEFINED_ENFORCE_ON_KEY_TYPE_VALUE
public static final int UNDEFINED_ENFORCE_ON_KEY_TYPE_VALUEA value indicating that the enum field is not set.
UNDEFINED_ENFORCE_ON_KEY_TYPE = 0;- See Also:
-
ALL_VALUE
public static final int ALL_VALUEALL = 64897;- See Also:
-
HTTP_COOKIE_VALUE
public static final int HTTP_COOKIE_VALUEHTTP_COOKIE = 494981627;- See Also:
-
HTTP_HEADER_VALUE
public static final int HTTP_HEADER_VALUEHTTP_HEADER = 91597348;- See Also:
-
HTTP_PATH_VALUE
public static final int HTTP_PATH_VALUEHTTP_PATH = 311503228;- See Also:
-
IP_VALUE
public static final int IP_VALUEIP = 2343;- See Also:
-
REGION_CODE_VALUE
public static final int REGION_CODE_VALUEREGION_CODE = 79559768;- See Also:
-
SNI_VALUE
public static final int SNI_VALUESNI = 82254;- See Also:
-
TLS_JA3_FINGERPRINT_VALUE
public static final int TLS_JA3_FINGERPRINT_VALUETLS_JA3_FINGERPRINT = 327127933;- See Also:
-
TLS_JA4_FINGERPRINT_VALUE
public static final int TLS_JA4_FINGERPRINT_VALUETLS_JA4_FINGERPRINT = 33724926;- See Also:
-
USER_IP_VALUE
public static final int USER_IP_VALUEUSER_IP = 34009627;- See Also:
-
XFF_IP_VALUE
public static final int XFF_IP_VALUEXFF_IP = 438707118;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType valueOf(String name) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
@Deprecated public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType valueOf(int value) Deprecated.Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
value- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
forNumber
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType forNumber(int value) - Parameters:
value- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
public static com.google.protobuf.Internal.EnumLiteMap<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType> internalGetValueMap() -
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.EnforceOnKeyType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
desc- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-