Class GHCheckSuite

    • Constructor Detail

      • GHCheckSuite

        public GHCheckSuite()
    • Method Detail

      • getNodeId

        public String getNodeId()
        Gets the global node id to access most objects in GitHub.
        Overrides:
        getNodeId in class GHObject
        Returns:
        global node id
        See Also:
        documentation
      • getHeadBranch

        public String getHeadBranch()
        The head branch name the changes are on.
        Returns:
        head branch name
      • getHeadSha

        public String getHeadSha()
        Gets the HEAD SHA.
        Returns:
        sha for the HEAD commit
      • getStatus

        public String getStatus()
        Gets status of the check suite. It can be one of request, in_progress, or completed.
        Returns:
        status of the check suite
      • getConclusion

        public String getConclusion()
        Gets conclusion of a completed check suite. It can be one of success, failure, neutral, cancelled, time_out, action_required, or stale. The check suite will report the highest priority check run conclusion in the check suite's conclusion.
        Returns:
        conclusion of the check suite
      • getBefore

        public String getBefore()
        The SHA of the most recent commit on ref before the push.
        Returns:
        sha of a commit
      • getAfter

        public String getAfter()
        The SHA of the most recent commit on ref after the push.
        Returns:
        sha of a commit
      • getLatestCheckRunsCount

        public int getLatestCheckRunsCount()
        The quantity of check runs that had run as part of the latest push.
        Returns:
        sha of the most recent commit
      • getCheckRunsUrl

        public URL getCheckRunsUrl()
        The url used to list all the check runs belonged to this suite.
        Returns:
        url containing all check runs
      • getApp

        public GHApp getApp()
        Gets the GitHub app this check suite belongs to, included in response.
        Returns:
        GitHub App
      • getPullRequests

        public List<GHPullRequest> getPullRequests()
                                            throws IOException
        Gets the pull requests participated in this check suite. Note this field is only populated for events. When getting a GHCheckSuite outside of an event, this is always empty.
        Returns:
        the list of GHPullRequests for this check suite. Only populated for events.
        Throws:
        IOException - the io exception
      • getHtmlUrl

        public URL getHtmlUrl()
        Check suite doesn't have a HTML URL.
        Specified by:
        getHtmlUrl in class GHObject
        Returns:
        null