Class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig (1.40.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
TypeDescription
int

ENFORCE_ON_KEY_TYPE_FIELD_NUMBER

public static final int ENFORCE_ON_KEY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstance()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)
Parameter
NameDescription
prototypeSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

parseDelimitedFrom(InputStream input)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> parser()
Returns
TypeDescription
Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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. Check the EnforceOnKeyType enum for the list of possible values.

optional string enforce_on_key_type = 132757149;

Returns
TypeDescription
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. Check the EnforceOnKeyType enum for the list of possible values.

optional string enforce_on_key_type = 132757149;

Returns
TypeDescription
ByteString

The bytes for enforceOnKeyType.

getParserForType()

public Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> getParserForType()
Returns
TypeDescription
Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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. Check the EnforceOnKeyType enum for the list of possible values.

optional string enforce_on_key_type = 132757149;

Returns
TypeDescription
boolean

Whether the enforceOnKeyType field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder toBuilder()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException