public class GroupSummary extends Object
Modifier and Type | Class and Description |
---|---|
static class |
GroupSummary.Builder
Builder for
GroupSummary . |
static class |
GroupSummary.Serializer
For internal use only.
|
Modifier and Type | Field and Description |
---|---|
protected String |
groupExternalId |
protected String |
groupId |
protected GroupManagementType |
groupManagementType |
protected String |
groupName |
protected Long |
memberCount |
Constructor and Description |
---|
GroupSummary(String groupName,
String groupId,
GroupManagementType groupManagementType)
Information about a group.
|
GroupSummary(String groupName,
String groupId,
GroupManagementType groupManagementType,
String groupExternalId,
Long memberCount)
Information about a group.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getGroupExternalId()
External ID of group.
|
String |
getGroupId() |
GroupManagementType |
getGroupManagementType()
Who is allowed to manage the group.
|
String |
getGroupName() |
Long |
getMemberCount()
The number of members in the group.
|
int |
hashCode() |
static GroupSummary.Builder |
newBuilder(String groupName,
String groupId,
GroupManagementType groupManagementType)
Returns a new builder for creating an instance of this class.
|
String |
toString() |
String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
protected final String groupName
protected final String groupId
protected final String groupExternalId
protected final Long memberCount
protected final GroupManagementType groupManagementType
public GroupSummary(String groupName, String groupId, GroupManagementType groupManagementType, String groupExternalId, Long memberCount)
Use newBuilder
to create instances of this class without
specifying values for all optional fields.
groupName
- Must not be null
.groupId
- Must not be null
.groupManagementType
- Who is allowed to manage the group. Must not
be null
.groupExternalId
- External ID of group. This is an arbitrary ID
that an admin can attach to a group.memberCount
- The number of members in the group.IllegalArgumentException
- If any argument does not meet its
preconditions.public GroupSummary(String groupName, String groupId, GroupManagementType groupManagementType)
The default values for unset fields will be used.
groupName
- Must not be null
.groupId
- Must not be null
.groupManagementType
- Who is allowed to manage the group. Must not
be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public String getGroupName()
null
.public String getGroupId()
null
.public GroupManagementType getGroupManagementType()
null
.public String getGroupExternalId()
null
if not present.public Long getMemberCount()
null
if not present.public static GroupSummary.Builder newBuilder(String groupName, String groupId, GroupManagementType groupManagementType)
groupName
- Must not be null
.groupId
- Must not be null
.groupManagementType
- Who is allowed to manage the group. Must not
be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public String toStringMultiline()
The returned String may contain newlines.