| java.lang.Object | |
| ↳ | com.atlassian.bitbucket.user.UserSearchRequest |
Class Overview
Request for searching users. The purpose and behaviour of each field is described on its accessor.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| UserSearchRequest.Builder | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
When set, limits returned
users to only those whose
display names, e-mail addresses
or usernames contain the provided filter. | |||||||||||
When set, limits returned
users to only those who are members of the specified group. | |||||||||||
When set, limits returned
users to only those who have all permissions as specified by
each contained permission request. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
@Nullable public String getFilter ()
When set, limits returned users to only those whose
display names, e-mail addresses
or usernames contain the provided filter.
If this field is not set, users shall be returned regardless of their
display names or e-mail addresses
or usernames.
Returns
- filter text to match against display names or e-mail addresses or usernames,
or
nullto return users regardless of display names or e-mail addresses or usernames.
@Nullable public String getGroup ()
When set, limits returned users to only those who are members of the specified group.
If this field is not set, users shall be returned regardless of their group membership.
Returns
- group name to match against user's group membership,
or
nullto return users regardless of their group membership.
@Nonnull public Set<PermissionRequest> getPermissions ()
When set, limits returned users to only those who have all permissions as specified by
each contained permission request.
An empty set indicates that users shall be returned regardless of their Permission.
Returns
- the required permission(s), or an empty set to return all users regardless of permission.