PullRequestGroovyObject (Pipeline: GitHub 2.6-SNAPSHOT API)

java.lang.Object
- groovy.lang.GroovyObjectSupport
- - org.jenkinsci.plugins.pipeline.github.PullRequestGroovyObject

All Implemented Interfaces:

groovy.lang.GroovyObject, Serializable
```
public class PullRequestGroovyObject
extends groovy.lang.GroovyObjectSupport
implements Serializable
```
Groovy object that represents a GitHub PullRequest. TODO: better javadoc

Author:

Aaron Whiteside

See Also:

ExtendedPullRequest, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAssignees(List<String> assignees)`
`void`	`addLabel(String label)`
`void`	`addLabels(List<String> labels)`
`IssueCommentGroovyObject`	`comment(String body)`
`void`	`createReviewRequest(String reviewer)`
`void`	`createReviewRequests(List<String> reviewers)`
`CommitStatusGroovyObject`	`createStatus(Map<String,Object> params)`
`CommitStatusGroovyObject`	`createStatus(String status, String context, String description, String targetUrl)`
`void`	`createTeamReviewRequest(String team)`
`void`	`createTeamReviewRequests(List<String> teams)`
`void`	`deleteBranch()`
`void`	`deleteComment(long commentId)`
`void`	`deleteReviewComment(long commentId)`
`void`	`deleteReviewRequest(String reviewer)`
`void`	`deleteReviewRequests(List<String> reviewers)`
`void`	`deleteTeamReviewRequest(String team)`
`void`	`deleteTeamReviewRequests(List<String> teams)`
`IssueCommentGroovyObject`	`editComment(long commentId, String body)`
`ReviewCommentGroovyObject`	`editReviewComment(long commentId, String body)`
`int`	`getAdditions()`
`Iterable<String>`	`getAssignees()`
`String`	`getBase()`
`String`	`getBody()`
`int`	`getChangedFiles()`
`Date`	`getClosedAt()`
`String`	`getClosedBy()`
`int`	`getCommentCount()`
`Iterable<IssueCommentGroovyObject>`	`getComments()`
`int`	`getCommitCount()`
`Iterable<CommitGroovyObject>`	`getCommits()`
`Date`	`getCreatedAt()`
`String`	`getCreatedBy()`
`int`	`getDeletions()`
`String`	`getDiffUrl()`
`Iterable<CommitFileGroovyObject>`	`getFiles()`
`String`	`getHead()`
`String`	`getHeadRef()`
`long`	`getId()`
`String`	`getIssueUrl()`
`Iterable<String>`	`getLabels()`
`String`	`getMergeCommitSha()`
`Date`	`getMergedAt()`
`String`	`getMergedBy()`
`MilestoneGroovyObject`	`getMilestone()`
`int`	`getNumber()`
`String`	`getPatchUrl()`
`Iterable<String>`	`getRequestedReviewers()`
`Iterable<String>`	`getRequestedTeamReviewers()`
`Iterable<ReviewCommentGroovyObject>`	`getReviewComments()`
`Iterable<ReviewGroovyObject>`	`getReviews()`
`String`	`getState()`
`Iterable<CommitStatusGroovyObject>`	`getStatuses()`
`String`	`getTitle()`
`Date`	`getUpdatedAt()`
`String`	`getUrl()`
`boolean`	`isDraft()`
`boolean`	`isLocked()`
`boolean`	`isMaintainerCanModify()`
`boolean`	`isMergeable()`
`boolean`	`isMerged()`
`String`	`merge(Map<String,Object> params)`
`String`	`merge(String commitMessage)`
`String`	`merge(String commitTitle, String commitMessage, String sha, String mergeMethod)`
`void`	`refresh()`
`void`	`removeAssignees(List<String> assignees)`
`void`	`removeLabel(String label)`
`ReviewCommentGroovyObject`	`replyToReviewComment(long commentId, String body)`
`void`	`review(Map<String,Object> params)`
`void`	`review(String event)`
`void`	`review(String event, String body)`
`void`	`review(String commitId, String event, String body)`
`ReviewCommentGroovyObject`	`reviewComment(String commitId, String path, int position, String body)`
`void`	`setAssignees(List<String> assignees)`
`void`	`setBase(String newBase)`
`void`	`setBody(String body)`
`void`	`setCredentials(String userName, String password)`
`void`	`setLabels(List<String> labels)`
`void`	`setLocked(boolean locked)`
`void`	`setMaintainerCanModify(boolean value)`
`void`	`setMilestone(int milestoneNumber)`
`void`	`setMilestone(MilestoneGroovyObject milestone)`
`void`	`setState(String state)`
`void`	`setTitle(String title)`

Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getId
```
public long getId()
```

getNumber
```
public int getNumber()
```

getDiffUrl
```
public String getDiffUrl()
```

getUrl
```
public String getUrl()
```

getPatchUrl
```
public String getPatchUrl()
```

getState
```
public String getState()
```

getIssueUrl
```
public String getIssueUrl()
```

getTitle
```
public String getTitle()
```

getBody
```
public String getBody()
```

isLocked
```
public boolean isLocked()
```

isDraft
```
public boolean isDraft()
```

getMilestone

public MilestoneGroovyObject getMilestone()

getHead
```
public String getHead()
```

getHeadRef
```
public String getHeadRef()
```

getBase
```
public String getBase()
```

getUpdatedAt
```
public Date getUpdatedAt()
```

getCreatedAt
```
public Date getCreatedAt()
```

getCreatedBy
```
public String getCreatedBy()
```

getClosedAt
```
public Date getClosedAt()
```

getClosedBy
```
public String getClosedBy()
```

getMergedAt
```
public Date getMergedAt()
```

getMergedBy
```
public String getMergedBy()
```

getCommitCount
```
public int getCommitCount()
```

getCommentCount
```
public int getCommentCount()
```

getDeletions
```
public int getDeletions()
```

getMergeCommitSha
```
public String getMergeCommitSha()
```

isMaintainerCanModify

public boolean isMaintainerCanModify()

getAdditions
```
public int getAdditions()
```

getChangedFiles
```
public int getChangedFiles()
```

isMergeable
```
public boolean isMergeable()
```

isMerged
```
public boolean isMerged()
```

getRequestedReviewers

public Iterable<String> getRequestedReviewers()

getRequestedTeamReviewers

public Iterable<String> getRequestedTeamReviewers()

getReviews

public Iterable<ReviewGroovyObject> getReviews()

getStatuses

public Iterable<CommitStatusGroovyObject> getStatuses()

getLabels
```
public Iterable<String> getLabels()
```

getAssignees

public Iterable<String> getAssignees()

getCommits

public Iterable<CommitGroovyObject> getCommits()

getComments

public Iterable<IssueCommentGroovyObject> getComments()

getReviewComments

public Iterable<ReviewCommentGroovyObject> getReviewComments()

getFiles

public Iterable<CommitFileGroovyObject> getFiles()

setMilestone

public void setMilestone(int milestoneNumber)

setMilestone

public void setMilestone(MilestoneGroovyObject milestone)

setLocked

public void setLocked(boolean locked)

setTitle
```
public void setTitle(String title)
```

setBody
```
public void setBody(String body)
```

setState
```
public void setState(String state)
```

setBase
```
public void setBase(String newBase)
```

setMaintainerCanModify

public void setMaintainerCanModify(boolean value)

setLabels

public void setLabels(List<String> labels)

createReviewRequest

public void createReviewRequest(String reviewer)

createReviewRequests

public void createReviewRequests(List<String> reviewers)

deleteReviewRequest

public void deleteReviewRequest(String reviewer)

deleteReviewRequests

public void deleteReviewRequests(List<String> reviewers)

createTeamReviewRequest

public void createTeamReviewRequest(String team)

createTeamReviewRequests

public void createTeamReviewRequests(List<String> teams)

deleteTeamReviewRequest

public void deleteTeamReviewRequest(String team)

deleteTeamReviewRequests

public void deleteTeamReviewRequests(List<String> teams)

addLabel
```
public void addLabel(String label)
```

addLabels

public void addLabels(List<String> labels)

removeLabel

public void removeLabel(String label)

addAssignees

public void addAssignees(List<String> assignees)

setAssignees

public void setAssignees(List<String> assignees)

removeAssignees

public void removeAssignees(List<String> assignees)

review
```
public void review(String event)
```

review

public void review(String event,
                   String body)

review

public void review(Map<String,Object> params)

review

public void review(String commitId,
                   String event,
                   String body)

createStatus

public CommitStatusGroovyObject createStatus(Map<String,Object> params)

createStatus

public CommitStatusGroovyObject createStatus(String status,
                                             String context,
                                             String description,
                                             String targetUrl)

reviewComment

public ReviewCommentGroovyObject reviewComment(String commitId,
                                               String path,
                                               int position,
                                               String body)

replyToReviewComment

public ReviewCommentGroovyObject replyToReviewComment(long commentId,
                                                      String body)

deleteReviewComment

public void deleteReviewComment(long commentId)

editReviewComment

public ReviewCommentGroovyObject editReviewComment(long commentId,
                                                   String body)

comment

public IssueCommentGroovyObject comment(String body)

editComment

public IssueCommentGroovyObject editComment(long commentId,
                                            String body)

deleteComment

public void deleteComment(long commentId)

merge

public String merge(Map<String,Object> params)

merge

public String merge(String commitMessage)

merge

public String merge(String commitTitle,
                    String commitMessage,
                    String sha,
                    String mergeMethod)

refresh
```
public void refresh()
```

setCredentials

public void setCredentials(String userName,
                           String password)

deleteBranch
```
public void deleteBranch()
```

Class PullRequestGroovyObject

Method Summary

Methods inherited from class groovy.lang.GroovyObjectSupport

Methods inherited from class java.lang.Object

Method Detail

getId

getNumber

getDiffUrl

getUrl

getPatchUrl

getState

getIssueUrl

getTitle

getBody

isLocked

isDraft

getMilestone

getHead

getHeadRef

getBase

getUpdatedAt

getCreatedAt

getCreatedBy

getClosedAt

getClosedBy

getMergedAt

getMergedBy

getCommitCount

getCommentCount

getDeletions

getMergeCommitSha

isMaintainerCanModify

getAdditions

getChangedFiles

isMergeable

isMerged

getRequestedReviewers

getRequestedTeamReviewers

getReviews

getStatuses

getLabels

getAssignees

getCommits

getComments

getReviewComments

getFiles

setMilestone

setMilestone

setLocked

setTitle

setBody

setState

setBase

setMaintainerCanModify

setLabels

createReviewRequest

createReviewRequests

deleteReviewRequest

deleteReviewRequests

createTeamReviewRequest

createTeamReviewRequests

deleteTeamReviewRequest

deleteTeamReviewRequests

addLabel

addLabels

removeLabel

addAssignees

setAssignees

removeAssignees

review

review

review

review

createStatus

createStatus

reviewComment

replyToReviewComment

deleteReviewComment

editReviewComment

comment