Package com.spotify.github.v3.prs
Class ReviewParameters
- java.lang.Object
-
- com.spotify.github.v3.prs.ReviewParameters
-
- Direct Known Subclasses:
ImmutableReviewParameters
@Immutable public abstract class ReviewParameters extends Object
The parameters for creating a review for a Pull Request.- See Also:
- "https://developer.github.com/v3/pulls/reviews/#input"
-
-
Constructor Summary
Constructors Constructor Description ReviewParameters()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract Optional<String>
body()
**required** when using REQUEST_CHANGES or COMMENT for the event.abstract List<ReviewComment>
comments()
List of comments for a non-approve review.abstract Optional<String>
commitId()
SHA of the commit that needs a review.abstract String
event()
Review action you want to perform.
-
-
-
Method Detail
-
commitId
public abstract Optional<String> commitId()
SHA of the commit that needs a review. If not the latest, the review may be outdated. Defaults to the most recent commit in the PR when you do not specify a value.- Returns:
- the optional commitId.
-
body
public abstract Optional<String> body()
**required** when using REQUEST_CHANGES or COMMENT for the event.- Returns:
- the optional body for REQUEST_CHANGES or COMMENT events.
-
event
public abstract String event()
Review action you want to perform. Should be one of: APPROVE, REQUEST_CHANGES or COMMENT.- Returns:
- the review action to perform.
-
comments
public abstract List<ReviewComment> comments()
List of comments for a non-approve review.- Returns:
- the list of comments for the review.
-
-