All Implemented Interfaces:
```
public final class Role

                    
```
Details about a role that can be assigned through the public Roles API.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Role.Builder`	A builder for Role.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	Identifier for the role.
`final Optional<String>`	`description()`	Optional description of the role.
`final String`	`name()`	Unique name for the role.
`final JsonValue`	`_object_()`	Always `role`.
`final List<String>`	`permissions()`	Permissions granted by the role.
`final Boolean`	`predefinedRole()`	Whether the role is predefined and managed by OpenAI.
`final String`	`resourceType()`	Resource type the role is bound to (for example `api.organization` or `api.project`).
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<List<String>>`	`_permissions()`	Returns the raw JSON value of permissions.
`final JsonField<Boolean>`	`_predefinedRole()`	Returns the raw JSON value of predefinedRole.
`final JsonField<String>`	`_resourceType()`	Returns the raw JSON value of resourceType.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final Role.Builder`	`toBuilder()`
`final Role`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Role.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Role.

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

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    Identifier for the role.
  - description
```
 final Optional<String> description()
```
    Optional description of the role.
  - name
```
 final String name()
```
    Unique name for the role.
  - _object_
```
 final JsonValue _object_()
```
    Always role.
    Expected to always return the following:
    JsonValue.from("role")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - permissions
```
 final List<String> permissions()
```
    Permissions granted by the role.
  - predefinedRole
```
 final Boolean predefinedRole()
```
    Whether the role is predefined and managed by OpenAI.
  - resourceType
```
 final String resourceType()
```
    Resource type the role is bound to (for example api.organization or api.project).
  - _id
```
 final JsonField<String> _id()
```
    Returns the raw JSON value of id.
    Unlike id, this method doesn't throw if the JSON field has an unexpected type.
  - _description
```
 final JsonField<String> _description()
```
    Returns the raw JSON value of description.
    Unlike description, this method doesn't throw if the JSON field has an unexpected type.
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _permissions
```
 final JsonField<List<String>> _permissions()
```
    Returns the raw JSON value of permissions.
    Unlike permissions, this method doesn't throw if the JSON field has an unexpected type.
  - _predefinedRole
```
 final JsonField<Boolean> _predefinedRole()
```
    Returns the raw JSON value of predefinedRole.
    Unlike predefinedRole, this method doesn't throw if the JSON field has an unexpected type.
  - _resourceType
```
 final JsonField<String> _resourceType()
```
    Returns the raw JSON value of resourceType.
    Unlike resourceType, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final Role.Builder toBuilder()
```
  - validate
```
 final Role validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static Role.Builder builder()
```
    Returns a mutable builder for constructing an instance of Role.
    The following fields are required:
    .id() .description() .name() .permissions() .predefinedRole() .resourceType()

Class Role

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

description

name

_object_

permissions

predefinedRole

resourceType

_id

_description

_name

_permissions

_predefinedRole

_resourceType

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder