Package com.spotify.github.v3.clients

Class PullRequestClient

java.lang.Object

com.spotify.github.v3.clients.PullRequestClient

public class PullRequestClient
extends Object

Pull call API client

Method Summary

Modifier and Type	Method	Description
CompletableFuture<PullRequest>	create(PullRequestCreate request)	Create a pull request.
CompletableFuture<Review>	createReview(int number, ReviewParameters properties)	Creates a review for a pull request.
CompletableFuture<PullRequest>	get(int number)	Get a specific pull request.
CompletableFuture<List<PullRequestItem>>	list()	List repository pull request.
CompletableFuture<List<PullRequestItem>>	list(PullRequestParameters parameters)	List repository pull requests using given parameters.
CompletableFuture<List<CommitItem>>	listCommits(int number)	List pull request commits.
CompletableFuture<ReviewRequests>	listReviewRequests(int number)	List pull request requested reviews.
CompletableFuture<List<Review>>	listReviews(int number)	List pull request reviews.
Iterator<AsyncPage<Review>>	listReviews(int number, int itemsPerPage)	List pull request reviews paginated.
CompletableFuture<Void>	merge(int number, MergeParameters properties)	Merges a pull request.
CompletableFuture<Reader>	patch(int number)
CompletableFuture<Void>	removeRequestedReview(int number, RequestReviewParameters properties)	Remove a request for review for a pull request.
CompletableFuture<PullRequest>	requestReview(int number, RequestReviewParameters properties)	Requests a review for a pull request.
CompletableFuture<PullRequest>	update(int number, PullRequestUpdate request)	Update given pull request.

Methods inherited from class java.lang.Object

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

Method Detail

list

public CompletableFuture<List<PullRequestItem>> list()

List repository pull request.

Returns:

pull requests

list

public CompletableFuture<List<PullRequestItem>> list(PullRequestParameters parameters)

List repository pull requests using given parameters.

Parameters:

parameters - request parameters

Returns:

pull requests

get

public CompletableFuture<PullRequest> get(int number)

Get a specific pull request.

Parameters:

number - pull request number

Returns:

pull request

create

public CompletableFuture<PullRequest> create(PullRequestCreate request)

Create a pull request.

Parameters:

request - create request

Returns:

pull request

update

public CompletableFuture<PullRequest> update(int number,
                                             PullRequestUpdate request)

Update given pull request.

Parameters:

number - pull request number

request - update request

Returns:

pull request

listCommits

public CompletableFuture<List<CommitItem>> listCommits(int number)

List pull request commits.

Parameters:

number - pull request number

Returns:

commits

listReviews

public CompletableFuture<List<Review>> listReviews(int number)

List pull request reviews. Reviews are returned in chronological order.

Parameters:

number - pull request number

Returns:

list of reviews

listReviews

public Iterator<AsyncPage<Review>> listReviews(int number,
                                               int itemsPerPage)

List pull request reviews paginated. Reviews are returned in chronological order.

Parameters:

number - pull request number

itemsPerPage - number of items per page

Returns:

iterator of reviews

createReview

public CompletableFuture<Review> createReview(int number,
                                              ReviewParameters properties)

Creates a review for a pull request.

Parameters:

number - pull request number

properties - properties for reviewing the PR, such as sha, body and event

See Also:

"https://developer.github.com/v3/pulls/reviews/#create-a-review-for-a-pull-request"

listReviewRequests

public CompletableFuture<ReviewRequests> listReviewRequests(int number)

List pull request requested reviews.

Parameters:

number - pull request number

Returns:

list of reviews

requestReview

public CompletableFuture<PullRequest> requestReview(int number,
                                                    RequestReviewParameters properties)

Requests a review for a pull request.

Parameters:

number - pull request number

properties - properties for reviewing the PR, such as reviewers and team_reviewers.

See Also:

"https://docs.github.com/en/rest/reference/pulls#request-reviewers-for-a-pull-request"

removeRequestedReview

public CompletableFuture<Void> removeRequestedReview(int number,
                                                     RequestReviewParameters properties)

Remove a request for review for a pull request.

Parameters:

number - pull request number

properties - properties for reviewing the PR, such as reviewers and team_reviewers.

See Also:

"https://docs.github.com/en/rest/reference/pulls#request-reviewers-for-a-pull-request"

merge

public CompletableFuture<Void> merge(int number,
                                     MergeParameters properties)

Merges a pull request.

Parameters:

number - pull request number

properties - the properties on merging the PR, such as title, message and sha

See Also:

"https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button"

patch

public CompletableFuture<Reader> patch(int number)