Class: Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptions
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptions
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Instance Attribute Summary collapse
-
#ban_duration_sec ⇒ Fixnum
Can only be specified if the action for the rule is "rate_based_ban".
-
#ban_threshold ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptionsThreshold
Can only be specified if the action for the rule is "rate_based_ban".
-
#conform_action ⇒ String
Action to take for requests that are under the configured rate limit threshold.
-
#enforce_on_key ⇒ String
Determines the key to enforce the rate_limit_threshold on.
-
#enforce_on_key_name ⇒ 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.
-
#exceed_action ⇒ 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.
-
#exceed_action_rpc_status ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptionsRpcStatus
Simplified google.rpc.Status type (omitting details).
-
#exceed_redirect_options ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRedirectOptions
Parameters defining the redirect action that is used as the exceed action.
-
#rate_limit_threshold ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptionsThreshold
Threshold at which to begin ratelimiting.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SecurityPolicyRuleRateLimitOptions
constructor
A new instance of SecurityPolicyRuleRateLimitOptions.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SecurityPolicyRuleRateLimitOptions
Returns a new instance of SecurityPolicyRuleRateLimitOptions.
39810 39811 39812 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39810 def initialize(**args) update!(**args) end |
Instance Attribute Details
#ban_duration_sec ⇒ Fixnum
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.
Corresponds to the JSON property banDurationSec
39743 39744 39745 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39743 def ban_duration_sec @ban_duration_sec end |
#ban_threshold ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptionsThreshold
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'.
Corresponds to the JSON property banThreshold
39751 39752 39753 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39751 def ban_threshold @ban_threshold end |
#conform_action ⇒ String
Action to take for requests that are under the configured rate limit threshold.
Valid option is "allow" only.
Corresponds to the JSON property conformAction
39757 39758 39759 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39757 def conform_action @conform_action end |
#enforce_on_key ⇒ 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.
Corresponds to the JSON property
enforceOnKey
39776 39777 39778 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39776 def enforce_on_key @enforce_on_key end |
#enforce_on_key_name ⇒ 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.
Corresponds to the JSON property enforceOnKeyName
39783 39784 39785 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39783 def enforce_on_key_name @enforce_on_key_name end |
#exceed_action ⇒ 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.
Corresponds to the JSON property exceedAction
39792 39793 39794 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39792 def exceed_action @exceed_action end |
#exceed_action_rpc_status ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptionsRpcStatus
Simplified google.rpc.Status type (omitting details).
Corresponds to the JSON property exceedActionRpcStatus
39797 39798 39799 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39797 def exceed_action_rpc_status @exceed_action_rpc_status end |
#exceed_redirect_options ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRedirectOptions
Parameters defining the redirect action that is used as the exceed action.
Cannot be specified if the exceed action is not redirect.
Corresponds to the JSON property exceedRedirectOptions
39803 39804 39805 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39803 def @exceed_redirect_options end |
#rate_limit_threshold ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptionsThreshold
Threshold at which to begin ratelimiting.
Corresponds to the JSON property rateLimitThreshold
39808 39809 39810 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39808 def rate_limit_threshold @rate_limit_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
39815 39816 39817 39818 39819 39820 39821 39822 39823 39824 39825 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39815 def update!(**args) @ban_duration_sec = args[:ban_duration_sec] if args.key?(:ban_duration_sec) @ban_threshold = args[:ban_threshold] if args.key?(:ban_threshold) @conform_action = args[:conform_action] if args.key?(:conform_action) @enforce_on_key = args[:enforce_on_key] if args.key?(:enforce_on_key) @enforce_on_key_name = args[:enforce_on_key_name] if args.key?(:enforce_on_key_name) @exceed_action = args[:exceed_action] if args.key?(:exceed_action) @exceed_action_rpc_status = args[:exceed_action_rpc_status] if args.key?(:exceed_action_rpc_status) @exceed_redirect_options = args[:exceed_redirect_options] if args.key?(:exceed_redirect_options) @rate_limit_threshold = args[:rate_limit_threshold] if args.key?(:rate_limit_threshold) end |