public class

PullRequestSearchRequest

extends Object
java.lang.Object
   ↳ com.atlassian.stash.pull.PullRequestSearchRequest

Class Overview

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

Summary

Nested Classes
class PullRequestSearchRequest.Builder  
Constants
int MAXIMUM_BRANCHES_TO_SEARCH
Public Methods
@Nonnull Collection<String> getFromRefIds()
When set, limits the pull requests to search for by the branches the changes are coming from.
@Nullable Integer getFromRepositoryId()
When set, limits the pull requests to search for by the repository the changes are coming from.
@Nullable PullRequestOrder getOrder()
The order to return the search results in.
@Nonnull Collection<PullRequestParticipantSearchRequest> getParticipants()
When set, limits the pull requests to search for by the participants associated with it.
@Nullable PullRequestState getState()
Restricts the search to a specified pull request state.
@Nonnull Collection<String> getToRefIds()
When set, limits the pull requests to search for by the branches the changes are going to.
@Nullable Integer getToRepositoryId()
When set, limits the pull requests to search for by the repository the changes are going to.
@Deprecated boolean isWithAttributes()
This method is deprecated. in 3.4 for removal in 4.0. Superseded by properties
boolean isWithProperties()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int MAXIMUM_BRANCHES_TO_SEARCH

Constant Value: 100 (0x00000064)

Public Methods

@Nonnull public Collection<String> getFromRefIds ()

When set, limits the pull requests to search for by the branches the changes are coming from.

Returns
  • the set branch ids

@Nullable public Integer getFromRepositoryId ()

When set, limits the pull requests to search for by the repository the changes are coming from.

Returns
  • the set from repository id

@Nullable public PullRequestOrder getOrder ()

The order to return the search results in. A null value will be interpreted as NEWEST first).

Returns
  • required order

@Nonnull public Collection<PullRequestParticipantSearchRequest> getParticipants ()

When set, limits the pull requests to search for by the participants associated with it.

Returns
  • The required pull request participants.

@Nullable public PullRequestState getState ()

Restricts the search to a specified pull request state.

Returns
  • the state to restrict to

@Nonnull public Collection<String> getToRefIds ()

When set, limits the pull requests to search for by the branches the changes are going to.

Returns
  • the set branch ids

@Nullable public Integer getToRepositoryId ()

When set, limits the pull requests to search for by the repository the changes are going to.

Returns
  • the set to repository id

@Deprecated public boolean isWithAttributes ()

This method is deprecated.
in 3.4 for removal in 4.0. Superseded by properties

Whether to fetch the pull requests' attributes.

Returns
  • true to fetch the pull requests' attributes.

public boolean isWithProperties ()

Returns
  • true to fetch the pull requests' properties.