Class RoleUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class RoleUpdateParams implements Params
Partially update a role object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRoleUpdateParams.Bodypublic final classRoleUpdateParams.BuilderA builder for RoleUpdateParams.
public final classRoleUpdateParams.AddMemberPermissionpublic final classRoleUpdateParams.RemoveMemberPermission
-
Method Summary
Modifier and Type Method Description final StringroleId()Role id final Optional<List<RoleUpdateParams.AddMemberPermission>>addMemberPermissions()A list of permissions to add to the role final Optional<List<String>>addMemberRoles()A list of role IDs to add to the role's inheriting-from set final Optional<String>description()Textual description of the role final Optional<String>name()Name of the role final Optional<List<RoleUpdateParams.RemoveMemberPermission>>removeMemberPermissions()A list of permissions to remove from the role final Optional<List<String>>removeMemberRoles()A list of role IDs to remove from the role's inheriting-from set final JsonField<List<RoleUpdateParams.AddMemberPermission>>_addMemberPermissions()Returns the raw JSON value of addMemberPermissions. final JsonField<List<String>>_addMemberRoles()Returns the raw JSON value of addMemberRoles. 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<RoleUpdateParams.RemoveMemberPermission>>_removeMemberPermissions()Returns the raw JSON value of removeMemberPermissions. final JsonField<List<String>>_removeMemberRoles()Returns the raw JSON value of removeMemberRoles. 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 StringgetPathParam(Integer index)final RoleUpdateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RoleUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of RoleUpdateParams. -
-
Method Detail
-
addMemberPermissions
final Optional<List<RoleUpdateParams.AddMemberPermission>> addMemberPermissions()
A list of permissions to add to the role
-
addMemberRoles
final Optional<List<String>> addMemberRoles()
A list of role IDs to add to the role's inheriting-from set
-
description
final Optional<String> description()
Textual description of the role
-
removeMemberPermissions
final Optional<List<RoleUpdateParams.RemoveMemberPermission>> removeMemberPermissions()
A list of permissions to remove from the role
-
removeMemberRoles
final Optional<List<String>> removeMemberRoles()
A list of role IDs to remove from the role's inheriting-from set
-
_addMemberPermissions
final JsonField<List<RoleUpdateParams.AddMemberPermission>> _addMemberPermissions()
Returns the raw JSON value of addMemberPermissions.
Unlike addMemberPermissions, this method doesn't throw if the JSON field has an unexpected type.
-
_addMemberRoles
final JsonField<List<String>> _addMemberRoles()
Returns the raw JSON value of addMemberRoles.
Unlike addMemberRoles, 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.
-
_removeMemberPermissions
final JsonField<List<RoleUpdateParams.RemoveMemberPermission>> _removeMemberPermissions()
Returns the raw JSON value of removeMemberPermissions.
Unlike removeMemberPermissions, this method doesn't throw if the JSON field has an unexpected type.
-
_removeMemberRoles
final JsonField<List<String>> _removeMemberRoles()
Returns the raw JSON value of removeMemberRoles.
Unlike removeMemberRoles, 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.
-
getPathParam
final String getPathParam(Integer index)
-
toBuilder
final RoleUpdateParams.Builder toBuilder()
-
builder
final static RoleUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of RoleUpdateParams.
The following fields are required:
.roleId()
-
-
-
-