Package com.atlassian.bitbucket.repository

Class RepositorySearchRequest.Builder

java.lang.Object

com.atlassian.bitbucket.repository.RepositorySearchRequest.Builder

Enclosing class:

RepositorySearchRequest

public static class RepositorySearchRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(RepositorySearchRequest request)	Constructs a new Builder which will copy initial values from the provided request.

Method Summary

Modifier and Type	Method	Description
RepositorySearchRequest.Builder	archived(RepositoryArchiveFilter value)	Set the repository archive state filter for the resulting request instance.
RepositorySearchRequest	build()	Assembles a new RepositorySearchRequest from the provided values.
RepositorySearchRequest.Builder	name(String value)	Set the name filter for the resulting request instance.
RepositorySearchRequest.Builder	permission(Permission value)	Set the permission level for the resulting request instance.
RepositorySearchRequest.Builder	projectKey(String value)	Set the project key filter for the resulting request instance.
RepositorySearchRequest.Builder	projectName(String value)	Set the project name filter for the resulting request instance.
RepositorySearchRequest.Builder	state(Repository.State value)	Set the state filter for the resulting request instance.
RepositorySearchRequest.Builder	visibility(RepositoryVisibility value)	Set the visibility level for the resulting request instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Builder

public Builder(@Nonnull
 RepositorySearchRequest request)

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

Parameters:

request - request to copy

Method Details

build

@Nonnull
public RepositorySearchRequest build()

Assembles a new RepositorySearchRequest from the provided values.

Returns:

a new repository request instance

archived

@Nonnull
public RepositorySearchRequest.Builder archived(@Nullable
 RepositoryArchiveFilter value)

Set the repository archive state filter for the resulting request instance.

Parameters:

value - filter archive state for the repository search; may be null or blank, which will both be treated as an empty filter

Returns:

this

Since:

8.0

See Also:

• RepositorySearchRequest.getArchived()

name

@Nonnull
public RepositorySearchRequest.Builder name(@Nullable
 String value)

Set the name filter for the resulting request instance.

Parameters:

value - filter text for the repository search; may be null or blank, which will both be treated as an empty filter

Returns:

this

See Also:

• RepositorySearchRequest.getName()

projectName

@Nonnull
public RepositorySearchRequest.Builder projectName(@Nullable
 String value)

Set the project name filter for the resulting request instance.

Parameters:

value - filter text for the repository project name; may be null or blank, which will both be treated as an empty filter

Returns:

this

See Also:

• RepositorySearchRequest.getProjectName()

projectKey

@Nonnull
public RepositorySearchRequest.Builder projectKey(@Nullable
 String value)

Set the project key filter for the resulting request instance.

Parameters:

value - filter text for the repository project key; may be null or blank, which will both be treated as an empty filter

Returns:

this

Since:

8.0

See Also:

• RepositorySearchRequest.getProjectKey()

permission

@Nonnull
public RepositorySearchRequest.Builder permission(@Nullable
 Permission value)

Set the permission level for the resulting request instance.

Parameters:

value - the required permission for the repository search; may be null

Returns:

this

Throws:

IllegalArgumentException - if the provided Permission is not repository related

See Also:

• RepositorySearchRequest.getPermission()

state

@Nonnull
public RepositorySearchRequest.Builder state(@Nullable
 Repository.State value)

Set the state filter for the resulting request instance. Note that searching by Repository.State.OFFLINE is not supported.

Parameters:

value - the required state for the repository search; may be null

Returns:

this

Since:

5.13

See Also:

• RepositorySearchRequest.getState()

visibility

@Nonnull
public RepositorySearchRequest.Builder visibility(@Nullable
 RepositoryVisibility value)

Set the visibility level for the resulting request instance.

Parameters:

value - the required visibility for the repository search; may be null

Returns:

this

See Also:

• RepositorySearchRequest.getVisibility()