Package com.spotify.github.v3.prs

Interface PullRequestItem

All Superinterfaces:

CloseTracking, UpdateTracking

All Known Subinterfaces:

PullRequest

All Known Implementing Classes:

ImmutablePullRequest, ImmutablePullRequestItem

@Immutable
public interface PullRequestItem
extends CloseTracking

Pull request item resource represents data returned during pull request list operation

Method Summary

Modifier and Type	Method	Description
Optional<User>	assignee()	Assignee.
Optional<List<User>>	assignees()	Assignees.
PullRequestRef	base()	Base reference.
Optional<String>	body()	The contents of the pull request.
URI	commentsUrl()	Comments API URL.
URI	commitsUrl()	Commits URL.
URI	diffUrl()	Diff URL.
PullRequestRef	head()	Head reference.
URI	htmlUrl()	HTML URL.
Integer	id()	ID.
URI	issueUrl()	Issue URL.
PullRequestLinks	links()	Link references.
Boolean	locked()	Is it locked.
Optional<String>	mergeCommitSha()
Optional<GitHubInstant>	mergedAt()	Merged date.
Optional<Milestone>	milestone()	Milestone.
Integer	number()	Number.
URI	patchUrl()	Patch URL.
List<User>	requestedReviewers()	Requested reviewers (users)
List<User>	requestedTeams()	Requested reviewers (teams)
URI	reviewCommentsUrl()	Review comments API URL.
String	reviewCommentUrl()	Review comment API URL template.
String	state()	Either open, closed, or all to filter by state.
URI	statusesUrl()	Statuses API URL.
String	title()	The title of the pull request.
URI	url()	URL.
User	user()	User.

Methods inherited from interface com.spotify.github.CloseTracking

closedAt

Methods inherited from interface com.spotify.github.UpdateTracking

createdAt, updatedAt

Method Detail

id

@Nullable
Integer id()

ID.

url

@Nullable
URI url()

URL.

htmlUrl

@Nullable
URI htmlUrl()

HTML URL.

diffUrl

@Nullable
URI diffUrl()

Diff URL.

patchUrl

@Nullable
URI patchUrl()

Patch URL.

issueUrl

@Nullable
URI issueUrl()

Issue URL.

commitsUrl

@Nullable
URI commitsUrl()

Commits URL.

number

@Nullable
Integer number()

Number.

state

@Nullable
String state()

Either open, closed, or all to filter by state. Default: open.

title

@Nullable
String title()

The title of the pull request.

body

Optional<String> body()

The contents of the pull request.

assignee

Optional<User> assignee()

Assignee.

assignees

Optional<List<User>> assignees()

Assignees.

milestone

Optional<Milestone> milestone()

Milestone.

locked

@Nullable
Boolean locked()

Is it locked.

mergedAt

Optional<GitHubInstant> mergedAt()

Merged date.

head

@Nullable
PullRequestRef head()

Head reference.

base

@Nullable
PullRequestRef base()

Base reference.

user

@Nullable
User user()

User.

statusesUrl

@Nullable
URI statusesUrl()

Statuses API URL.

reviewCommentsUrl

@Nullable
URI reviewCommentsUrl()

Review comments API URL.

reviewCommentUrl

@Nullable
String reviewCommentUrl()

Review comment API URL template.

commentsUrl

@Nullable
URI commentsUrl()

Comments API URL.

links

@Nullable
PullRequestLinks links()

Link references.

requestedReviewers

@Nullable
List<User> requestedReviewers()

Requested reviewers (users)

requestedTeams

@Nullable
List<User> requestedTeams()

Requested reviewers (teams)

mergeCommitSha

Optional<String> mergeCommitSha()