All Implemented Interfaces:: com.openai.core.Params


public final class RoleCreateParams
 implements Params

Creates a custom role for a project.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RoleCreateParams.Builder`	A builder for RoleCreateParams.
`public final class`	`RoleCreateParams.Body`	Request payload for creating a custom 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 Optional<String>`	`projectId()`
`final List<String>`	`permissions()`	Permissions to grant to the role.
`final String`	`roleName()`	Unique name for the role.
`final Optional<String>`	`description()`	Optional description of the role.
`final JsonField<List<String>>`	`_permissions()`	Returns the raw JSON value of permissions.
`final JsonField<String>`	`_roleName()`	Returns the raw JSON value of roleName.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final RoleCreateParams.Builder`	`toBuilder()`
`final RoleCreateParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RoleCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RoleCreateParams.

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

- Constructor Detail
- Method Detail
  - projectId
```
 final Optional<String> projectId()
```
  - permissions
```
 final List<String> permissions()
```
    Permissions to grant to the role.
  - roleName
```
 final String roleName()
```
    Unique name for the role.
  - description
```
 final Optional<String> description()
```
    Optional description of the role.
  - _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.
  - _roleName
```
 final JsonField<String> _roleName()
```
    Returns the raw JSON value of roleName.
    Unlike roleName, 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.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final RoleCreateParams.Builder toBuilder()
```
  - _body
```
 final RoleCreateParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RoleCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of RoleCreateParams.
    The following fields are required:
    .permissions() .roleName()

Class RoleCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

projectId

permissions

roleName

description

_permissions

_roleName

_description

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder