SecurityPolicyRuleRateLimitOptions.Builder (proto-google-cloud-compute-v1 1.21.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>
    - - com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions.Builder

All Implemented Interfaces:

SecurityPolicyRuleRateLimitOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SecurityPolicyRuleRateLimitOptions
```
public static final class SecurityPolicyRuleRateLimitOptions.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>
implements SecurityPolicyRuleRateLimitOptionsOrBuilder
```
```
 
```
Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityPolicyRuleRateLimitOptions.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SecurityPolicyRuleRateLimitOptions`	`build()`
`SecurityPolicyRuleRateLimitOptions`	`buildPartial()`
`SecurityPolicyRuleRateLimitOptions.Builder`	`clear()`
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearBanDurationSec()` Can only be specified if the action for the rule is "rate_based_ban".
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearBanThreshold()` Can only be specified if the action for the rule is "rate_based_ban".
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearConformAction()` Action to take for requests that are under the configured rate limit threshold.
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearEnforceOnKey()` Determines the key to enforce the rate_limit_threshold on.
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearEnforceOnKeyName()` 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.
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearExceedAction()` 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.
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearExceedRedirectOptions()` Parameters defining the redirect action that is used as the exceed action.
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`clearRateLimitThreshold()` Threshold at which to begin ratelimiting.
`SecurityPolicyRuleRateLimitOptions.Builder`	`clone()`
`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".
`SecurityPolicyRuleRateLimitOptionsThreshold.Builder`	`getBanThresholdBuilder()` 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.
`SecurityPolicyRuleRateLimitOptions`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`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.
`SecurityPolicyRuleRedirectOptions.Builder`	`getExceedRedirectOptionsBuilder()` 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.
`SecurityPolicyRuleRateLimitOptionsThreshold`	`getRateLimitThreshold()` Threshold at which to begin ratelimiting.
`SecurityPolicyRuleRateLimitOptionsThreshold.Builder`	`getRateLimitThresholdBuilder()` Threshold at which to begin ratelimiting.
`SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder`	`getRateLimitThresholdOrBuilder()` Threshold at which to begin ratelimiting.
`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.
`boolean`	`hasRateLimitThreshold()` Threshold at which to begin ratelimiting.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)` Can only be specified if the action for the rule is "rate_based_ban".
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)` Parameters defining the redirect action that is used as the exceed action.
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeFrom(SecurityPolicyRuleRateLimitOptions other)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)` Threshold at which to begin ratelimiting.
`SecurityPolicyRuleRateLimitOptions.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`setBanDurationSec(int value)` Can only be specified if the action for the rule is "rate_based_ban".
`SecurityPolicyRuleRateLimitOptions.Builder`	`setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)` Can only be specified if the action for the rule is "rate_based_ban".
`SecurityPolicyRuleRateLimitOptions.Builder`	`setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)` Can only be specified if the action for the rule is "rate_based_ban".
`SecurityPolicyRuleRateLimitOptions.Builder`	`setConformAction(String value)` Action to take for requests that are under the configured rate limit threshold.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setConformActionBytes(com.google.protobuf.ByteString value)` Action to take for requests that are under the configured rate limit threshold.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setEnforceOnKey(String value)` Determines the key to enforce the rate_limit_threshold on.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setEnforceOnKeyBytes(com.google.protobuf.ByteString value)` Determines the key to enforce the rate_limit_threshold on.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setEnforceOnKeyName(String value)` 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.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setEnforceOnKeyNameBytes(com.google.protobuf.ByteString value)` 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.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setExceedAction(String value)` 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.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setExceedActionBytes(com.google.protobuf.ByteString value)` 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.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions.Builder builderForValue)` Parameters defining the redirect action that is used as the exceed action.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)` Parameters defining the redirect action that is used as the exceed action.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)` Threshold at which to begin ratelimiting.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)` Threshold at which to begin ratelimiting.
`SecurityPolicyRuleRateLimitOptions.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SecurityPolicyRuleRateLimitOptions.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

clear
```
public SecurityPolicyRuleRateLimitOptions.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

getDefaultInstanceForType
```
public SecurityPolicyRuleRateLimitOptions getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public SecurityPolicyRuleRateLimitOptions build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public SecurityPolicyRuleRateLimitOptions buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public SecurityPolicyRuleRateLimitOptions.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

setField

public SecurityPolicyRuleRateLimitOptions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

clearField
```
public SecurityPolicyRuleRateLimitOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

clearOneof
```
public SecurityPolicyRuleRateLimitOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

setRepeatedField

public SecurityPolicyRuleRateLimitOptions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   int index,
                                                                   Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

addRepeatedField

public SecurityPolicyRuleRateLimitOptions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

mergeFrom
```
public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

mergeFrom

public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(SecurityPolicyRuleRateLimitOptions other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder>

mergeFrom

public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Specified by:: mergeFrom in interface com.google.protobuf.Message.Builder
Specified by:: mergeFrom in interface com.google.protobuf.MessageLite.Builder
Overrides:: mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecurityPolicyRuleRateLimitOptions.Builder>
Throws:: IOException

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.

setBanDurationSec

public SecurityPolicyRuleRateLimitOptions.Builder setBanDurationSec(int value)

 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;

Parameters:: value - The banDurationSec to set.
Returns:: This builder for chaining.

clearBanDurationSec

public SecurityPolicyRuleRateLimitOptions.Builder clearBanDurationSec()

 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;

Returns:: This builder for chaining.

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.

setBanThreshold

public SecurityPolicyRuleRateLimitOptions.Builder setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

 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;

setBanThreshold

public SecurityPolicyRuleRateLimitOptions.Builder setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)

 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;

mergeBanThreshold

public SecurityPolicyRuleRateLimitOptions.Builder mergeBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

 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;

clearBanThreshold

public SecurityPolicyRuleRateLimitOptions.Builder clearBanThreshold()

 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;

getBanThresholdBuilder

public SecurityPolicyRuleRateLimitOptionsThreshold.Builder getBanThresholdBuilder()

 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;

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.

setConformAction

public SecurityPolicyRuleRateLimitOptions.Builder setConformAction(String value)

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

optional string conform_action = 517612367;

Parameters:: value - The conformAction to set.
Returns:: This builder for chaining.

clearConformAction

public SecurityPolicyRuleRateLimitOptions.Builder clearConformAction()

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

optional string conform_action = 517612367;

Returns:: This builder for chaining.

setConformActionBytes

public SecurityPolicyRuleRateLimitOptions.Builder setConformActionBytes(com.google.protobuf.ByteString value)

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

optional string conform_action = 517612367;

Parameters:: value - The bytes for conformAction to set.
Returns:: This builder for chaining.

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.
 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.
 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.
 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.

setEnforceOnKey

public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKey(String value)

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

optional string enforce_on_key = 416648956;

Parameters:: value - The enforceOnKey to set.
Returns:: This builder for chaining.

clearEnforceOnKey

public SecurityPolicyRuleRateLimitOptions.Builder clearEnforceOnKey()

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

optional string enforce_on_key = 416648956;

Returns:: This builder for chaining.

setEnforceOnKeyBytes

public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyBytes(com.google.protobuf.ByteString value)

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

optional string enforce_on_key = 416648956;

Parameters:: value - The bytes for enforceOnKey to set.
Returns:: This builder for chaining.