Class GroupReplaceParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class GroupReplaceParams implements Params
Create or replace group. If there is an existing group with the same name as the one specified in the request, will replace the existing group with the provided fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classGroupReplaceParams.Bodypublic final classGroupReplaceParams.BuilderA builder for GroupReplaceParams.
-
Method Summary
Modifier and Type Method Description final Stringname()Name of the group final Optional<String>description()Textual description of the group final Optional<List<String>>memberGroups()Ids of the groups this group inherits fromAn inheriting group has all the users contained in its member groups, as well as all of their inherited users final Optional<List<String>>memberUsers()Ids of users which belong to this group 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<String>>_memberGroups()Returns the raw JSON value of memberGroups. final JsonField<List<String>>_memberUsers()Returns the raw JSON value of memberUsers. 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 GroupReplaceParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static GroupReplaceParams.Builderbuilder()Returns a mutable builder for constructing an instance of GroupReplaceParams. -
-
Method Detail
-
description
final Optional<String> description()
Textual description of the group
-
memberGroups
final Optional<List<String>> memberGroups()
Ids of the groups this group inherits from
An inheriting group has all the users contained in its member groups, as well as all of their inherited users
-
memberUsers
final Optional<List<String>> memberUsers()
Ids of users which belong to this group
-
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 group 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.
-
_memberGroups
final JsonField<List<String>> _memberGroups()
Returns the raw JSON value of memberGroups.
Unlike memberGroups, this method doesn't throw if the JSON field has an unexpected type.
-
_memberUsers
final JsonField<List<String>> _memberUsers()
Returns the raw JSON value of memberUsers.
Unlike memberUsers, 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 GroupReplaceParams.Builder toBuilder()
-
builder
final static GroupReplaceParams.Builder builder()
Returns a mutable builder for constructing an instance of GroupReplaceParams.
The following fields are required:
.name()
-
-
-
-