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

Field Summary

Fields inherited from interface com.atlassian.bamboo.utils.CreationDateProvider

ORDERING

Method Summary

Modifier and Type	Method and Description
String	getKey()
Date	getLastModificationDate()
String	getSource()
Long	getSourceRepositoryId()
String	getTarget()
long	getTargetRepositoryId()
default boolean	isFromFork()
boolean	isOpen()

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.utils.CreationDateProvider

getCreationDate

Method Detail

getKey

String getKey()

Returns:

repository specific pull request key

getSourceRepositoryId

@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
String getSource()

Returns:

source branch name or git ref

getTarget

@NotNull
String getTarget()

Returns:

name of target branch name or git ref

isOpen

boolean isOpen()

Returns:

if pull request is open or merged/declined

getLastModificationDate

Date getLastModificationDate()

isFromFork

default boolean isFromFork()

Returns:

if PR is within repositories known to Bamboo or source repository is out of Bamboo control