Class SecurityPolicyRuleRateLimitOptions.Builder (1.59.0) 

public static final class SecurityPolicyRuleRateLimitOptions.Builder extends GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder> implements SecurityPolicyRuleRateLimitOptionsOrBuilder

Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecurityPolicyRuleRateLimitOptions.Builder

Static Methods

getDescriptor()

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

Methods

addAllEnforceOnKeyConfigs(Iterable<? extends SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> values)

public SecurityPolicyRuleRateLimitOptions.Builder addAllEnforceOnKeyConfigs(Iterable<? extends SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> values)

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;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

addEnforceOnKeyConfigs(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig value)

public SecurityPolicyRuleRateLimitOptions.Builder addEnforceOnKeyConfigs(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig value)

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;

Parameter
Name Description
value SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

addEnforceOnKeyConfigs(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder builderForValue)

public SecurityPolicyRuleRateLimitOptions.Builder addEnforceOnKeyConfigs(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

addEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig value)

public SecurityPolicyRuleRateLimitOptions.Builder addEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig value)

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;

Parameters
Name Description
index int
value SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

addEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder builderForValue)

public SecurityPolicyRuleRateLimitOptions.Builder addEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

addEnforceOnKeyConfigsBuilder()

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder addEnforceOnKeyConfigsBuilder()

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

addEnforceOnKeyConfigsBuilder(int index)

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder addEnforceOnKeyConfigsBuilder(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;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SecurityPolicyRuleRateLimitOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

build()

public SecurityPolicyRuleRateLimitOptions build()
Returns
Type Description
SecurityPolicyRuleRateLimitOptions

buildPartial()

public SecurityPolicyRuleRateLimitOptions buildPartial()
Returns
Type Description
SecurityPolicyRuleRateLimitOptions

clear()

public SecurityPolicyRuleRateLimitOptions.Builder clear()
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

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

This builder for chaining.

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

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

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

optional string enforce_on_key = 416648956;

Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

clearEnforceOnKeyConfigs()

public SecurityPolicyRuleRateLimitOptions.Builder clearEnforceOnKeyConfigs()

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

clearEnforceOnKeyName()

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

This builder for chaining.

clearExceedAction()

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

Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

clearExceedRedirectOptions()

public SecurityPolicyRuleRateLimitOptions.Builder clearExceedRedirectOptions()

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

clearField(Descriptors.FieldDescriptor field)

public SecurityPolicyRuleRateLimitOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SecurityPolicyRuleRateLimitOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

clearRateLimitThreshold()

public SecurityPolicyRuleRateLimitOptions.Builder clearRateLimitThreshold()

Threshold at which to begin ratelimiting.

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

Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

clone()

public SecurityPolicyRuleRateLimitOptions.Builder clone()
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

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;

Returns
Type Description
int

The banDurationSec.

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsThreshold

The banThreshold.

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsThreshold.Builder

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;

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder

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;

Returns
Type Description
String

The conformAction.

getConformActionBytes()

public 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;

Returns
Type Description
ByteString

The bytes for conformAction.

getDefaultInstanceForType()

public SecurityPolicyRuleRateLimitOptions getDefaultInstanceForType()
Returns
Type Description
SecurityPolicyRuleRateLimitOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

optional string enforce_on_key = 416648956;

Returns
Type Description
String

The enforceOnKey.

getEnforceOnKeyBytes()

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

optional string enforce_on_key = 416648956;

Returns
Type Description
ByteString

The bytes for enforceOnKey.

getEnforceOnKeyConfigs(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

getEnforceOnKeyConfigsBuilder(int index)

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder getEnforceOnKeyConfigsBuilder(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;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

getEnforceOnKeyConfigsBuilderList()

public List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder> getEnforceOnKeyConfigsBuilderList()

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;

Returns
Type Description
List<Builder>

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;

Returns
Type Description
int

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;

Returns
Type Description
List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>

getEnforceOnKeyConfigsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder

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;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder>

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.

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;

Returns
Type Description
String

The exceedAction.

getExceedActionBytes()

public 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;

Returns
Type Description
ByteString

The bytes for exceedAction.

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;

Returns
Type Description
SecurityPolicyRuleRedirectOptions

The exceedRedirectOptions.

getExceedRedirectOptionsBuilder()

public SecurityPolicyRuleRedirectOptions.Builder getExceedRedirectOptionsBuilder()

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;

Returns
Type Description
SecurityPolicyRuleRedirectOptions.Builder

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;

Returns
Type Description
SecurityPolicyRuleRedirectOptionsOrBuilder

getRateLimitThreshold()

public SecurityPolicyRuleRateLimitOptionsThreshold getRateLimitThreshold()

Threshold at which to begin ratelimiting.

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

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsThreshold

The rateLimitThreshold.

getRateLimitThresholdBuilder()

public SecurityPolicyRuleRateLimitOptionsThreshold.Builder getRateLimitThresholdBuilder()

Threshold at which to begin ratelimiting.

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

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsThreshold.Builder

getRateLimitThresholdOrBuilder()

public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getRateLimitThresholdOrBuilder()

Threshold at which to begin ratelimiting.

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

Returns
Type Description
SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder

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;

Returns
Type Description
boolean

Whether the banDurationSec field is set.

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;

Returns
Type Description
boolean

Whether the banThreshold field is set.

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;

Returns
Type Description
boolean

Whether the conformAction field is set.

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

optional string enforce_on_key = 416648956;

Returns
Type Description
boolean

Whether the enforceOnKey field is set.

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.

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;

Returns
Type Description
boolean

Whether the exceedAction field is set.

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;

Returns
Type Description
boolean

Whether the exceedRedirectOptions field is set.

hasRateLimitThreshold()

public boolean hasRateLimitThreshold()

Threshold at which to begin ratelimiting.

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

Returns
Type Description
boolean

Whether the rateLimitThreshold field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

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;

Parameter
Name Description
value SecurityPolicyRuleRateLimitOptionsThreshold
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

mergeExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)

public SecurityPolicyRuleRateLimitOptions.Builder mergeExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)

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;

Parameter
Name Description
value SecurityPolicyRuleRedirectOptions
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

mergeFrom(SecurityPolicyRuleRateLimitOptions other)

public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(SecurityPolicyRuleRateLimitOptions other)
Parameter
Name Description
other SecurityPolicyRuleRateLimitOptions
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

mergeRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

public SecurityPolicyRuleRateLimitOptions.Builder mergeRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

Threshold at which to begin ratelimiting.

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

Parameter
Name Description
value SecurityPolicyRuleRateLimitOptionsThreshold
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SecurityPolicyRuleRateLimitOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

removeEnforceOnKeyConfigs(int index)

public SecurityPolicyRuleRateLimitOptions.Builder removeEnforceOnKeyConfigs(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;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setBanDurationSec(int value)

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;

Parameter
Name Description
value int

The banDurationSec to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

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;

Parameter
Name Description
value SecurityPolicyRuleRateLimitOptionsThreshold
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SecurityPolicyRuleRateLimitOptionsThreshold.Builder
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setConformAction(String value)

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;

Parameter
Name Description
value String

The conformAction to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setConformActionBytes(ByteString value)

public SecurityPolicyRuleRateLimitOptions.Builder setConformActionBytes(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;

Parameter
Name Description
value ByteString

The bytes for conformAction to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setEnforceOnKey(String value)

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

optional string enforce_on_key = 416648956;

Parameter
Name Description
value String

The enforceOnKey to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setEnforceOnKeyBytes(ByteString value)

public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyBytes(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. - 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 EnforceOnKey enum for the list of possible values.

optional string enforce_on_key = 416648956;

Parameter
Name Description
value ByteString

The bytes for enforceOnKey to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig value)

public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig value)

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;

Parameters
Name Description
index int
value SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder builderForValue)

public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyConfigs(int index, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setEnforceOnKeyName(String value)

public 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. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

optional string enforce_on_key_name = 132555246;

Parameter
Name Description
value String

The enforceOnKeyName to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setEnforceOnKeyNameBytes(ByteString value)

public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyNameBytes(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. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

optional string enforce_on_key_name = 132555246;

Parameter
Name Description
value ByteString

The bytes for enforceOnKeyName to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setExceedAction(String value)

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

Parameter
Name Description
value String

The exceedAction to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setExceedActionBytes(ByteString value)

public SecurityPolicyRuleRateLimitOptions.Builder setExceedActionBytes(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. 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;

Parameter
Name Description
value ByteString

The bytes for exceedAction to set.
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

This builder for chaining.

setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)

public SecurityPolicyRuleRateLimitOptions.Builder setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)

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;

Parameter
Name Description
value SecurityPolicyRuleRedirectOptions
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions.Builder builderForValue)

public SecurityPolicyRuleRateLimitOptions.Builder setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SecurityPolicyRuleRedirectOptions.Builder
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SecurityPolicyRuleRateLimitOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

public SecurityPolicyRuleRateLimitOptions.Builder setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)

Threshold at which to begin ratelimiting.

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

Parameter
Name Description
value SecurityPolicyRuleRateLimitOptionsThreshold
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)

public SecurityPolicyRuleRateLimitOptions.Builder setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)

Threshold at which to begin ratelimiting.

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

Parameter
Name Description
builderForValue SecurityPolicyRuleRateLimitOptionsThreshold.Builder
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SecurityPolicyRuleRateLimitOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SecurityPolicyRuleRateLimitOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityPolicyRuleRateLimitOptions.Builder
Overrides