Module org.kohsuke.github.api
Package org.kohsuke.github

Class GHCheckRunBuilder

java.lang.Object
org.kohsuke.github.GHCheckRunBuilder
public final class GHCheckRunBuilder extends Object
Drafts or updates a check run.
See Also:

  • Field Details

    • repo

      protected final GHRepository repo
      The repo.

    • requester

      protected final org.kohsuke.github.Requester requester
      The requester.

  • Method Details

    • add

      @NonNull public GHCheckRunBuilder add(@NonNull GHCheckRunBuilder.Action action)
      Adds the.
      Parameters:
      action - the action
      Returns:
      the GH check run builder

    • add

      @NonNull public GHCheckRunBuilder add(@NonNull GHCheckRunBuilder.Output output)
      Adds the.
      Parameters:
      output - the output
      Returns:
      the GH check run builder

    • create

      @NonNull public GHCheckRun create() throws IOException
      Actually creates the check run. (If more than fifty annotations were requested, this is done in batches.)
      Returns:
      the resulting run
      Throws:
      IOException - for the usual reasons

    • withCompletedAt

      @Deprecated @NonNull public GHCheckRunBuilder withCompletedAt(@CheckForNull Date completedAt)
      Deprecated.
      Use withCompletedAt(Instant)
      With completed at.
      Parameters:
      completedAt - the completed at
      Returns:
      the GH check run builder

    • withCompletedAt

      @NonNull public GHCheckRunBuilder withCompletedAt(@CheckForNull Instant completedAt)
      With completed at.
      Parameters:
      completedAt - the completed at
      Returns:
      the GH check run builder

    • withConclusion

      @NonNull public GHCheckRunBuilder withConclusion(@CheckForNull GHCheckRun.Conclusion conclusion)
      With conclusion.
      Parameters:
      conclusion - the conclusion
      Returns:
      the GH check run builder

    • withDetailsURL

      @NonNull public GHCheckRunBuilder withDetailsURL(@CheckForNull String detailsURL)
      With details URL.
      Parameters:
      detailsURL - the details URL
      Returns:
      the GH check run builder

    • withExternalID

      @NonNull public GHCheckRunBuilder withExternalID(@CheckForNull String externalID)
      With external ID.
      Parameters:
      externalID - the external ID
      Returns:
      the GH check run builder

    • withName

      @NonNull public GHCheckRunBuilder withName(@CheckForNull String name, String oldName)
      With name.
      Parameters:
      name - the name
      oldName - the old name
      Returns:
      the GH check run builder

    • withStartedAt

      @Deprecated @NonNull public GHCheckRunBuilder withStartedAt(@CheckForNull Date startedAt)
      Deprecated.
      Use withStartedAt(Instant)
      With started at.
      Parameters:
      startedAt - the started at
      Returns:
      the GH check run builder

    • withStartedAt

      @NonNull public GHCheckRunBuilder withStartedAt(@CheckForNull Instant startedAt)
      With started at.
      Parameters:
      startedAt - the started at
      Returns:
      the GH check run builder

    • withStatus

      @NonNull public GHCheckRunBuilder withStatus(@CheckForNull GHCheckRun.Status status)
      With status.
      Parameters:
      status - the status
      Returns:
      the GH check run builder