com.google.api.services.compute.model

Class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
extends com.google.api.client.json.GenericJson

Model definition for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.

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
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig()

Method Summary

Modifier and Type	Method and Description
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig	clone()
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	getEnforceOnKeyType() Determines the key to enforce the rate_limit_threshold on.
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig	set(String fieldName, Object value)
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig	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.
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig	setEnforceOnKeyType(String enforceOnKeyType) Determines the key to enforce the rate_limit_threshold on.

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

SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig()

Method Detail

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

getEnforceOnKeyType

public String getEnforceOnKeyType()

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

Returns:

value or null for none

setEnforceOnKeyType

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig setEnforceOnKeyType(String enforceOnKeyType)

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

Parameters:

enforceOnKeyType - enforceOnKeyType or null for none

set

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig set(String fieldName,
                                                                Object value)

Overrides:

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

clone

public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig clone()

Overrides:

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