com.atlassian.stash.rest.client.api.entity

Class PullRequestStatus

java.lang.Object

com.atlassian.stash.rest.client.api.entity.PullRequestStatus

public class PullRequestStatus
extends Object

pull request state

Constructor Summary

Constructors

Constructor and Description
PullRequestStatus(long id, long version, String title, Optional<String> description, String url, String state, Optional<String> mergeOutcome, PullRequestParticipant author, List<PullRequestParticipant> reviewers, PullRequestRef fromRef, PullRequestRef toRef, long lastUpdated, Optional<Long> commentCount, Optional<Long> outstandingTaskCount, Optional<Long> resolvedTaskCount)

Method Summary

Modifier and Type	Method and Description
PullRequestParticipant	getAuthor()
Optional<Long>	getCommentCount() Note this is optional as Stash/Bitbucket Server seems to return no counter value if there are no comments.
Optional<String>	getDescription()
PullRequestRef	getFromRef()
long	getId()
long	getLastUpdated()
Optional<String>	getMergeOutcome() Note this is optional as old Stash/Bitbucket Server versions may not return it (e.g.
Optional<Long>	getOutstandingTaskCount() Note this is optional as old Stash/Bitbucket Server versions may not return it (e.g.
Optional<Long>	getResolvedTaskCount() Note this is optional as old Stash/Bitbucket Server versions may not return it (e.g.
List<PullRequestParticipant>	getReviewers()
String	getState()
String	getTitle()
PullRequestRef	getToRef()
String	getUrl()
long	getVersion()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PullRequestStatus

public PullRequestStatus(long id,
                         long version,
                         @Nonnull
                         String title,
                         @Nonnull
                         Optional<String> description,
                         @Nonnull
                         String url,
                         @Nonnull
                         String state,
                         @Nonnull
                         Optional<String> mergeOutcome,
                         @Nonnull
                         PullRequestParticipant author,
                         @Nonnull
                         List<PullRequestParticipant> reviewers,
                         @Nonnull
                         PullRequestRef fromRef,
                         @Nonnull
                         PullRequestRef toRef,
                         long lastUpdated,
                         @Nonnull
                         Optional<Long> commentCount,
                         @Nonnull
                         Optional<Long> outstandingTaskCount,
                         @Nonnull
                         Optional<Long> resolvedTaskCount)

Method Detail

getId

public long getId()

Returns:

the repository-scoped identifier of the pull request

getVersion

public long getVersion()

Returns:

the current version of the pull request

getTitle

@Nonnull
public String getTitle()

Returns:

the mandatory title of the pull request

getDescription

@Nonnull
public Optional<String> getDescription()

Returns:

the description of the pull request

getUrl

@Nonnull
public String getUrl()

Returns:

url of this pull request

getState

@Nonnull
public String getState()

Returns:

state either OPEN, DECLINED or MERGED

getMergeOutcome

@Nonnull
public Optional<String> getMergeOutcome()

Note this is optional as old Stash/Bitbucket Server versions may not return it (e.g. 3.0.8).

Returns:

as of BBS 4.12.0 allowed values are CLEAN, CONFLICTED, UNKNOWN

Since:

Bitbucket 4.10.0

getAuthor

@Nonnull
public PullRequestParticipant getAuthor()

Returns:

the creating author of the pull request

getReviewers

@Nonnull
public List<PullRequestParticipant> getReviewers()

Returns:

the reviewing participants attached to the pull request, unordered.

getFromRef

@Nonnull
public PullRequestRef getFromRef()

Returns:

the ref containing the changes to review and merge

getToRef

@Nonnull
public PullRequestRef getToRef()

Returns:

the ref the changes should be merged to

getLastUpdated

public long getLastUpdated()

Returns:

the last update of the pull request

getCommentCount

@Nonnull
public Optional<Long> getCommentCount()

Note this is optional as Stash/Bitbucket Server seems to return no counter value if there are no comments.

Returns:

total number of comments on pull request

getOutstandingTaskCount

@Nonnull
public Optional<Long> getOutstandingTaskCount()

Note this is optional as old Stash/Bitbucket Server versions may not return it (e.g. 3.0.8)

Returns:

number of outstanding tasks

Since:

Bitbucket 4.3.0

getResolvedTaskCount

@Nonnull
public Optional<Long> getResolvedTaskCount()

Note this is optional as old Stash/Bitbucket Server versions may not return it (e.g. 3.0.8)

Returns:

number of resolved tasks

Since:

Bitbucket 4.3.0

toString

public String toString()

Overrides:

toString in class Object