Package org.jenkinsci.plugins.pipeline.github

Class PullRequestGroovyObject

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:

  • Method Details

    • 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()

    • getMergeableState

      public String getMergeableState()

    • 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 line, 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()