# `Aerospike.Role`
[🔗](https://github.com/luisgabrielroldan/aerospike_driver/blob/v0.3.1/lib/aerospike/role.ex#L1)

Security role as returned by Aerospike role metadata queries.

# `quota`

```elixir
@type quota() :: non_neg_integer()
```

Maximum operations per second for a role. `0` means unlimited.

# `t`

```elixir
@type t() :: %Aerospike.Role{
  name: String.t(),
  privileges: [Aerospike.Privilege.t()],
  read_quota: quota(),
  whitelist: whitelist(),
  write_quota: quota()
}
```

Security role metadata returned by role queries.

Quotas are operations-per-second limits reported by the server. A quota of
`0` means unlimited.

# `whitelist`

```elixir
@type whitelist() :: [String.t()]
```

List of whitelisted client addresses for a role.

---

*Consult [api-reference.md](api-reference.md) for complete listing*