Package com.spotify.github.v3.clients

Class ChecksClient

  • public class ChecksClient
extends java.lang.Object
    Checks API client

    • Method Detail

      • createCheckRun

        public java.util.concurrent.CompletableFuture<CheckRunResponse> createCheckRun​(CheckRunRequest checkRun)
        Create a checkRun.
        Parameters:
        checkRun - the checkRunRequest payload to be created
        Returns:
        the CheckRunResponse

      • updateCheckRun

        public java.util.concurrent.CompletableFuture<CheckRunResponse> updateCheckRun​(int id,
                                                                               CheckRunRequest checkRun)
        Updates a checkRun.
        Parameters:
        id - the checkRun id
        checkRun - the checkRun payload
        Returns:
        the completable future

      • getCheckRun

        public java.util.concurrent.CompletableFuture<CheckRunResponse> getCheckRun​(int id)
        Gets a checkRun by id.
        Parameters:
        id - the checkRun id
        Returns:
        a CheckRunResponse

      • getCheckRuns

        public java.util.concurrent.CompletableFuture<CheckRunResponseList> getCheckRuns​(java.lang.String ref)
        List checkRuns for a given ref.
        Parameters:
        ref - the ref
        Returns:
        a list of CheckRun

      • getCheckSuite

        public java.util.concurrent.CompletableFuture<CheckSuite> getCheckSuite​(java.lang.String id)
        Gets a checkRun by id.
        Parameters:
        id - the checkSuite id
        Returns:
        a CheckSuite

      • getCheckSuites

        public java.util.concurrent.CompletableFuture<CheckSuiteResponseList> getCheckSuites​(java.lang.String sha)
        List checkSuites for a given ref.
        Parameters:
        sha - the sha
        Returns:
        a list of CheckSuite