public class

UserSearchRequest

extends Object
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
class UserSearchRequest.Builder  
Public Methods
@Nullable String getFilter()
When set, limits returned users to only those whose display names, e-mail addresses or usernames contain the provided filter.
@Nonnull Set<PermissionRequest> getPermissions()
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, it is assumed that all 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.

@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 all users shall be returned regardless of their Permission.

Returns
  • the required permission(s), or an empty set to return all users regardless of permission.