RateLimit¶

class oci.apigateway.models.RateLimit(**kwargs)¶

Bases: object

Rate-limiting policy for a usage plan.

Attributes

`UNIT_SECOND`	A constant which can be used with the unit property of a RateLimit.
`unit`	[Required] Gets the unit of this RateLimit.
`value`	[Required] Gets the value of this RateLimit.

Methods

__init__(**kwargs) Initializes a new RateLimit object with values from keyword arguments.

UNIT_SECOND = 'SECOND'¶: A constant which can be used with the unit property of a RateLimit. This constant has a value of “SECOND”

__init__(**kwargs)¶

Initializes a new RateLimit object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	value (int) – The value to assign to the value property of this RateLimit. unit (str) – The value to assign to the unit property of this RateLimit. Allowed values for this property are: “SECOND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

unit¶

[Required] Gets the unit of this RateLimit. The unit of time over which rate limits are calculated. Example: SECOND

Allowed values for this property are: “SECOND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The unit of this RateLimit.
Return type:	str

value¶

[Required] Gets the value of this RateLimit. The number of requests that can be made per time period.

Returns:	The value of this RateLimit.
Return type:	int