Class Group
-
- All Implemented Interfaces:
public final class GroupA group is a collection of users which can be assigned an ACL
Groups can consist of individual users, as well as a set of groups they inherit from
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classGroup.BuilderA builder for Group.
-
Method Summary
Modifier and Type Method Description final Stringid()Unique identifier for the group final Stringname()Name of the group final StringorgId()Unique id for the organization that the group belongs underIt is forbidden to change the org after creating a group final Optional<OffsetDateTime>created()Date of group creation final Optional<OffsetDateTime>deletedAt()Date of group deletion, or null if the group is still active 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>userId()Identifies the user who created the group final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_orgId()Returns the raw JSON value of orgId. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<OffsetDateTime>_deletedAt()Returns the raw JSON value of deletedAt. 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>_userId()Returns the raw JSON value of userId. final Map<String, JsonValue>_additionalProperties()final Groupvalidate()final Group.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Group.Builderbuilder()Returns a mutable builder for constructing an instance of Group. -
-
Method Detail
-
orgId
final String orgId()
Unique id for the organization that the group belongs under
It is forbidden to change the org after creating a group
-
created
final Optional<OffsetDateTime> created()
Date of group creation
-
deletedAt
final Optional<OffsetDateTime> deletedAt()
Date of group deletion, or null if the group is still active
-
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
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, 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.
-
_orgId
final JsonField<String> _orgId()
Returns the raw JSON value of orgId.
Unlike orgId, this method doesn't throw if the JSON field has an unexpected type.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, this method doesn't throw if the JSON field has an unexpected type.
-
_deletedAt
final JsonField<OffsetDateTime> _deletedAt()
Returns the raw JSON value of deletedAt.
Unlike deletedAt, 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.
-
_userId
final JsonField<String> _userId()
Returns the raw JSON value of userId.
Unlike userId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Group.Builder toBuilder()
-
builder
final static Group.Builder builder()
Returns a mutable builder for constructing an instance of Group.
The following fields are required:
.id() .name() .orgId()
-
-
-
-