Class GHCheckRun

    • Constructor Detail

      • GHCheckRun

        public GHCheckRun()
    • Method Detail

      • getStatus

        public String getStatus()
        Gets status of the check run.
        Returns:
        Status of the check run
        See Also:
        GHCheckRun.Status
      • getConclusion

        public String getConclusion()
        Gets conclusion of a completed check run.
        Returns:
        Status of the check run
        See Also:
        GHCheckRun.Conclusion
      • getName

        public String getName()
        Gets the custom name of this check run.
        Returns:
        Name of the check run
      • getHeadSha

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

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

        public URL getHtmlUrl()
        Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of the check run.
        Specified by:
        getHtmlUrl in class GHObject
        Returns:
        HTML URL
      • 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
      • getExternalId

        public String getExternalId()
        Gets a reference for the check run on the integrator's system.
        Returns:
        Reference id
      • getDetailsUrl

        public URL getDetailsUrl()
        Gets the details URL from which to find full details of the check run on the integrator's site.
        Returns:
        Details URL
      • getStartedAt

        public Date getStartedAt()
        Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
        Returns:
        Timestamp of the start time
      • getCompletedAt

        public Date getCompletedAt()
        Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
        Returns:
        Timestamp of the completed time
      • getApp

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

        public GHCheckSuite getCheckSuite()
        Gets the check suite this check run belongs to
        Returns:
        Check suite
      • getOutput

        public GHCheckRun.Output getOutput()
        Gets an output for a check run.
        Returns:
        Output of a check run