Package com.atlassian.bamboo.plan.pullrequest

Interface VcsPullRequest

All Superinterfaces:
BambooIdProvider, CreationDateProvider
All Known Subinterfaces:
MutableVcsPullRequest
All Known Implementing Classes:
VcsPullRequestImpl
public interface VcsPullRequest extends BambooIdProvider, CreationDateProvider
Holds information about pull requests. Source of data is target repository which should be never null.
Since:
6.0

  • Method Details

    • getKey

      String getKey()
      Returns:
      repository specific pull request key

    • getSourceRepositoryId

      @Nullable @Nullable Long getSourceRepositoryId()
      Returns:
      source repository id or null if source repository is out of Bamboo control

    • getTargetRepositoryId

      long getTargetRepositoryId()
      Returns:
      target repository id

    • getSource

      @NotNull @NotNull String getSource()
      Returns:
      source branch name or git ref

    • getTarget

      @NotNull @NotNull String getTarget()
      Returns:
      name of target branch name or git ref

    • isOpen

      boolean isOpen()
      Returns:
      if pull request is open or merged/declined

    • getVcsForkDto

      @Nullable @Nullable VcsForkDto getVcsForkDto()
      Returns:
      data access object connected with pull requests made from forked repositories

    • getLastModificationDate

      Date getLastModificationDate()

    • isFromFork

      default boolean isFromFork()
      Returns:
      if PR is within repositories known to Bamboo or source repository is out of Bamboo control