com.atlassian.bitbucket.user

Class UserSearchRequest

java.lang.Object

com.atlassian.bitbucket.user.UserSearchRequest

public class UserSearchRequest
extends Object

Request for searching users. The purpose and behaviour of each field is described on its accessor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSearchRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	getFilter() When set, limits returned users to only those whose display names, e-mail addresses or usernames contain the provided filter.
String	getGroup() When set, limits returned users to only those who are members of the specified group.
Set<PermissionRequest>	getPermissions() When set, limits returned users to only those who have all permissions as specified by each contained permission request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFilter

@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 null to return users regardless of display names or e-mail addresses or usernames.

getGroup

@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 null to return users regardless of their group membership.

Since:

4.4

getPermissions

@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.