File: RateLimitQuotasWriteRequest.md

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (28 lines) | stat: -rw-r--r-- 1,324 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# OpenbaoClient::RateLimitQuotasWriteRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **block_interval** | **Integer** | If set, when a client reaches a rate limit threshold, the client will be prohibited from any further requests until after the 'block_interval' has elapsed. | [optional] |
| **interval** | **Integer** | The duration to enforce rate limiting for (default '1s'). | [optional] |
| **path** | **String** | Path of the mount or namespace to apply the quota. A blank path configures a global quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. | [optional] |
| **rate** | **Float** | The maximum number of requests in a given interval to be allowed by the quota rule. The 'rate' must be positive. | [optional] |
| **role** | **String** | Login role to apply this quota to. Note that when set, path must be configured to a valid auth method with a concept of roles. | [optional] |
| **type** | **String** | Type of the quota rule. | [optional] |

## Example

```ruby
require 'openbao_client'

instance = OpenbaoClient::RateLimitQuotasWriteRequest.new(
  block_interval: null,
  interval: null,
  path: null,
  rate: null,
  role: null,
  type: null
)
```