FaunaRole (fauna-jvm 1.0.0 API)

java.lang.Object
- com.fauna.client.FaunaRole

public final class FaunaRole
extends java.lang.Object

Built-in roles defined at: docs.fauna.com.

Field Summary

Fields
Modifier and Type Field Description

static FaunaRole ADMIN

static FaunaRole SERVER

static FaunaRole SERVER_READ_ONLY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FaunaRole`	`named(java.lang.String name)`	Creates a `FaunaRole` with the desired name prepended with `@role/`.
`java.lang.String`	`toString()`
`static void`	`validateRoleName(java.lang.String name)`	Validates a role name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ADMIN
```
public static final FaunaRole ADMIN
```
  - SERVER
```
public static final FaunaRole SERVER
```
  - SERVER_READ_ONLY
```
public static final FaunaRole SERVER_READ_ONLY
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of the FaunaRole.
  - validateRoleName
```
public static void validateRoleName(java.lang.String name)
```
    Validates a role name.
    
    Parameters:
    
    name - The name of the role to validate.
  - named
```
public static FaunaRole named(java.lang.String name)
```
    Creates a FaunaRole with the desired name prepended with @role/.
    
    Parameters:
    
    name - The name of the role to use.
    
    Returns:
    
    A FaunaRole instance.