Class GroupUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class GroupUpdateParams implements Params
Partially update a group 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 classGroupUpdateParams.BuilderA builder for GroupUpdateParams.
public final classGroupUpdateParams.Body
-
Method Summary
Modifier and Type Method Description final StringgroupId()Group id final Optional<List<String>>addMemberGroups()A list of group IDs to add to the group's inheriting-from set final Optional<List<String>>addMemberUsers()A list of user IDs to add to the group final Optional<String>description()Textual description of the group final Optional<String>name()Name of the group final Optional<List<String>>removeMemberGroups()A list of group IDs to remove from the group's inheriting-from set final Optional<List<String>>removeMemberUsers()A list of user IDs to remove from the group final JsonField<List<String>>_addMemberGroups()Returns the raw JSON value of addMemberGroups. final JsonField<List<String>>_addMemberUsers()Returns the raw JSON value of addMemberUsers. 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>>_removeMemberGroups()Returns the raw JSON value of removeMemberGroups. final JsonField<List<String>>_removeMemberUsers()Returns the raw JSON value of removeMemberUsers. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final GroupUpdateParams.BuildertoBuilder()final GroupUpdateParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static GroupUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of GroupUpdateParams. -
-
Method Detail
-
addMemberGroups
final Optional<List<String>> addMemberGroups()
A list of group IDs to add to the group's inheriting-from set
-
addMemberUsers
final Optional<List<String>> addMemberUsers()
A list of user IDs to add to the group
-
description
final Optional<String> description()
Textual description of the group
-
removeMemberGroups
final Optional<List<String>> removeMemberGroups()
A list of group IDs to remove from the group's inheriting-from set
-
removeMemberUsers
final Optional<List<String>> removeMemberUsers()
A list of user IDs to remove from the group
-
_addMemberGroups
final JsonField<List<String>> _addMemberGroups()
Returns the raw JSON value of addMemberGroups.
Unlike addMemberGroups, this method doesn't throw if the JSON field has an unexpected type.
-
_addMemberUsers
final JsonField<List<String>> _addMemberUsers()
Returns the raw JSON value of addMemberUsers.
Unlike addMemberUsers, 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.
-
_removeMemberGroups
final JsonField<List<String>> _removeMemberGroups()
Returns the raw JSON value of removeMemberGroups.
Unlike removeMemberGroups, this method doesn't throw if the JSON field has an unexpected type.
-
_removeMemberUsers
final JsonField<List<String>> _removeMemberUsers()
Returns the raw JSON value of removeMemberUsers.
Unlike removeMemberUsers, 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()
-
toBuilder
final GroupUpdateParams.Builder toBuilder()
-
_body
final GroupUpdateParams.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.
-
builder
final static GroupUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of GroupUpdateParams.
The following fields are required:
.groupId()
-
-
-
-