Package org.kohsuke.github

Class GHPullRequestSearchBuilder

java.lang.Object
org.kohsuke.github.GHQueryBuilder<T>
org.kohsuke.github.GHSearchBuilder<GHPullRequest>
org.kohsuke.github.GHPullRequestSearchBuilder
public class GHPullRequestSearchBuilder extends GHSearchBuilder<GHPullRequest>
Search for pull requests by main search terms in order to narrow down search results.
Author:
Konstantin Gromov
See Also:

  • Method Details

    • repo

      public GHPullRequestSearchBuilder repo(GHRepository repository)
      Repository gh pull request search builder.
      Parameters:
      repository - the repository
      Returns:
      the gh pull request search builder

    • author

      public GHPullRequestSearchBuilder author(GHUser user)
      Author gh pull request search builder.
      Parameters:
      user - the user as pr author
      Returns:
      the gh pull request search builder

    • createdByMe

      public GHPullRequestSearchBuilder createdByMe()
      CreatedByMe gh pull request search builder.
      Returns:
      the gh pull request search builder

    • assigned

      public GHPullRequestSearchBuilder assigned(GHUser u)
      Assigned to gh pull request user.
      Parameters:
      u - the gh user
      Returns:
      the gh pull request search builder

    • mentions

      public GHPullRequestSearchBuilder mentions(GHUser u)
      Mentions gh pull request search builder.
      Parameters:
      u - the gh user
      Returns:
      the gh pull request search builder

    • isOpen

      public GHPullRequestSearchBuilder isOpen()
      Is open gh pull request search builder.
      Returns:
      the gh pull request search builder

    • isClosed

      public GHPullRequestSearchBuilder isClosed()
      Is closed gh pull request search builder.
      Returns:
      the gh pull request search builder

    • isMerged

      public GHPullRequestSearchBuilder isMerged()
      Is merged gh pull request search builder.
      Returns:
      the gh pull request search builder

    • isDraft

      public GHPullRequestSearchBuilder isDraft()
      Is draft gh pull request search builder.
      Returns:
      the gh pull request search builder

    • head

      public GHPullRequestSearchBuilder head(GHBranch branch)
      Head gh pull request search builder.
      Parameters:
      branch - the head branch
      Returns:
      the gh pull request search builder

    • base

      public GHPullRequestSearchBuilder base(GHBranch branch)
      Base gh pull request search builder.
      Parameters:
      branch - the base branch
      Returns:
      the gh pull request search builder

    • commit

      public GHPullRequestSearchBuilder commit(String sha)
      Commit gh pull request search builder.
      Parameters:
      sha - the commit SHA
      Returns:
      the gh pull request search builder

    • created

      public GHPullRequestSearchBuilder created(LocalDate created)
      Created gh pull request search builder.
      Parameters:
      created - the createdAt
      Returns:
      the gh pull request search builder

    • createdBefore

      public GHPullRequestSearchBuilder createdBefore(LocalDate created, boolean inclusive)
      CreatedBefore gh pull request search builder.
      Parameters:
      created - the createdAt
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • createdAfter

      public GHPullRequestSearchBuilder createdAfter(LocalDate created, boolean inclusive)
      CreatedAfter gh pull request search builder.
      Parameters:
      created - the createdAt
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • created

      public GHPullRequestSearchBuilder created(LocalDate from, LocalDate to)
      Created gh pull request search builder.
      Parameters:
      from - the createdAt starting from
      to - the createdAt ending to
      Returns:
      the gh pull request search builder

    • merged

      public GHPullRequestSearchBuilder merged(LocalDate merged)
      Merged gh pull request search builder.
      Parameters:
      merged - the merged
      Returns:
      the gh pull request search builder

    • mergedBefore

      public GHPullRequestSearchBuilder mergedBefore(LocalDate merged, boolean inclusive)
      MergedBefore gh pull request search builder.
      Parameters:
      merged - the merged
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • mergedAfter

      public GHPullRequestSearchBuilder mergedAfter(LocalDate merged, boolean inclusive)
      MergedAfter gh pull request search builder.
      Parameters:
      merged - the merged
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • merged

      public GHPullRequestSearchBuilder merged(LocalDate from, LocalDate to)
      Merged gh pull request search builder.
      Parameters:
      from - the merged starting from
      to - the merged ending to
      Returns:
      the gh pull request search builder

    • closed

      public GHPullRequestSearchBuilder closed(LocalDate closed)
      Closed gh pull request search builder.
      Parameters:
      closed - the closed
      Returns:
      the gh pull request search builder

    • closedBefore

      public GHPullRequestSearchBuilder closedBefore(LocalDate closed, boolean inclusive)
      ClosedBefore gh pull request search builder.
      Parameters:
      closed - the closed
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • closedAfter

      public GHPullRequestSearchBuilder closedAfter(LocalDate closed, boolean inclusive)
      ClosedAfter gh pull request search builder.
      Parameters:
      closed - the closed
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • closed

      public GHPullRequestSearchBuilder closed(LocalDate from, LocalDate to)
      Closed gh pull request search builder.
      Parameters:
      from - the closed starting from
      to - the closed ending to
      Returns:
      the gh pull request search builder

    • updated

      public GHPullRequestSearchBuilder updated(LocalDate updated)
      Updated gh pull request search builder.
      Parameters:
      updated - the updated
      Returns:
      the gh pull request search builder

    • updatedBefore

      public GHPullRequestSearchBuilder updatedBefore(LocalDate updated, boolean inclusive)
      UpdatedBefore gh pull request search builder.
      Parameters:
      updated - the updated
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • updatedAfter

      public GHPullRequestSearchBuilder updatedAfter(LocalDate updated, boolean inclusive)
      UpdatedAfter gh pull request search builder.
      Parameters:
      updated - the updated
      inclusive - whether to include date
      Returns:
      the gh pull request search builder

    • updated

      public GHPullRequestSearchBuilder updated(LocalDate from, LocalDate to)
      Updated gh pull request search builder.
      Parameters:
      from - the updated starting from
      to - the updated ending to
      Returns:
      the gh pull request search builder

    • label

      public GHPullRequestSearchBuilder label(String label)
      Label gh pull request search builder.
      Parameters:
      label - the label
      Returns:
      the gh pull request search builder

    • inLabels

      public GHPullRequestSearchBuilder inLabels(Iterable<String> labels)
      Labels gh pull request search builder.
      Parameters:
      labels - the labels
      Returns:
      the gh pull request search builder

    • titleLike

      public GHPullRequestSearchBuilder titleLike(String title)
      Title like search term
      Parameters:
      title - the title to be matched
      Returns:
      the gh pull request search builder

    • order

      public GHPullRequestSearchBuilder order(GHDirection direction)
      Order gh pull request search builder.
      Parameters:
      direction - the direction
      Returns:
      the gh pull request search builder

    • sort

      public GHPullRequestSearchBuilder sort(GHPullRequestSearchBuilder.Sort sort)
      Sort gh pull request search builder.
      Parameters:
      sort - the sort
      Returns:
      the gh pull request search builder

    • q

      public GHPullRequestSearchBuilder q(String term)
      Description copied from class: GHSearchBuilder
      Search terms.
      Overrides:
      q in class GHSearchBuilder<GHPullRequest>
      Parameters:
      term - the term
      Returns:
      the gh query builder

    • list

      public PagedSearchIterable<GHPullRequest> list()
      Description copied from class: GHSearchBuilder
      Performs the search.
      Overrides:
      list in class GHSearchBuilder<GHPullRequest>
      Returns:
      the paged search iterable

    • getApiUrl

      protected String getApiUrl()
      Description copied from class: GHSearchBuilder
      Gets api url.
      Specified by:
      getApiUrl in class GHSearchBuilder<GHPullRequest>
      Returns:
      the api url

    • getRoot

      @Deprecated public GitHub getRoot()
      Deprecated.
      For access to the GitHub instance, use a local copy instead of pulling it out of objects.
      Get the root GitHub instance for this object.
      Returns:
      the root GitHub instance