Class RoleCreateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class RoleCreateParams implements Params
Creates a custom role for the organization.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRoleCreateParams.BuilderA builder for RoleCreateParams.
public final classRoleCreateParams.BodyRequest payload for creating a custom role.
-
Method Summary
Modifier and Type Method Description final List<String>permissions()Permissions to grant to the role. final StringroleName()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.BuildertoBuilder()final RoleCreateParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static RoleCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of RoleCreateParams. -
-
Method Detail
-
permissions
final List<String> permissions()
Permissions to grant to 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()
-
_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.
-
builder
final static RoleCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of RoleCreateParams.
The following fields are required:
.permissions() .roleName()
-
-
-
-