SecurityPolicyRuleRateLimitOptions.EnforceOnKey (proto-google-cloud-compute-v1 1.78.0 API)

java.lang.Object
- java.lang.Enum<SecurityPolicyRuleRateLimitOptions.EnforceOnKey>
- - com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions.EnforceOnKey

All Implemented Interfaces:: com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SecurityPolicyRuleRateLimitOptions.EnforceOnKey>

Enclosing class:: SecurityPolicyRuleRateLimitOptions

public static enum SecurityPolicyRuleRateLimitOptions.EnforceOnKey
extends Enum<SecurityPolicyRuleRateLimitOptions.EnforceOnKey>
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 "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.

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALL` `ALL = 64897;`
`HTTP_COOKIE` `HTTP_COOKIE = 494981627;`
`HTTP_HEADER` `HTTP_HEADER = 91597348;`
`HTTP_PATH` `HTTP_PATH = 311503228;`
`IP` `IP = 2343;`
`REGION_CODE` `REGION_CODE = 79559768;`
`SNI` `SNI = 82254;`
`TLS_JA3_FINGERPRINT` `TLS_JA3_FINGERPRINT = 327127933;`
`TLS_JA4_FINGERPRINT` `TLS_JA4_FINGERPRINT = 33724926;`
`UNDEFINED_ENFORCE_ON_KEY` A value indicating that the enum field is not set.
`UNRECOGNIZED`
`USER_IP` `USER_IP = 34009627;`
`XFF_IP` `XFF_IP = 438707118;`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_VALUE` `ALL = 64897;`
`static int`	`HTTP_COOKIE_VALUE` `HTTP_COOKIE = 494981627;`
`static int`	`HTTP_HEADER_VALUE` `HTTP_HEADER = 91597348;`
`static int`	`HTTP_PATH_VALUE` `HTTP_PATH = 311503228;`
`static int`	`IP_VALUE` `IP = 2343;`
`static int`	`REGION_CODE_VALUE` `REGION_CODE = 79559768;`
`static int`	`SNI_VALUE` `SNI = 82254;`
`static int`	`TLS_JA3_FINGERPRINT_VALUE` `TLS_JA3_FINGERPRINT = 327127933;`
`static int`	`TLS_JA4_FINGERPRINT_VALUE` `TLS_JA4_FINGERPRINT = 33724926;`
`static int`	`UNDEFINED_ENFORCE_ON_KEY_VALUE` A value indicating that the enum field is not set.
`static int`	`USER_IP_VALUE` `USER_IP = 34009627;`
`static int`	`XFF_IP_VALUE` `XFF_IP = 438707118;`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static SecurityPolicyRuleRateLimitOptions.EnforceOnKey`	`forNumber(int value)`
`static com.google.protobuf.Descriptors.EnumDescriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.EnumDescriptor`	`getDescriptorForType()`
`int`	`getNumber()`
`com.google.protobuf.Descriptors.EnumValueDescriptor`	`getValueDescriptor()`
`static com.google.protobuf.Internal.EnumLiteMap<SecurityPolicyRuleRateLimitOptions.EnforceOnKey>`	`internalGetValueMap()`
`static SecurityPolicyRuleRateLimitOptions.EnforceOnKey`	`valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)`
`static SecurityPolicyRuleRateLimitOptions.EnforceOnKey`	`valueOf(int value)` Deprecated. Use `forNumber(int)` instead.
`static SecurityPolicyRuleRateLimitOptions.EnforceOnKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SecurityPolicyRuleRateLimitOptions.EnforceOnKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNDEFINED_ENFORCE_ON_KEY

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey UNDEFINED_ENFORCE_ON_KEY

 A value indicating that the enum field is not set.

UNDEFINED_ENFORCE_ON_KEY = 0;

ALL

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey ALL

ALL = 64897;

HTTP_COOKIE

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey HTTP_COOKIE

HTTP_COOKIE = 494981627;

HTTP_HEADER

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey HTTP_HEADER

HTTP_HEADER = 91597348;

HTTP_PATH

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey HTTP_PATH

HTTP_PATH = 311503228;

IP

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey IP

IP = 2343;

REGION_CODE

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey REGION_CODE

REGION_CODE = 79559768;

SNI

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey SNI

SNI = 82254;

TLS_JA3_FINGERPRINT

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey TLS_JA3_FINGERPRINT

TLS_JA3_FINGERPRINT = 327127933;

TLS_JA4_FINGERPRINT

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey TLS_JA4_FINGERPRINT

TLS_JA4_FINGERPRINT = 33724926;

USER_IP

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey USER_IP

USER_IP = 34009627;

XFF_IP

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey XFF_IP

XFF_IP = 438707118;

UNRECOGNIZED

public static final SecurityPolicyRuleRateLimitOptions.EnforceOnKey UNRECOGNIZED

Field Detail
- UNDEFINED_ENFORCE_ON_KEY_VALUE
```
public static final int UNDEFINED_ENFORCE_ON_KEY_VALUE
```
```
 A value indicating that the enum field is not set.
 
```
  UNDEFINED_ENFORCE_ON_KEY = 0;
  See Also:
  
  Constant Field Values
- ALL_VALUE
```
public static final int ALL_VALUE
```
  ALL = 64897;
  
  See Also:
  
  Constant Field Values
- HTTP_COOKIE_VALUE
```
public static final int HTTP_COOKIE_VALUE
```
  HTTP_COOKIE = 494981627;
  
  See Also:
  
  Constant Field Values
- HTTP_HEADER_VALUE
```
public static final int HTTP_HEADER_VALUE
```
  HTTP_HEADER = 91597348;
  
  See Also:
  
  Constant Field Values
- HTTP_PATH_VALUE
```
public static final int HTTP_PATH_VALUE
```
  HTTP_PATH = 311503228;
  
  See Also:
  
  Constant Field Values
- IP_VALUE
```
public static final int IP_VALUE
```
  IP = 2343;
  
  See Also:
  
  Constant Field Values
- REGION_CODE_VALUE
```
public static final int REGION_CODE_VALUE
```
  REGION_CODE = 79559768;
  
  See Also:
  
  Constant Field Values
- SNI_VALUE
```
public static final int SNI_VALUE
```
  SNI = 82254;
  
  See Also:
  
  Constant Field Values
- TLS_JA3_FINGERPRINT_VALUE
```
public static final int TLS_JA3_FINGERPRINT_VALUE
```
  TLS_JA3_FINGERPRINT = 327127933;
  
  See Also:
  
  Constant Field Values
- TLS_JA4_FINGERPRINT_VALUE
```
public static final int TLS_JA4_FINGERPRINT_VALUE
```
  TLS_JA4_FINGERPRINT = 33724926;
  
  See Also:
  
  Constant Field Values
- USER_IP_VALUE
```
public static final int USER_IP_VALUE
```
  USER_IP = 34009627;
  
  See Also:
  
  Constant Field Values
- XFF_IP_VALUE
```
public static final int XFF_IP_VALUE
```
  XFF_IP = 438707118;
  
  See Also:
  
  Constant Field Values

Method Detail
- values
```
public static SecurityPolicyRuleRateLimitOptions.EnforceOnKey[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SecurityPolicyRuleRateLimitOptions.EnforceOnKey c : SecurityPolicyRuleRateLimitOptions.EnforceOnKey.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static SecurityPolicyRuleRateLimitOptions.EnforceOnKey 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 name
  
  NullPointerException - if the argument is null
- getNumber
```
public final int getNumber()
```
  Specified by:
  
  getNumber in interface com.google.protobuf.Internal.EnumLite
  
  Specified by:
  
  getNumber in interface com.google.protobuf.ProtocolMessageEnum
- valueOf
```
@Deprecated
public static SecurityPolicyRuleRateLimitOptions.EnforceOnKey valueOf(int value)
```
  Deprecated. Use forNumber(int) instead.
  
  Parameters:
  
  value - The numeric wire value of the corresponding enum entry.
  
  Returns:
  
  The enum associated with the given numeric wire value.
- forNumber
```
public static SecurityPolicyRuleRateLimitOptions.EnforceOnKey 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<SecurityPolicyRuleRateLimitOptions.EnforceOnKey> internalGetValueMap()
```
- getValueDescriptor
```
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
```
  Specified by:
  
  getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
- getDescriptorForType
```
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
```
  Specified by:
  
  getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
- getDescriptor
```
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
```
- valueOf
```
public static SecurityPolicyRuleRateLimitOptions.EnforceOnKey valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
```

Enum SecurityPolicyRuleRateLimitOptions.EnforceOnKey

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNDEFINED_ENFORCE_ON_KEY

ALL

HTTP_COOKIE

HTTP_HEADER

HTTP_PATH

IP

REGION_CODE

SNI

TLS_JA3_FINGERPRINT

TLS_JA4_FINGERPRINT

USER_IP

XFF_IP

UNRECOGNIZED

Field Detail

UNDEFINED_ENFORCE_ON_KEY_VALUE

ALL_VALUE

HTTP_COOKIE_VALUE

HTTP_HEADER_VALUE

HTTP_PATH_VALUE

IP_VALUE

REGION_CODE_VALUE

SNI_VALUE

TLS_JA3_FINGERPRINT_VALUE

TLS_JA4_FINGERPRINT_VALUE

USER_IP_VALUE

XFF_IP_VALUE

Method Detail

values

valueOf

getNumber

valueOf

forNumber

internalGetValueMap

getValueDescriptor

getDescriptorForType

getDescriptor

valueOf