public static class

UserSearchRequest.Builder

extends Object
java.lang.Object
   ↳ com.atlassian.bitbucket.user.UserSearchRequest.Builder

Summary

Public Constructors
Builder()
Builder(UserSearchRequest request)
Public Methods
@Nonnull UserSearchRequest build()
Assembles a new UserSearchRequest from the provided values.
@Nonnull UserSearchRequest.Builder filter(String filter)
Set the filter for the resulting request instance.
@Nonnull UserSearchRequest.Builder group(String group)
Set a group filter for the resulting request instance.
@Nonnull UserSearchRequest.Builder permission(Permission permission)
Set the global permission filter for the resulting request.
@Nonnull UserSearchRequest.Builder projectPermission(int projectId, Permission permission)
Set the project permission filter for the resulting request.
@Nonnull UserSearchRequest.Builder projectPermission(Project project, Permission permission)
Set the project permission filter for the resulting request.
@Nonnull UserSearchRequest.Builder repositoryPermission(Repository repository, Permission permission)
Set the repository permission filter for the resulting request.
@Nonnull UserSearchRequest.Builder repositoryPermission(int repositoryId, Permission permission)
Set the repository permission filter for the resulting request.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

public Builder (UserSearchRequest request)

Public Methods

@Nonnull public UserSearchRequest build ()

Assembles a new UserSearchRequest from the provided values.

Returns
  • a new request

@Nonnull public UserSearchRequest.Builder filter (String filter)

Set the filter for the resulting request instance.

Parameters
filter filter text for the user search; may be blank, which will be treated as an empty filter
Returns
  • this builder instance
See Also

@Nonnull public UserSearchRequest.Builder group (String group)

Set a group filter for the resulting request instance.

Parameters
group the group name for the user search; may be blank
Returns
  • this builder instance
See Also

@Nonnull public UserSearchRequest.Builder permission (Permission permission)

Set the global permission filter for the resulting request.

Parameters
permission filter permission for the user search
Returns
  • this builder instance

@Nonnull public UserSearchRequest.Builder projectPermission (int projectId, Permission permission)

Set the project permission filter for the resulting request.

NOTE: passing in an ID of a non-existing project will not filter out any users.

Parameters
projectId ID of the filter project for the user search
permission filter project permission for the user search
Returns
  • this builder instance

@Nonnull public UserSearchRequest.Builder projectPermission (Project project, Permission permission)

Set the project permission filter for the resulting request.

Parameters
project filter project for the user search
permission filter project permission for the user search
Returns
  • this builder instance

@Nonnull public UserSearchRequest.Builder repositoryPermission (Repository repository, Permission permission)

Set the repository permission filter for the resulting request.

Parameters
repository filter repository for the user search
permission filter repository permission for the user search
Returns
  • this builder instance

@Nonnull public UserSearchRequest.Builder repositoryPermission (int repositoryId, Permission permission)

Set the repository permission filter for the resulting request.

NOTE: passing in an ID of a non-existing repository will not filter out any users.

Parameters
repositoryId ID of the filter repository for the user search
permission filter repository permission for the user search
Returns
  • this builder instance