Interface CheckRunAction

  • All Known Implementing Classes:
    ImmutableCheckRunAction

    @Immutable
    public interface CheckRunAction
    The CheckRun action.
    See Also:
    "https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions"
    • Method Detail

      • label

        String label()
        The label to be shown at the action button.
        Returns:
        the string
      • identifier

        String identifier()
        The identifier to be sent at the event When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. When your app receives a check_run.requested_action webhook event, it can look for the requested_action.identifier key in the webhook payload to determine which button was clicked and perform the requested task.
        Returns:
        the string
      • description

        String description()
        Description string.
        Returns:
        the string
      • check

        @Check
        default void check()
        Automatically validates the maximum length of properties. GitHub does not validate these properly on their side (at least in GHE 3.2) and returns 5xx HTTP responses instead. To avoid that, let's validate the data in this client library.