Package com.atlassian.bitbucket.pull

Class PullRequestSearchRequest

java.lang.Object
com.atlassian.bitbucket.pull.PullRequestSearchRequest
public class PullRequestSearchRequest extends Object
Request for searching for pull requests. The purpose and behaviour of each field is described on its accessor.

  • Field Details

  • Method Details

    • getClosedSince

      @Nullable public Date getClosedSince()
      When set, limits the pull requests to search for pull requests in the closed state (i.e. PullRequestState.MERGED or PullRequestState.DECLINED) where the closed timestamp is more recent than the returned date.
      Returns:
      the closed since date
      Since:
      4.10

    • getFilterText

      @Nullable public String getFilterText()
      When set, limits the pull requests to search for to those whose title or description contains the provided text.
      Returns:
      filter text to match against the pull request's title or description, or null for no filtering
      Since:
      7.2

    • getFromRefIds

      @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

    • getFromRepositoryId

      @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

    • getOrders

      @Nonnull public List<PullRequestOrder> getOrders()
      A list of order's to return the search results in. If no PullRequestOrder is supplied, then results will be ordered by NEWEST.
      Returns:
      required orders
      Since:
      8.17

    • getParticipants

      @Nonnull public Collection<PullRequestParticipantRequest> getParticipants()
      When set, limits the pull requests to search for by the participants associated with it.
      Returns:
      The required pull request participants.

    • getState

      @Nullable public PullRequestState getState()
      Restricts the search to a specified pull request state.
      Returns:
      the state to restrict to

    • getToRefIds

      @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

    • getToRepositoryId

      @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

    • getUpdatedSince

      @Nullable public Date getUpdatedSince()
      When set, limits the pull requests to search for pull requests where the updated timestamp is more recent than the returned date.
      Returns:
      the updated since date
      Since:
      7.12

    • isDraft

      @Nullable public Boolean isDraft()
      When set, limits the search to pull requests that match the specified draft status.
      Returns:
      true if only draft pull requests will be returned. false, if only non-draft pull requests will be returned. If null, then this filter will be ignored.
      Since:
      8.18

    • isWithDescription

      public boolean isWithDescription()
      Returns:
      true to fetch the description of the pull request(s) returned by the search
      Since:
      7.10

    • isWithProperties

      public boolean isWithProperties()
      Returns:
      true to fetch the pull requests' properties.