public static class

ProjectSearchRequest.Builder

extends Object
java.lang.Object
   ↳ com.atlassian.stash.project.ProjectSearchRequest.Builder

Summary

Public Constructors
ProjectSearchRequest.Builder()
ProjectSearchRequest.Builder(ProjectSearchRequest request)
Constructs a new Builder which will copy initial values from the provided request.
Public Methods
@Nonnull ProjectSearchRequest build()
Assembles a new ProjectSearchRequest from the provided values.
@Nonnull ProjectSearchRequest.Builder name(String value)
When set, limits returned projects to only those whose names contain the provided value.
@Nonnull ProjectSearchRequest.Builder permission(Permission value)
When set, limits returned projects to only those for which the current user has the required Permission.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ProjectSearchRequest.Builder ()

public ProjectSearchRequest.Builder (ProjectSearchRequest request)

Constructs a new Builder which will copy initial values from the provided request.

Parameters
request request to copy

Public Methods

@Nonnull public ProjectSearchRequest build ()

Assembles a new ProjectSearchRequest from the provided values.

Returns
  • a new request

@Nonnull public ProjectSearchRequest.Builder name (String value)

When set, limits returned projects to only those whose names contain the provided value. Matching is performed in a case-insensitive manner, and will match anywhere within projects' names.

Note: Values containing only whitespace are ignored, and will not be applied. Additionally, leading and trailing whitespace are trimmed.

Parameters
value filter text match against project names, or null to return projects regardless of name
Returns
  • this

@Nonnull public ProjectSearchRequest.Builder permission (Permission value)

When set, limits returned projects to only those for which the current user has the required Permission. The provided value may be null, in which case projects will automatically be limited to those for which the current user has VIEW permission.

Parameters
value the required permission, or null to default to VIEW
Returns
  • this
Throws
IllegalArgumentException if the provided Permission is not project related