public final class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig extends GeneratedMessageV3 implements SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
Protobuf type
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ENFORCE_ON_KEY_NAME_FIELD_NUMBER
public static final int ENFORCE_ON_KEY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENFORCE_ON_KEY_TYPE_FIELD_NUMBER
public static final int ENFORCE_ON_KEY_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder()
newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(CodedInputStream input)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstanceForType()
getEnforceOnKeyName()
public String getEnforceOnKeyName()
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.
optional string enforce_on_key_name = 132555246;
| Returns |
| Type |
Description |
String |
The enforceOnKeyName.
|
getEnforceOnKeyNameBytes()
public ByteString getEnforceOnKeyNameBytes()
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.
optional string enforce_on_key_name = 132555246;
| Returns |
| Type |
Description |
ByteString |
The bytes for enforceOnKeyName.
|
getEnforceOnKeyType()
public String getEnforceOnKeyType()
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. - 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.
Check the EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Returns |
| Type |
Description |
String |
The enforceOnKeyType.
|
getEnforceOnKeyTypeBytes()
public ByteString getEnforceOnKeyTypeBytes()
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. - 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.
Check the EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Returns |
| Type |
Description |
ByteString |
The bytes for enforceOnKeyType.
|
getParserForType()
public Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasEnforceOnKeyName()
public boolean hasEnforceOnKeyName()
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.
optional string enforce_on_key_name = 132555246;
| Returns |
| Type |
Description |
boolean |
Whether the enforceOnKeyName field is set.
|
hasEnforceOnKeyType()
public boolean hasEnforceOnKeyType()
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. - 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.
Check the EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Returns |
| Type |
Description |
boolean |
Whether the enforceOnKeyType field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
