RateLimitingPolicy¶
- class oci.apigateway.models.RateLimitingPolicy(**kwargs)¶
Bases:
objectLimit the number of requests that should be handled for the specified window using a specfic key.
Attributes:
A constant which can be used with the rate_key property of a RateLimitingPolicy.
A constant which can be used with the rate_key property of a RateLimitingPolicy.
[Required] Gets the rate_in_requests_per_second of this RateLimitingPolicy.
[Required] Gets the rate_key of this RateLimitingPolicy.
Methods:
__init__(**kwargs)Initializes a new RateLimitingPolicy object with values from keyword arguments.
- RATE_KEY_CLIENT_IP = 'CLIENT_IP'¶
A constant which can be used with the rate_key property of a RateLimitingPolicy. This constant has a value of “CLIENT_IP”
- RATE_KEY_TOTAL = 'TOTAL'¶
A constant which can be used with the rate_key property of a RateLimitingPolicy. This constant has a value of “TOTAL”
- __init__(**kwargs)¶
Initializes a new RateLimitingPolicy object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
rate_in_requests_per_second (int) – The value to assign to the rate_in_requests_per_second property of this RateLimitingPolicy.
rate_key (str) – The value to assign to the rate_key property of this RateLimitingPolicy. Allowed values for this property are: “CLIENT_IP”, “TOTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property rate_in_requests_per_second¶
[Required] Gets the rate_in_requests_per_second of this RateLimitingPolicy. The maximum number of requests per second to allow.
- Returns
The rate_in_requests_per_second of this RateLimitingPolicy.
- Return type
int
- property rate_key¶
[Required] Gets the rate_key of this RateLimitingPolicy. The key used to group requests together.
Allowed values for this property are: “CLIENT_IP”, “TOTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The rate_key of this RateLimitingPolicy.
- Return type
str