Package com.atlassian.bitbucket.pull
Class PullRequestFinishReviewRequest
java.lang.Object
com.atlassian.bitbucket.pull.PullRequestFinishReviewRequest
Describes a request to
finish a review
on a PullRequest.- Since:
- 7.7
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionGet the comment text that will be used for ageneral commentthat is added to thepull requestwhen you complete a review.Get the last commit that was reviewed for thepull requestwhen you complete a review, if provided.Get theparticipant statusto be used as the status for a reviewer's status on apull requestwhen you complete a review.Get thepull requestthat is used for the review.
-
Method Details
-
getCommentText
Get the comment text that will be used for ageneral commentthat is added to thepull requestwhen you complete a review.- Returns:
- the comment text or
nullif there is no comment text
-
getLastReviewedCommit
Get the last commit that was reviewed for thepull requestwhen you complete a review, if provided. If the pull request's latest commit does not match with the provided last reviewed commit, aPullRequestOutOfDateExceptionwill be thrown to indicate that the finish review was requested on stale data.- Returns:
- the last reviewed commit or
nullif not provided - Since:
- 8.9.18, 8.19.7, 9.0.1, 9.1
-
getParticipantStatus
Get theparticipant statusto be used as the status for a reviewer's status on apull requestwhen you complete a review.- Returns:
- the participant status or
nullif there is no participant status
-
getPullRequest
Get thepull requestthat is used for the review.- Returns:
- the pull request
-