Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions (v1.8.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#ban_duration_sec

def ban_duration_sec() -> ::Integer
Returns
  • (::Integer) — 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.

#ban_duration_sec=

def ban_duration_sec=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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.

#ban_threshold

def ban_threshold() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptionsThreshold
Returns

#ban_threshold=

def ban_threshold=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptionsThreshold
Parameter
Returns

#conform_action

def conform_action() -> ::String
Returns
  • (::String) — Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

#conform_action=

def conform_action=(value) -> ::String
Parameter
  • value (::String) — Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
Returns
  • (::String) — Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

#enforce_on_key

def enforce_on_key() -> ::String
Returns
  • (::String) — 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. - 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. Check the EnforceOnKey enum for the list of possible values.

#enforce_on_key=

def enforce_on_key=(value) -> ::String
Parameter
  • value (::String) — 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. - 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. Check the EnforceOnKey enum for the list of possible values.
Returns
  • (::String) — 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. - 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. Check the EnforceOnKey enum for the list of possible values.

#enforce_on_key_name

def enforce_on_key_name() -> ::String
Returns
  • (::String) — 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.

#enforce_on_key_name=

def enforce_on_key_name=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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.

#exceed_action

def exceed_action() -> ::String
Returns
  • (::String) — 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.

#exceed_action=

def exceed_action=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#exceed_redirect_options

def exceed_redirect_options() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions
Returns

#exceed_redirect_options=

def exceed_redirect_options=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions
Parameter
Returns

#rate_limit_threshold

def rate_limit_threshold() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptionsThreshold
Returns

#rate_limit_threshold=

def rate_limit_threshold=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptionsThreshold
Parameter
Returns