VcsPullRequest (Atlassian Bamboo 9.5.1 API)

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getKey()`
`Date`	`getLastModificationDate()`
`@NotNull String`	`getSource()`
`@Nullable Long`	`getSourceRepositoryId()`
`@NotNull String`	`getTarget()`
`long`	`getTargetRepositoryId()`
`@Nullable VcsForkDto`	`getVcsForkDto()`
`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
@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