com.google.cloud.compute.v1

Class SecurityPolicyRuleRateLimitOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

All Implemented Interfaces:

SecurityPolicyRuleRateLimitOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SecurityPolicyRuleRateLimitOptions
extends com.google.protobuf.GeneratedMessageV3
implements SecurityPolicyRuleRateLimitOptionsOrBuilder

Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityPolicyRuleRateLimitOptions.Builder Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions
static class	SecurityPolicyRuleRateLimitOptions.EnforceOnKey Determines the key to enforce the rate_limit_threshold on.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BAN_DURATION_SEC_FIELD_NUMBER
static int	BAN_THRESHOLD_FIELD_NUMBER
static int	CONFORM_ACTION_FIELD_NUMBER
static int	ENFORCE_ON_KEY_CONFIGS_FIELD_NUMBER
static int	ENFORCE_ON_KEY_FIELD_NUMBER
static int	ENFORCE_ON_KEY_NAME_FIELD_NUMBER
static int	EXCEED_ACTION_FIELD_NUMBER
static int	EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER
static int	RATE_LIMIT_THRESHOLD_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getBanDurationSec() Can only be specified if the action for the rule is "rate_based_ban".
SecurityPolicyRuleRateLimitOptionsThreshold	getBanThreshold() Can only be specified if the action for the rule is "rate_based_ban".
SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder	getBanThresholdOrBuilder() Can only be specified if the action for the rule is "rate_based_ban".
String	getConformAction() Action to take for requests that are under the configured rate limit threshold.
com.google.protobuf.ByteString	getConformActionBytes() Action to take for requests that are under the configured rate limit threshold.
static SecurityPolicyRuleRateLimitOptions	getDefaultInstance()
SecurityPolicyRuleRateLimitOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEnforceOnKey() Determines the key to enforce the rate_limit_threshold on.
com.google.protobuf.ByteString	getEnforceOnKeyBytes() Determines the key to enforce the rate_limit_threshold on.
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig	getEnforceOnKeyConfigs(int index) If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced.
int	getEnforceOnKeyConfigsCount() If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced.
List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>	getEnforceOnKeyConfigsList() If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced.
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder	getEnforceOnKeyConfigsOrBuilder(int index) If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced.
List<? extends SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder>	getEnforceOnKeyConfigsOrBuilderList() If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced.
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.
com.google.protobuf.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.
String	getExceedAction() Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint.
com.google.protobuf.ByteString	getExceedActionBytes() Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint.
SecurityPolicyRuleRedirectOptions	getExceedRedirectOptions() Parameters defining the redirect action that is used as the exceed action.
SecurityPolicyRuleRedirectOptionsOrBuilder	getExceedRedirectOptionsOrBuilder() Parameters defining the redirect action that is used as the exceed action.
com.google.protobuf.Parser<SecurityPolicyRuleRateLimitOptions>	getParserForType()
SecurityPolicyRuleRateLimitOptionsThreshold	getRateLimitThreshold() Threshold at which to begin ratelimiting.
SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder	getRateLimitThresholdOrBuilder() Threshold at which to begin ratelimiting.
int	getSerializedSize()
boolean	hasBanDurationSec() Can only be specified if the action for the rule is "rate_based_ban".
boolean	hasBanThreshold() Can only be specified if the action for the rule is "rate_based_ban".
boolean	hasConformAction() Action to take for requests that are under the configured rate limit threshold.
boolean	hasEnforceOnKey() Determines the key to enforce the rate_limit_threshold on.
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.
boolean	hasExceedAction() Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint.
boolean	hasExceedRedirectOptions() Parameters defining the redirect action that is used as the exceed action.
int	hashCode()
boolean	hasRateLimitThreshold() Threshold at which to begin ratelimiting.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SecurityPolicyRuleRateLimitOptions.Builder	newBuilder()
static SecurityPolicyRuleRateLimitOptions.Builder	newBuilder(SecurityPolicyRuleRateLimitOptions prototype)
SecurityPolicyRuleRateLimitOptions.Builder	newBuilderForType()
protected SecurityPolicyRuleRateLimitOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SecurityPolicyRuleRateLimitOptions	parseDelimitedFrom(InputStream input)
static SecurityPolicyRuleRateLimitOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SecurityPolicyRuleRateLimitOptions	parseFrom(byte[] data)
static SecurityPolicyRuleRateLimitOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SecurityPolicyRuleRateLimitOptions	parseFrom(ByteBuffer data)
static SecurityPolicyRuleRateLimitOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SecurityPolicyRuleRateLimitOptions	parseFrom(com.google.protobuf.ByteString data)
static SecurityPolicyRuleRateLimitOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SecurityPolicyRuleRateLimitOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static SecurityPolicyRuleRateLimitOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SecurityPolicyRuleRateLimitOptions	parseFrom(InputStream input)
static SecurityPolicyRuleRateLimitOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SecurityPolicyRuleRateLimitOptions>	parser()
SecurityPolicyRuleRateLimitOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BAN_DURATION_SEC_FIELD_NUMBER

public static final int BAN_DURATION_SEC_FIELD_NUMBER

See Also:

Constant Field Values

BAN_THRESHOLD_FIELD_NUMBER

public static final int BAN_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

CONFORM_ACTION_FIELD_NUMBER

public static final int CONFORM_ACTION_FIELD_NUMBER

See Also:

Constant Field Values

ENFORCE_ON_KEY_FIELD_NUMBER

public static final int ENFORCE_ON_KEY_FIELD_NUMBER

See Also:

Constant Field Values

ENFORCE_ON_KEY_CONFIGS_FIELD_NUMBER

public static final int ENFORCE_ON_KEY_CONFIGS_FIELD_NUMBER

See Also:

Constant Field Values

ENFORCE_ON_KEY_NAME_FIELD_NUMBER

public static final int ENFORCE_ON_KEY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

EXCEED_ACTION_FIELD_NUMBER

public static final int EXCEED_ACTION_FIELD_NUMBER

See Also:

Constant Field Values

EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER

public static final int EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

RATE_LIMIT_THRESHOLD_FIELD_NUMBER

public static final int RATE_LIMIT_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasBanDurationSec

public boolean hasBanDurationSec()

 Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
 

optional int32 ban_duration_sec = 42896726;

Specified by:

hasBanDurationSec in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the banDurationSec field is set.

getBanDurationSec

public int getBanDurationSec()

 Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
 

optional int32 ban_duration_sec = 42896726;

Specified by:

getBanDurationSec in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The banDurationSec.

hasBanThreshold

public boolean hasBanThreshold()

 Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold ban_threshold = 501208123;

Specified by:

hasBanThreshold in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the banThreshold field is set.

getBanThreshold

public SecurityPolicyRuleRateLimitOptionsThreshold getBanThreshold()

 Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold ban_threshold = 501208123;

Specified by:

getBanThreshold in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The banThreshold.

getBanThresholdOrBuilder

public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getBanThresholdOrBuilder()

 Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold ban_threshold = 501208123;

Specified by:

getBanThresholdOrBuilder in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

hasConformAction

public boolean hasConformAction()

 Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
 

optional string conform_action = 517612367;

Specified by:

hasConformAction in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the conformAction field is set.

getConformAction

public String getConformAction()

 Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
 

optional string conform_action = 517612367;

Specified by:

getConformAction in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The conformAction.

getConformActionBytes

public com.google.protobuf.ByteString getConformActionBytes()

 Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
 

optional string conform_action = 517612367;

Specified by:

getConformActionBytes in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The bytes for conformAction.

hasEnforceOnKey

public boolean hasEnforceOnKey()

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

optional string enforce_on_key = 416648956;

Specified by:

hasEnforceOnKey in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the enforceOnKey field is set.

getEnforceOnKey

public String getEnforceOnKey()

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

optional string enforce_on_key = 416648956;

Specified by:

getEnforceOnKey in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The enforceOnKey.

getEnforceOnKeyBytes

public com.google.protobuf.ByteString getEnforceOnKeyBytes()

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

optional string enforce_on_key = 416648956;

Specified by:

getEnforceOnKeyBytes in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The bytes for enforceOnKey.

getEnforceOnKeyConfigsList

public List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> getEnforceOnKeyConfigsList()

 If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
 

repeated .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig enforce_on_key_configs = 33906478;

Specified by:

getEnforceOnKeyConfigsList in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

getEnforceOnKeyConfigsOrBuilderList

public List<? extends SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder> getEnforceOnKeyConfigsOrBuilderList()

 If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
 

repeated .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig enforce_on_key_configs = 33906478;

Specified by:

getEnforceOnKeyConfigsOrBuilderList in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

getEnforceOnKeyConfigsCount

public int getEnforceOnKeyConfigsCount()

 If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
 

repeated .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig enforce_on_key_configs = 33906478;

Specified by:

getEnforceOnKeyConfigsCount in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

getEnforceOnKeyConfigs

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getEnforceOnKeyConfigs(int index)

 If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
 

repeated .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig enforce_on_key_configs = 33906478;

Specified by:

getEnforceOnKeyConfigs in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

getEnforceOnKeyConfigsOrBuilder

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder getEnforceOnKeyConfigsOrBuilder(int index)

 If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
 

repeated .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig enforce_on_key_configs = 33906478;

Specified by:

getEnforceOnKeyConfigsOrBuilder in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

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;

Specified by:

hasEnforceOnKeyName in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the enforceOnKeyName field is set.

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;

Specified by:

getEnforceOnKeyName in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The enforceOnKeyName.

getEnforceOnKeyNameBytes

public com.google.protobuf.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;

Specified by:

getEnforceOnKeyNameBytes in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The bytes for enforceOnKeyName.

hasExceedAction

public boolean hasExceedAction()

 Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
 

optional string exceed_action = 167159073;

Specified by:

hasExceedAction in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the exceedAction field is set.

getExceedAction

public String getExceedAction()

 Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
 

optional string exceed_action = 167159073;

Specified by:

getExceedAction in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The exceedAction.

getExceedActionBytes

public com.google.protobuf.ByteString getExceedActionBytes()

 Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
 

optional string exceed_action = 167159073;

Specified by:

getExceedActionBytes in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The bytes for exceedAction.

hasExceedRedirectOptions

public boolean hasExceedRedirectOptions()

 Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions exceed_redirect_options = 473646694;

Specified by:

hasExceedRedirectOptions in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the exceedRedirectOptions field is set.

getExceedRedirectOptions

public SecurityPolicyRuleRedirectOptions getExceedRedirectOptions()

 Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions exceed_redirect_options = 473646694;

Specified by:

getExceedRedirectOptions in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The exceedRedirectOptions.

getExceedRedirectOptionsOrBuilder

public SecurityPolicyRuleRedirectOptionsOrBuilder getExceedRedirectOptionsOrBuilder()

 Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions exceed_redirect_options = 473646694;

Specified by:

getExceedRedirectOptionsOrBuilder in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

hasRateLimitThreshold

public boolean hasRateLimitThreshold()

 Threshold at which to begin ratelimiting.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;

Specified by:

hasRateLimitThreshold in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

Whether the rateLimitThreshold field is set.

getRateLimitThreshold

public SecurityPolicyRuleRateLimitOptionsThreshold getRateLimitThreshold()

 Threshold at which to begin ratelimiting.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;

Specified by:

getRateLimitThreshold in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

Returns:

The rateLimitThreshold.

getRateLimitThresholdOrBuilder

public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getRateLimitThresholdOrBuilder()

 Threshold at which to begin ratelimiting.
 

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;

Specified by:

getRateLimitThresholdOrBuilder in interface SecurityPolicyRuleRateLimitOptionsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static SecurityPolicyRuleRateLimitOptions parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static SecurityPolicyRuleRateLimitOptions parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static SecurityPolicyRuleRateLimitOptions parseFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

newBuilderForType

public SecurityPolicyRuleRateLimitOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SecurityPolicyRuleRateLimitOptions.Builder newBuilder()

newBuilder

public static SecurityPolicyRuleRateLimitOptions.Builder newBuilder(SecurityPolicyRuleRateLimitOptions prototype)

toBuilder

public SecurityPolicyRuleRateLimitOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SecurityPolicyRuleRateLimitOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SecurityPolicyRuleRateLimitOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<SecurityPolicyRuleRateLimitOptions> parser()

getParserForType

public com.google.protobuf.Parser<SecurityPolicyRuleRateLimitOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SecurityPolicyRuleRateLimitOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder