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 com.google.api.client.json.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

com.google.api.client.util.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".
String	getConformAction() Action to take for requests that are under the configured rate limit threshold.
String	getEnforceOnKey() Determines the key to enforce the rate_limit_threshold on.
List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>	getEnforceOnKeyConfigs() If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced.
String	getEnforceOnKeyName() Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value.
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.
SecurityPolicyRuleRedirectOptions	getExceedRedirectOptions() Parameters defining the redirect action that is used as the exceed action.
SecurityPolicyRuleRateLimitOptionsThreshold	getRateLimitThreshold() Threshold 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	setConformAction(String conformAction) Action to take for requests that are under the configured rate limit threshold.
SecurityPolicyRuleRateLimitOptions	setEnforceOnKey(String enforceOnKey) Determines the key to enforce the rate_limit_threshold on.
SecurityPolicyRuleRateLimitOptions	setEnforceOnKeyConfigs(List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> enforceOnKeyConfigs) 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.
SecurityPolicyRuleRateLimitOptions	setEnforceOnKeyName(String enforceOnKeyName) 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	setExceedAction(String exceedAction) 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	setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions exceedRedirectOptions) Parameters defining the redirect action that is used as the exceed action.
SecurityPolicyRuleRateLimitOptions	setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold rateLimitThreshold) Threshold 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, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the 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, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the 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_sec' 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_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Parameters:

banThreshold - banThreshold or null for none

getConformAction

public String getConformAction()

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

Returns:

value or null for none

setConformAction

public SecurityPolicyRuleRateLimitOptions setConformAction(String conformAction)

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

Parameters:

conformAction - conformAction or null for none

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.

Returns:

value or null for none

setEnforceOnKey

public SecurityPolicyRuleRateLimitOptions setEnforceOnKey(String enforceOnKey)

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.

Parameters:

enforceOnKey - enforceOnKey or null for none

getEnforceOnKeyConfigs

public List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> getEnforceOnKeyConfigs()

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.

Returns:

value or null for none

setEnforceOnKeyConfigs

public SecurityPolicyRuleRateLimitOptions setEnforceOnKeyConfigs(List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> enforceOnKeyConfigs)

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.

Parameters:

enforceOnKeyConfigs - enforceOnKeyConfigs or null for none

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.

Returns:

value or null for none

setEnforceOnKeyName

public SecurityPolicyRuleRateLimitOptions setEnforceOnKeyName(String enforceOnKeyName)

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.

Parameters:

enforceOnKeyName - enforceOnKeyName or null for none

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.

Returns:

value or null for none

setExceedAction

public SecurityPolicyRuleRateLimitOptions setExceedAction(String exceedAction)

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.

Parameters:

exceedAction - exceedAction or null for none

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.

Returns:

value or null for none

setExceedRedirectOptions

public SecurityPolicyRuleRateLimitOptions setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions exceedRedirectOptions)

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.

Parameters:

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

set

public SecurityPolicyRuleRateLimitOptions set(String fieldName,
                                              Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SecurityPolicyRuleRateLimitOptions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson