com.atlassian.bitbucket.pull

Class PullRequestUpdateRequest

java.lang.Object

com.atlassian.bitbucket.pull.AbstractPullRequestRequest

com.atlassian.bitbucket.pull.PullRequestUpdateRequest

public class PullRequestUpdateRequest
extends AbstractPullRequestRequest

Request object used for updating a pull request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PullRequestUpdateRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.pull.AbstractPullRequestRequest

AbstractPullRequestRequest.AbstractBuilder<T extends AbstractPullRequestRequest.AbstractBuilder<T>>

Method Summary

Modifier and Type	Method and Description
String	getDescription()
Set<String>	getReviewers()
String	getTitle()
String	getToBranchId()
int	getVersion()
Boolean	isDraft() WARNING: This method is experimental and is subject to change between minor versions of Bitbucket.

Methods inherited from class com.atlassian.bitbucket.pull.AbstractPullRequestRequest

getPullRequestId, getRepositoryId

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

@Nullable
public String getDescription()

Returns:

the new description of the pull request

getReviewers

@Nonnull
public Set<String> getReviewers()

Returns:

the new set of reviewers of the pull request. Any current reviewer not in this set will be relegated to participant status. Any new reviewer not already a participant will start participating. Any existing reviewer in the set will be unaltered. The values are user names (as returned by Person.getName())).

getTitle

@Nonnull
public String getTitle()

Returns:

the new title of the pull request

getToBranchId

@Nullable
public String getToBranchId()

Returns:

the new destination branch for the pull request, or null which will be ignored

getVersion

public int getVersion()

Returns:

the expected version of the pull request

isDraft

@Nullable
public Boolean isDraft()

WARNING: This method is experimental and is subject to change between minor versions of Bitbucket. It is not for consumption and no consideration will be given to nor guarantees made for its compatibility between releases. Basically, don't use it unless you're a Bitbucket developer.

Returns:

true if the pull request is to be updated to a draft, false to be published, or null which indicates the draft status is not to be updated as part of this update request

Since:

8.17