public class GroupUpdateArgs extends IncludeMembersArg
Modifier and Type | Class and Description |
---|---|
static class |
GroupUpdateArgs.Builder
Builder for
GroupUpdateArgs . |
Modifier and Type | Field and Description |
---|---|
protected GroupSelector |
group |
protected String |
newGroupExternalId |
protected String |
newGroupName |
returnMembers
Constructor and Description |
---|
GroupUpdateArgs(GroupSelector group)
The default values for unset fields will be used.
|
GroupUpdateArgs(GroupSelector group,
boolean returnMembers,
String newGroupName,
String newGroupExternalId)
Use
newBuilder to create instances of this class without
specifying values for all optional fields. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
GroupSelector |
getGroup()
Specify a group.
|
String |
getNewGroupExternalId()
Optional argument.
|
String |
getNewGroupName()
Optional argument.
|
int |
hashCode() |
static GroupUpdateArgs.Builder |
newBuilder(GroupSelector group)
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.
|
getReturnMembers
protected final GroupSelector group
protected final String newGroupName
protected final String newGroupExternalId
public GroupUpdateArgs(GroupSelector group, boolean returnMembers, String newGroupName, String newGroupExternalId)
newBuilder
to create instances of this class without
specifying values for all optional fields.group
- Specify a group. Must not be null
.returnMembers
- Whether to return the list of members in the group.
Note that the default value will cause all the group members to be
returned in the response. This may take a long time for large groups.newGroupName
- Optional argument. Set group name to this if
provided.newGroupExternalId
- Optional argument. New group external ID. If
the argument is None, the group's external_id won't be updated. If
the argument is empty string, the group's external id will be
cleared.IllegalArgumentException
- If any argument does not meet its
preconditions.public GroupUpdateArgs(GroupSelector group)
group
- Specify a group. Must not be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public GroupSelector getGroup()
null
.public String getNewGroupName()
null
if not present.public String getNewGroupExternalId()
null
if not present.public static GroupUpdateArgs.Builder newBuilder(GroupSelector group)
group
- Specify a group. Must not be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public int hashCode()
hashCode
in class IncludeMembersArg
public boolean equals(Object obj)
equals
in class IncludeMembersArg
public String toString()
toString
in class IncludeMembersArg
public String toStringMultiline()
The returned String may contain newlines.
toStringMultiline
in class IncludeMembersArg