com.google.api.services.compute.model

Class SecurityPolicyRuleRateLimitOptions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.SecurityPolicyRuleRateLimitOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SecurityPolicyRuleRateLimitOptions
extends GenericJson

Model definition for SecurityPolicyRuleRateLimitOptions.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SecurityPolicyRuleRateLimitOptions()

Method Summary

Modifier and Type	Method and Description
SecurityPolicyRuleRateLimitOptions	clone()
Integer	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".
Integer	getBlockDuration() 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 blocked by the rate limit after the rate falls below the threshold.
String	getConformAction() Action to take when requests are under the given threshold.
String	getEnforceOnKey() Determines the key to enforce the threshold_rps limit on.
String	getExceedAction() When a request is denied, returns the HTTP response code specified.
SecurityPolicyRuleRateLimitOptionsThreshold	getRateLimitThreshold() Threshold at which to begin ratelimiting.
Integer	getThresholdRps() Rate in requests per second at which to begin ratelimiting.
SecurityPolicyRuleRateLimitOptions	set(String fieldName, Object value)
SecurityPolicyRuleRateLimitOptions	setBanDurationSec(Integer banDurationSec) Can only be specified if the action for the rule is "rate_based_ban".
SecurityPolicyRuleRateLimitOptions	setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold banThreshold) Can only be specified if the action for the rule is "rate_based_ban".
SecurityPolicyRuleRateLimitOptions	setBlockDuration(Integer blockDuration) 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 blocked by the rate limit after the rate falls below the threshold.
SecurityPolicyRuleRateLimitOptions	setConformAction(String conformAction) Action to take when requests are under the given threshold.
SecurityPolicyRuleRateLimitOptions	setEnforceOnKey(String enforceOnKey) Determines the key to enforce the threshold_rps limit on.
SecurityPolicyRuleRateLimitOptions	setExceedAction(String exceedAction) When a request is denied, returns the HTTP response code specified.
SecurityPolicyRuleRateLimitOptions	setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold rateLimitThreshold) Threshold at which to begin ratelimiting.
SecurityPolicyRuleRateLimitOptions	setThresholdRps(Integer thresholdRps) Rate in requests per second at which to begin ratelimiting.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SecurityPolicyRuleRateLimitOptions

public SecurityPolicyRuleRateLimitOptions()

Method Detail

getBanDurationSec

public Integer getBanDurationSec()

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' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Returns:

value or null for none

setBanDurationSec

public SecurityPolicyRuleRateLimitOptions setBanDurationSec(Integer banDurationSec)

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' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Parameters:

banDurationSec - banDurationSec or null for none

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' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Returns:

value or null for none

setBanThreshold

public SecurityPolicyRuleRateLimitOptions setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold banThreshold)

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' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Parameters:

banThreshold - banThreshold or null for none

getBlockDuration

public Integer getBlockDuration()

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 blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. [Deprecated] This field is deprecated.

Returns:

value or null for none

setBlockDuration

public SecurityPolicyRuleRateLimitOptions setBlockDuration(Integer blockDuration)

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 blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. [Deprecated] This field is deprecated.

Parameters:

blockDuration - blockDuration or null for none

getConformAction

public String getConformAction()

Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload".

Returns:

value or null for none

setConformAction

public SecurityPolicyRuleRateLimitOptions setConformAction(String conformAction)

Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload".

Parameters:

conformAction - conformAction or null for none

getEnforceOnKey

public String getEnforceOnKey()

Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule.

Returns:

value or null for none

setEnforceOnKey

public SecurityPolicyRuleRateLimitOptions setEnforceOnKey(String enforceOnKey)

Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule.

Parameters:

enforceOnKey - enforceOnKey or null for none

getExceedAction

public String getExceedAction()

When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.

Returns:

value or null for none

setExceedAction

public SecurityPolicyRuleRateLimitOptions setExceedAction(String exceedAction)

When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.

Parameters:

exceedAction - exceedAction or null for none

getRateLimitThreshold

public SecurityPolicyRuleRateLimitOptionsThreshold getRateLimitThreshold()

Threshold at which to begin ratelimiting.

Returns:

value or null for none

setRateLimitThreshold

public SecurityPolicyRuleRateLimitOptions setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold rateLimitThreshold)

Threshold at which to begin ratelimiting.

Parameters:

rateLimitThreshold - rateLimitThreshold or null for none

getThresholdRps

public Integer getThresholdRps()

Rate in requests per second at which to begin ratelimiting. [Deprecated] This field is deprecated.

Returns:

value or null for none

setThresholdRps

public SecurityPolicyRuleRateLimitOptions setThresholdRps(Integer thresholdRps)

Rate in requests per second at which to begin ratelimiting. [Deprecated] This field is deprecated.

Parameters:

thresholdRps - thresholdRps or null for none

set

public SecurityPolicyRuleRateLimitOptions set(String fieldName,
                                              Object value)

Overrides:

set in class GenericJson

clone

public SecurityPolicyRuleRateLimitOptions clone()

Overrides:

clone in class GenericJson