Class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig (1.56.0)

public final class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig extends GeneratedMessageV3 implements SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder

Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

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()
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder()
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)
Parameter
Name Description
prototype SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

parseDelimitedFrom(InputStream input)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> parser()
Returns
Type Description
Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstanceForType()
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

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. 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. 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()
Returns
Type Description
Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>
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. 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType()
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder toBuilder()
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException