Class SecurityPolicyRuleRateLimitOptions

Inheritance
System.Object
SecurityPolicyRuleRateLimitOptions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Compute.v1.Data
Assembly: Google.Apis.Compute.v1.dll
Syntax
public class SecurityPolicyRuleRateLimitOptions : IDirectResponseSchema

Properties

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.

Declaration
[JsonProperty("banDurationSec")]
public virtual int? BanDurationSec { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

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

Declaration
[JsonProperty("banThreshold")]
public virtual SecurityPolicyRuleRateLimitOptionsThreshold BanThreshold { get; set; }
Property Value
Type Description
SecurityPolicyRuleRateLimitOptionsThreshold

ConformAction

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

Declaration
[JsonProperty("conformAction")]
public virtual string ConformAction { get; set; }
Property Value
Type Description
System.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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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.

Declaration
[JsonProperty("enforceOnKey")]
public virtual string EnforceOnKey { get; set; }
Property Value
Type Description
System.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.

Declaration
[JsonProperty("enforceOnKeyName")]
public virtual string EnforceOnKeyName { get; set; }
Property Value
Type Description
System.String

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.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.

Declaration
[JsonProperty("exceedAction")]
public virtual string ExceedAction { get; set; }
Property Value
Type Description
System.String

ExceedRedirectOptions

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.

Declaration
[JsonProperty("exceedRedirectOptions")]
public virtual SecurityPolicyRuleRedirectOptions ExceedRedirectOptions { get; set; }
Property Value
Type Description
SecurityPolicyRuleRedirectOptions

RateLimitThreshold

Threshold at which to begin ratelimiting.

Declaration
[JsonProperty("rateLimitThreshold")]
public virtual SecurityPolicyRuleRateLimitOptionsThreshold RateLimitThreshold { get; set; }
Property Value
Type Description
SecurityPolicyRuleRateLimitOptionsThreshold

Implements