Interface CheckRunBase

    • Method Detail

      • headSha

        String headSha()
        The SHA of the commit.
        Returns:
        the string
      • name

        String name()
        The name of the check. For example, "code-coverage".
        Returns:
        the string
      • status

        CheckRunStatus status()
        The current status. Can be one of queued, in_progress, or completed.
        Returns:
        the check run status enum
      • conclusion

        Optional<CheckRunConclusion> conclusion()
        The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. Required if you provide completedAt or a status of completed.
        Returns:
        the conclusion
      • startedAt

        Optional<ZonedDateTime> startedAt()
        The time that the check run began.
        Returns:
        the zoned date time
      • completedAt

        Optional<ZonedDateTime> completedAt()
        The time that the check completed.
        Returns:
        the zoned date time
      • externalId

        Optional<String> externalId()
        A reference for the run on the integrator's system.
        Returns:
        the optional string
      • detailsUrl

        Optional<String> detailsUrl()
        The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.
        Returns:
        the optional