Class RoleCreateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class RoleCreateParams implements Params
Create a new role. If there is an existing role with the same name as the one specified in the request, will return the existing role unmodified
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRoleCreateParams.Bodypublic final classRoleCreateParams.BuilderA builder for RoleCreateParams.
public final classRoleCreateParams.MemberPermission
-
Method Summary
Modifier and Type Method Description final Stringname()Name of the role final Optional<String>description()Textual description of the role final Optional<List<RoleCreateParams.MemberPermission>>memberPermissions()(permission, restrict_object_type) tuples which belong to this role final Optional<List<String>>memberRoles()Ids of the roles this role inherits fromAn inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions final Optional<String>orgName()For nearly all users, this parameter should be unnecessary. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<List<RoleCreateParams.MemberPermission>>_memberPermissions()Returns the raw JSON value of memberPermissions. final JsonField<List<String>>_memberRoles()Returns the raw JSON value of memberRoles. final JsonField<String>_orgName()Returns the raw JSON value of orgName. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()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. final RoleCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RoleCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of RoleCreateParams. -
-
Method Detail
-
description
final Optional<String> description()
Textual description of the role
-
memberPermissions
final Optional<List<RoleCreateParams.MemberPermission>> memberPermissions()
(permission, restrict_object_type) tuples which belong to this role
-
memberRoles
final Optional<List<String>> memberRoles()
Ids of the roles this role inherits from
An inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions
-
orgName
final Optional<String> orgName()
For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the role belongs in.
-
_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.
-
_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.
-
_memberPermissions
final JsonField<List<RoleCreateParams.MemberPermission>> _memberPermissions()
Returns the raw JSON value of memberPermissions.
Unlike memberPermissions, this method doesn't throw if the JSON field has an unexpected type.
-
_memberRoles
final JsonField<List<String>> _memberRoles()
Returns the raw JSON value of memberRoles.
Unlike memberRoles, this method doesn't throw if the JSON field has an unexpected type.
-
_orgName
final JsonField<String> _orgName()
Returns the raw JSON value of orgName.
Unlike orgName, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_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.
-
toBuilder
final RoleCreateParams.Builder toBuilder()
-
builder
final static RoleCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of RoleCreateParams.
The following fields are required:
.name()
-
-
-
-